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::Schema> - Freeside database schema
26 L<FS::Setup> - Setup subroutines
28 L<FS::Upgrade> - Upgrade subroutines
30 L<FS::Conf> - Freeside configuration values
32 L<FS::ConfItem> - Freeside configuration option meta-data.
34 L<FS::ConfDefaults> - Freeside configuration default and available values
36 L<FS::UID> - User class (not yet OO)
38 L<FS::CurrentUser> - Package representing the current user
40 L<FS::CGI> - Non OO-subroutines for the web interface.
42 L<FS::Msgcat> - Message catalog
44 L<FS::SearchCache> - Search cache
46 L<FS::AccessRight> - Access control rights.
48 L<FS::Report> - Report data objects
50 L<FS::Report::Table> - Report data objects
52 L<FS::Report::Table::Monthly> - Report data objects
54 L<FS::XMLRPC> - Backend XML::RPC server
56 L<FS::Misc> - Miscellaneous subroutines
58 L<FS::payby> - Payment types
60 L<FS::ClientAPI_SessionCache> - ClientAPI session cache
64 L<FS::cust_main::Import> - Batch customer importing
66 =head2 Database record classes
68 L<FS::Record> - Database record base class
70 L<FS::m2m_Common> - Mixin class for classes in a many-to-many relationship
72 L<FS::m2name_Common> - Base class for tables with a related table listing names
74 L<FS::option_Common> - Base class for option sub-classes
76 L<FS::conf> - Configuration value class
78 L<FS::payinfo_Mixin> - Mixin class for records in tables that contain payinfo.
80 L<FS::access_user> - Employees / internal users
82 L<FS::access_user_pref> - Employee preferences
84 L<FS::access_group> - Employee groups
86 L<FS::access_usergroup> - Employee group membership
88 L<FS::access_groupagent> - Group reseller access
90 L<FS::access_right> - Access rights
92 L<FS::svc_acct_pop> - POP (Point of Presence, not Post
93 Office Protocol) class
95 L<FS::part_pop_local> - Local calling area class
97 L<FS::part_referral> - Referral class
99 L<FS::pkg_referral> - Package referral class
101 L<FS::cust_main_county> - Locale (tax rate) class
103 L<FS::cust_tax_exempt> - Tax exemption record class
105 L<FS::cust_tax_adjustment> - Tax adjustment record class
107 L<FS::cust_tax_exempt_pkg> - Line-item specific tax exemption record class
109 L<FS::svc_Common> - Service base class
111 L<FS::svc_Parent_Mixin> - Mixin class for svc_ classes with a parent_svcnum field
113 L<FS::svc_acct> - Account (shell, RADIUS, POP3) class
115 L<FS::acct_snarf> - External mail account class
117 L<FS::acct_rt_transaction> - Time worked application to account class
119 L<FS::radius_usergroup> - RADIUS groups
121 L<FS::svc_domain> - Domain class
123 L<FS::domain_record> - DNS zone entries
125 L<FS::registrar> - Domain registrar class
127 L<FS::svc_forward> - Mail forwarding class
129 L<FS::svc_www> - Web virtual host class.
131 L<FS::svc_broadband> - DSL, wireless and other broadband class.
133 L<FS::addr_block> - Address block class
135 L<FS::router> - Router class
137 L<FS::part_virtual_field> - Broadband virtual field class
139 L<FS::svc_phone> - Phone service class
141 L<FS::phone_device> - Phone device class
143 L<FS::part_device> - Device definition class
145 L<FS::phone_avail> - Phone number availability cache
147 L<FS::cdr> - Call Detail Record class
149 L<FS::cdr_batch> - Call Detail Record batch class
151 L<FS::cdr_calltype> - CDR calltype class
153 L<FS::cdr_carrier> - CDR carrier class
155 L<FS::cdr_type> - CDR type class
157 L<FS::svc_external> - Externally tracked service class.
159 L<FS::inventory_class> - Inventory classes
161 L<FS::inventory_item> - Inventory items
163 L<FS::part_svc> - Service definition class
165 L<FS::part_svc_column> - Column constraint class
167 L<FS::export_svc> - Class linking service definitions (see L<FS::part_svc>)
168 with exports (see L<FS::part_export>)
170 L<FS::part_export> - External provisioning export class
172 L<FS::part_export_option> - Export option class
174 L<FS::pkg_category> - Package category class (invoice oriented)
176 L<FS::pkg_class> - Package class class
178 L<FS::part_pkg> - Package definition class
180 L<FS::part_pkg_link> - Package definition link class
182 L<FS::part_pkg_taxclass> - Tax class class
184 L<FS::part_pkg_option> - Package definition option class
186 L<FS::part_pkg_report_option> - Package reporting classification class
188 L<FS::pkg_svc> - Class linking package definitions (see L<FS::part_pkg>) with
189 service definitions (see L<FS::part_svc>)
191 L<FS::reg_code> - One-time registration codes
193 L<FS::reg_code_pkg> - Class linking registration codes (see L<FS::reg_code>) with package definitions (see L<FS::part_pkg>)
195 L<FS::rate> - Rate plans for call billing
197 L<FS::rate_region> - Rate regions for call billing
199 L<FS::rate_prefix> - Rate region prefixes for call billing
201 L<FS::rate_detail> - Rate plan detail for call billing
203 L<FS::usage_class> - Usage class class
205 L<FS::agent> - Agent (reseller) class
207 L<FS::agent_type> - Agent type class
209 L<FS::type_pkgs> - Class linking agent types (see L<FS::agent_type>) with package definitions (see L<FS::part_pkg>)
211 L<FS::payment_gateway> - Payment gateway class
213 L<FS::payment_gateway_option> - Payment gateway option class
215 L<FS::agent_payment_gateway> - Agent payment gateway class
217 L<FS::cust_svc> - Service class
219 L<FS::cust_pkg> - Customer package class
221 L<FS::cust_pkg_option> - Customer package option class
223 L<FS::cust_pkg_detail> - Customer package details class
225 L<FS::reason_type> - Reason type class
227 L<FS::reason> - Reason class
229 L<FS::cust_pkg_reason> - Package reason class
231 L<FS::cust_main> - Customer class
233 L<FS::cust_main_location> - Customer location class
235 L<FS::cust_main_Mixin> - Mixin class for records that contain fields from cust_main
237 L<FS::cust_main_invoice> - Invoice destination class
239 L<FS::cust_main_exemption> - Customer tax exemption class
241 L<FS::cust_main_note> - Customer note class
243 L<FS::banned_pay> - Banned payment information class
245 L<FS::cust_bill> - Invoice class
247 L<FS::cust_statement> - Informational statement class
249 L<FS::cust_bill_pkg> - Invoice line item class
251 L<FS::cust_bill_pkg_detail> - Invoice line item detail class
253 L<FS::part_bill_event> - (Old) Invoice event definition class
255 L<FS::cust_bill_event> - (Old) Completed invoice event class
257 L<FS::part_event> - (New) Billing event definition class
259 L<FS::part_event_option> - (New) Billing event option class
261 L<FS::part_event::Condition> - (New) Billing event condition base class
263 L<FS::part_event::Action> - (New) Billing event action base class
265 L<FS::part_event_condition> - (New) Billing event condition class
267 L<FS::part_event_condition_option> - (New) Billing event condition option class
269 L<FS::part_event_condition_option_option> - (New) Billing event condition compound option class
271 L<FS::cust_event> - (New) Customer event class
273 L<FS::cust_bill_ApplicationCommon> - Base class for bill application classes
275 L<FS::cust_pay> - Payment class
277 L<FS::cust_pay_pending> - Pending payment class
279 L<FS::cust_pay_void> - Voided payment class
281 L<FS::cust_bill_pay> - Payment application class
283 L<FS::cust_bill_pay_pkg> - Line-item specific payment application class
285 L<FS::cust_bill_pay_batch> - Batch payment application class
287 L<FS::cust_credit> - Credit class
289 L<FS::cust_refund> - Refund class
291 L<FS::cust_credit_refund> - Refund application to credit class
293 L<FS::cust_credit_bill> - Credit application to invoice class
295 L<FS::cust_credit_bill_pkg> - Line-item specific credit application to invoice class
297 L<FS::cust_pay_refund> - Refund application to payment class
299 L<FS::pay_batch> - Credit card transaction queue class
301 L<FS::cust_pay_batch> - Credit card transaction member queue class
303 L<FS::prepay_credit> - Prepaid "calling card" credit class.
305 L<FS::nas> - Network Access Server class
307 L<FS::port> - NAS port class
309 L<FS::session> - User login session class
311 L<FS::queue> - Job queue
313 L<FS::queue_arg> - Job arguments
315 L<FS::queue_depend> - Job dependencies
317 L<FS::msgcat> - Message catalogs
319 L<FS::clientapi_session>
321 L<FS::clientapi_session_field>
323 =head2 Historical database record classes
325 L<FS::h_Common> - History table base class
327 L<FS::h_cust_pay> - Historical record of customer payment changes
329 L<FS::h_cust_credit> - Historical record of customer credit changes
331 L<FS::h_cust_bill> - Historical record of customer tax changes (old-style)
333 L<FS::h_cust_svc> - Object method for h_cust_svc objects
335 L<FS::h_cust_tax_exempt> - Historical record of customer tax changes (old-style)
337 L<FS::h_domain_record> - Historical DNS entry objects
339 L<FS::h_svc_acct> - Historical account objects
341 L<FS::h_svc_broadband> - Historical broadband connection objects
343 L<FS::h_svc_domain> - Historical domain objects
345 L<FS::h_svc_external> - Historical externally tracked service objects
347 L<FS::h_svc_forward> - Historical mail forwarding alias objects
349 L<FS::h_svc_phone> - Historical phone number objects
351 L<FS::h_svc_pbx> - Historical PBX objects
353 L<FS::h_svc_www> - Historical web virtual host objects
355 =head2 Remote API modules
357 L<FS::SelfService> - Self-service API
359 L<FS::SelfService::XMLRPC> - Self-service XML-RPC API
361 =head2 User Interface classes
363 L<FS::UI::Web> - Web user-interface class
365 L<FS::UI::bytecount> - Byte counter user-interface class
367 =head2 Command-line utilities
369 L<freeside-adduser> - Command line interface to add (freeside) users.
371 L<freeside-daily> - Run daily billing and collection events.
373 L<freeside-monthly> - Run monthly billing and invoice collection events.
375 L<freeside-dbdef-create> - Recreate database schema cache
377 L<freeside-deluser> - Command line interface to delete (freeside) users.
379 L<freeside-expiration-alerter> - Emails notifications of credit card expirations.
381 L<freeside-email> - Prints email addresses of all users on STDOUT
383 L<freeside-fetch> - Send a freeside page to a list of employees.
385 L<freeside-prepaidd> - Real-time daemon for prepaid packages
387 L<freeside-prune-applications> - Removes stray applications of credit, payment to bills, refunds, etc.
389 L<freeside-queued> - Job queue daemon
391 L<freeside-radgroup> - Command line utility to manipulate radius groups
393 L<freeside-reexport> - Command line tool to re-trigger export jobs for existing services
395 L<freeside-reset-fixed> - Command line tool to set the fixed columns for existing services
397 L<freeside-sqlradius-dedup-group> - Command line tool to eliminate duplicate usergroup entries from radius tables
399 L<freeside-sqlradius-radacctd> - Real-time radacct import daemon
401 L<freeside-sqlradius-reset> - Command line interface to reset and recreate RADIUS SQL tables
403 L<freeside-sqlradius-seconds> - Command line time-online tool
405 L<freeside-upgrade> - Upgrades database schema for new freeside verisons.
409 To quote perl(1), "If you're intending to read these straight through for the
410 first time, the suggested order will tend to reduce the number of forward
413 If you've never used OO modules before,
414 http://www.perl.com/doc/FMTEYEWTK/easy_objects.html might help you out.
418 Freeside is a billing and administration package for wired and wireless ISPs,
419 VoIP, hosting, service and content providers and other online businesses.
421 The Freeside home page is at <http://www.sisd.com/freeside>.
423 The main documentation is at <http://www.sisd.com/mediawiki>.
427 A mailing list for users is available. Send a blank message to
428 <freeside-users-subscribe@sisd.com> to subscribe.
430 A mailing list for developers is available. It is intended to be lower volume
431 and higher SNR than the users list. Send a blank message to
432 <freeside-devel-subscribe@sisd.com> to subscribe.
434 Commercial support is available; see
435 <http://www.sisd.com/freeside/commercial.html>.
439 Primarily Ivan Kohler, with help from many kind folks, including core
440 contributors Jeff Finucane, Kristian Hoffman, Jason Hall and Peter Bowen.
442 See the CREDITS file in the Freeside distribution for a (hopefully) complete
443 list and the individal files for details.
447 perl(1), main Freeside documentation at <http://www.sisd.com/mediawiki/>
451 Those modules which would be useful separately should be pulled out,
452 renamed appropriately and uploaded to CPAN. So far: DBIx::DBSchema, Net::SSH