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::Search> - Customer searching
66 L<FS::cust_main::Import> - Batch customer importing
68 =head2 Database record classes
70 L<FS::Record> - Database record base class
72 L<FS::m2m_Common> - Mixin class for classes in a many-to-many relationship
74 L<FS::m2name_Common> - Base class for tables with a related table listing names
76 L<FS::option_Common> - Base class for option sub-classes
78 L<FS::class_Common> - Base class for classification classes
80 L<FS::category_Common> - Base class for category (grooups of classifications) classes
82 L<FS::conf> - Configuration value class
84 L<FS::payinfo_Mixin> - Mixin class for records in tables that contain payinfo.
86 L<FS::access_user> - Employees / internal users
88 L<FS::access_user_pref> - Employee preferences
90 L<FS::access_group> - Employee groups
92 L<FS::access_usergroup> - Employee group membership
94 L<FS::access_groupagent> - Group reseller access
96 L<FS::access_right> - Access rights
98 L<FS::svc_acct_pop> - POP (Point of Presence, not Post
99 Office Protocol) class
101 L<FS::part_pop_local> - Local calling area class
103 L<FS::part_referral> - Referral class
105 L<FS::pkg_referral> - Package referral class
107 L<FS::cust_main_county> - Locale (tax rate) class
109 L<FS::cust_tax_exempt> - Tax exemption record class
111 L<FS::cust_tax_adjustment> - Tax adjustment record class
113 L<FS::cust_tax_exempt_pkg> - Line-item specific tax exemption record class
115 L<FS::svc_Common> - Service base class
117 L<FS::svc_Parent_Mixin> - Mixin class for svc_ classes with a parent_svcnum field
119 L<FS::svc_acct> - Account (shell, RADIUS, POP3) class
121 L<FS::acct_snarf> - External mail account class
123 L<FS::acct_rt_transaction> - Time worked application to account class
125 L<FS::radius_usergroup> - RADIUS groups
127 L<FS::svc_domain> - Domain class
129 L<FS::domain_record> - DNS zone entries
131 L<FS::registrar> - Domain registrar class
133 L<FS::cgp_rule> - Communigate pro rule class
135 L<FS::cgp_rule_condition> - Communigate pro rule condition class
137 L<FS::cgp_rule_action> - Communigate pro rule action class
139 L<FS::svc_forward> - Mail forwarding class
141 L<FS::svc_mailinglist> - (Customer) Mailing list class
143 L<FS::mailinglist> - Mailing list class
145 L<FS::mailinglistmember> - Mailing list member class
147 L<FS::svc_www> - Web virtual host class.
149 L<FS::svc_broadband> - DSL, wireless and other broadband class.
151 L<FS::addr_block> - Address block class
153 L<FS::router> - Router class
155 L<FS::part_virtual_field> - Broadband virtual field class
157 L<FS::svc_phone> - Phone service class
159 L<FS::phone_device> - Phone device class
161 L<FS::part_device> - Device definition class
163 L<FS::phone_avail> - Phone number availability cache
165 L<FS::lata> - LATA number to name mapping class
167 L<FS::did_vendor> - Bulk DID order vendor class
169 L<FS::did_order> - Bulk DID order class
171 L<FS::did_order_item> - Bulk DID order item class
173 L<FS::cdr> - Call Detail Record class
175 L<FS::cdr_batch> - Call Detail Record batch class
177 L<FS::cdr_calltype> - CDR calltype class
179 L<FS::cdr_carrier> - CDR carrier class
181 L<FS::cdr_type> - CDR type class
183 L<FS::svc_external> - Externally tracked service class.
185 L<FS::svc_pbx> - PBX service class
187 L<FS::svc_cert> - Certificate service class
189 L<FS::inventory_class> - Inventory classes
191 L<FS::inventory_item> - Inventory items
193 L<FS::part_svc> - Service definition class
195 L<FS::part_svc_column> - Column constraint class
197 L<FS::export_svc> - Class linking service definitions (see L<FS::part_svc>)
198 with exports (see L<FS::part_export>)
200 L<FS::part_export> - External provisioning export class
202 L<FS::part_export_option> - Export option class
204 L<FS::pkg_category> - Package category class (invoice oriented)
206 L<FS::pkg_class> - Package class class
208 L<FS::part_pkg> - Package definition class
210 L<FS::part_pkg_link> - Package definition link class
212 L<FS::part_pkg_taxclass> - Tax class class
214 L<FS::part_pkg_option> - Package definition option class
216 L<FS::part_pkg_report_option> - Package reporting classification class
218 L<FS::pkg_svc> - Class linking package definitions (see L<FS::part_pkg>) with
219 service definitions (see L<FS::part_svc>)
221 L<FS::reg_code> - One-time registration codes
223 L<FS::reg_code_pkg> - Class linking registration codes (see L<FS::reg_code>) with package definitions (see L<FS::part_pkg>)
225 L<FS::rate> - Rate plans for call billing
227 L<FS::rate_region> - Rate regions for call billing
229 L<FS::rate_prefix> - Rate region prefixes for call billing
231 L<FS::rate_detail> - Rate plan detail for call billing
233 L<FS::usage_class> - Usage class class
235 L<FS::agent> - Agent (reseller) class
237 L<FS::agent_type> - Agent type class
239 L<FS::type_pkgs> - Class linking agent types (see L<FS::agent_type>) with package definitions (see L<FS::part_pkg>)
241 L<FS::payment_gateway> - Payment gateway class
243 L<FS::payment_gateway_option> - Payment gateway option class
245 L<FS::agent_payment_gateway> - Agent payment gateway class
247 L<FS::cust_svc> - Service class
249 L<FS::cust_pkg> - Customer package class
251 L<FS::cust_pkg_option> - Customer package option class
253 L<FS::cust_pkg_detail> - Customer package details class
255 L<FS:;cust_pkg_discount> - Customer package discount class
257 L<FS:;cust_bill_pkg_discount> - Customer package discount line item application class
259 L<FS:;discount> - Discount class
261 L<FS::reason_type> - Reason type class
263 L<FS::reason> - Reason class
265 L<FS::cust_pkg_reason> - Package reason class
267 L<FS::contact> - Contact class
269 L<FS::contact_phone> - Contact phone class
271 L<FS::phone_type> - Phone type class
273 L<FS::contact_email> - Contact email class
275 L<FS::prospect_main> - Prospect class
277 L<FS::cust_main> - Customer class
279 L<FS::cust_main::Billing> - Customer billing class
281 L<FS::cust_main::Billing_Realtime> - Customer real-time billing class
283 L<FS::cust_main::Packages> - Customer packages class
285 L<FS::cust_location> - Customer location class
287 L<FS::cust_main_Mixin> - Mixin class for records that contain fields from cust_main
289 L<FS::cust_main_invoice> - Invoice destination class
291 L<FS::cust_class> - Customer classification class
293 L<FS::cust_category> - Customer category class
295 L<FS::cust_tag> - Customer tag class
297 L<FS::part_tag> - Tag definition class
299 L<FS::cust_main_exemption> - Customer tax exemption class
301 L<FS::cust_main_note> - Customer note class
303 L<FS::cust_note_class> - Customer note classification class
305 L<FS::banned_pay> - Banned payment information class
307 L<FS::cust_bill> - Invoice class
309 L<FS::cust_statement> - Informational statement class
311 L<FS::cust_bill_pkg> - Invoice line item class
313 L<FS::cust_bill_pkg_detail> - Invoice line item detail class
315 L<FS::part_bill_event> - (Old) Invoice event definition class
317 L<FS::cust_bill_event> - (Old) Completed invoice event class
319 L<FS::part_event> - (New) Billing event definition class
321 L<FS::part_event_option> - (New) Billing event option class
323 L<FS::part_event::Condition> - (New) Billing event condition base class
325 L<FS::part_event::Action> - (New) Billing event action base class
327 L<FS::part_event_condition> - (New) Billing event condition class
329 L<FS::part_event_condition_option> - (New) Billing event condition option class
331 L<FS::part_event_condition_option_option> - (New) Billing event condition compound option class
333 L<FS::cust_event> - (New) Customer event class
335 L<FS::cust_bill_ApplicationCommon> - Base class for bill application classes
337 L<FS::cust_pay> - Payment class
339 L<FS::cust_pay_pending> - Pending payment class
341 L<FS::cust_pay_void> - Voided payment class
343 L<FS::cust_bill_pay> - Payment application class
345 L<FS::cust_bill_pay_pkg> - Line-item specific payment application class
347 L<FS::cust_bill_pay_batch> - Batch payment application class
349 L<FS::cust_credit> - Credit class
351 L<FS::cust_refund> - Refund class
353 L<FS::cust_credit_refund> - Refund application to credit class
355 L<FS::cust_credit_bill> - Credit application to invoice class
357 L<FS::cust_credit_bill_pkg> - Line-item specific credit application to invoice class
359 L<FS::cust_pay_refund> - Refund application to payment class
361 L<FS::pay_batch> - Credit card transaction queue class
363 L<FS::cust_pay_batch> - Credit card transaction member queue class
365 L<FS::prepay_credit> - Prepaid "calling card" credit class.
367 L<FS::nas> - Network Access Server class
369 L<FS::port> - NAS port class
371 L<FS::session> - User login session class
373 L<FS::queue> - Job queue
375 L<FS::queue_arg> - Job arguments
377 L<FS::queue_depend> - Job dependencies
379 L<FS::msg_template> - Message templates (customer notices)
381 L<FS::msgcat> - Message catalogs (error messages)
383 L<FS::clientapi_session>
385 L<FS::clientapi_session_field>
387 =head2 Historical database record classes
389 L<FS::h_Common> - History table base class
391 L<FS::h_cust_pay> - Historical record of customer payment changes
393 L<FS::h_cust_credit> - Historical record of customer credit changes
395 L<FS::h_cust_bill> - Historical record of customer tax changes (old-style)
397 L<FS::h_cust_svc> - Object method for h_cust_svc objects
399 L<FS::h_cust_tax_exempt> - Historical record of customer tax changes (old-style)
401 L<FS::h_domain_record> - Historical DNS entry objects
403 L<FS::h_svc_acct> - Historical account objects
405 L<FS::h_svc_broadband> - Historical broadband connection objects
407 L<FS::h_svc_domain> - Historical domain objects
409 L<FS::h_svc_external> - Historical externally tracked service objects
411 L<FS::h_svc_forward> - Historical mail forwarding alias objects
413 L<FS::h_svc_mailinglist> - Historical mailing list objects
415 L<FS::h_svc_phone> - Historical phone number objects
417 L<FS::h_svc_pbx> - Historical PBX objects
419 L<FS::h_svc_www> - Historical web virtual host objects
421 =head2 Remote API modules
423 L<FS::SelfService> - Self-service API
425 L<FS::SelfService::XMLRPC> - Self-service XML-RPC API
427 =head2 User Interface classes
429 L<FS::UI::Web> - Web user-interface class
431 L<FS::UI::bytecount> - Byte counter user-interface class
433 =head2 Command-line utilities
435 L<freeside-adduser> - Command line interface to add (freeside) users.
437 L<freeside-daily> - Run daily billing and collection events.
439 L<freeside-monthly> - Run monthly billing and invoice collection events.
441 L<freeside-dbdef-create> - Recreate database schema cache
443 L<freeside-deluser> - Command line interface to delete (freeside) users.
445 L<freeside-expiration-alerter> - Emails notifications of credit card expirations.
447 L<freeside-email> - Prints email addresses of all users on STDOUT
449 L<freeside-fetch> - Send a freeside page to a list of employees.
451 L<freeside-prepaidd> - Real-time daemon for prepaid packages
453 L<freeside-prune-applications> - Removes stray applications of credit, payment to bills, refunds, etc.
455 L<freeside-queued> - Job queue daemon
457 L<freeside-radgroup> - Command line utility to manipulate radius groups
459 L<freeside-reexport> - Command line tool to re-trigger export jobs for existing services
461 L<freeside-reset-fixed> - Command line tool to set the fixed columns for existing services
463 L<freeside-sqlradius-dedup-group> - Command line tool to eliminate duplicate usergroup entries from radius tables
465 L<freeside-sqlradius-radacctd> - Real-time radacct import daemon
467 L<freeside-sqlradius-reset> - Command line interface to reset and recreate RADIUS SQL tables
469 L<freeside-sqlradius-seconds> - Command line time-online tool
471 L<freeside-upgrade> - Upgrades database schema for new freeside verisons.
475 To quote perl(1), "If you're intending to read these straight through for the
476 first time, the suggested order will tend to reduce the number of forward
479 If you've never used OO modules before,
480 http://www.perl.com/doc/FMTEYEWTK/easy_objects.html might help you out.
484 Freeside is a billing and administration package for wired and wireless ISPs,
485 VoIP, hosting, service and content providers and other online businesses.
487 The Freeside home page is at <http://www.sisd.com/freeside>.
489 The main documentation is at <http://www.sisd.com/mediawiki>.
493 A mailing list for users is available. Send a blank message to
494 <freeside-users-subscribe@sisd.com> to subscribe.
496 A mailing list for developers is available. It is intended to be lower volume
497 and higher SNR than the users list. Send a blank message to
498 <freeside-devel-subscribe@sisd.com> to subscribe.
500 Commercial support is available; see
501 <http://www.sisd.com/freeside/commercial.html>.
505 Primarily Ivan Kohler, with help from many kind folks, including core
506 contributors Jeff Finucane, Kristian Hoffman, Jason Hall and Peter Bowen.
508 See the CREDITS file in the Freeside distribution for a (hopefully) complete
509 list and the individal files for details.
513 perl(1), main Freeside documentation at <http://www.sisd.com/mediawiki/>
517 Those modules which would be useful separately should be pulled out,
518 renamed appropriately and uploaded to CPAN. So far: DBIx::DBSchema, Net::SSH