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.
153 L<FS::addr_block> - Address block class
155 L<FS::router> - Router class
157 L<FS::part_virtual_field> - Broadband virtual field class
159 L<FS::svc_phone> - Phone service class
161 L<FS::phone_device> - Phone device class
163 L<FS::part_device> - Device definition class
165 L<FS::phone_avail> - Phone number availability cache
167 L<FS::cdr> - Call Detail Record class
169 L<FS::cdr_batch> - Call Detail Record batch class
171 L<FS::cdr_calltype> - CDR calltype class
173 L<FS::cdr_carrier> - CDR carrier class
175 L<FS::cdr_type> - CDR type class
177 L<FS::svc_external> - Externally tracked service class.
179 L<FS::svc_pbx> - PBX service class
181 L<FS::svc_cert> - Certificate service class
183 L<FS::inventory_class> - Inventory classes
185 L<FS::inventory_item> - Inventory items
187 L<FS::part_svc> - Service definition class
189 L<FS::part_svc_column> - Column constraint class
191 L<FS::export_svc> - Class linking service definitions (see L<FS::part_svc>)
192 with exports (see L<FS::part_export>)
194 L<FS::part_export> - External provisioning export class
196 L<FS::part_export_option> - Export option class
198 L<FS::pkg_category> - Package category class (invoice oriented)
200 L<FS::pkg_class> - Package class class
202 L<FS::part_pkg> - Package definition class
204 L<FS::part_pkg_link> - Package definition link class
206 L<FS::part_pkg_taxclass> - Tax class class
208 L<FS::part_pkg_option> - Package definition option class
210 L<FS::part_pkg_report_option> - Package reporting classification class
212 L<FS::pkg_svc> - Class linking package definitions (see L<FS::part_pkg>) with
213 service definitions (see L<FS::part_svc>)
215 L<FS::qual> - Service qualification class
217 L<FS::qual_option> - Qualification option class
219 L<FS::reg_code> - One-time registration codes
221 L<FS::reg_code_pkg> - Class linking registration codes (see L<FS::reg_code>) with package definitions (see L<FS::part_pkg>)
223 L<FS::rate> - Rate plans for call billing
225 L<FS::rate_region> - Rate regions for call billing
227 L<FS::rate_prefix> - Rate region prefixes for call billing
229 L<FS::rate_detail> - Rate plan detail for call billing
231 L<FS::usage_class> - Usage class class
233 L<FS::agent> - Agent (reseller) class
235 L<FS::agent_type> - Agent type class
237 L<FS::type_pkgs> - Class linking agent types (see L<FS::agent_type>) with package definitions (see L<FS::part_pkg>)
239 L<FS::payment_gateway> - Payment gateway class
241 L<FS::payment_gateway_option> - Payment gateway option class
243 L<FS::agent_payment_gateway> - Agent payment gateway class
245 L<FS::cust_svc> - Service class
247 L<FS::cust_pkg> - Customer package class
249 L<FS::cust_pkg_option> - Customer package option class
251 L<FS::cust_pkg_detail> - Customer package details class
253 L<FS:;cust_pkg_discount> - Customer package discount class
255 L<FS:;cust_bill_pkg_discount> - Customer package discount line item application class
257 L<FS:;discount> - Discount class
259 L<FS::reason_type> - Reason type class
261 L<FS::reason> - Reason class
263 L<FS::cust_pkg_reason> - Package reason class
265 L<FS::contact> - Contact class
267 L<FS::contact_phone> - Contact phone class
269 L<FS::phone_type> - Phone type class
271 L<FS::contact_email> - Contact email class
273 L<FS::prospect_main> - Prospect class
275 L<FS::cust_main> - Customer class
277 L<FS::cust_main::Billing> - Customer billing class
279 L<FS::cust_main::Billing_Realtime> - Customer real-time billing class
281 L<FS::cust_main::Packages> - Customer packages class
283 L<FS::cust_location> - Customer location class
285 L<FS::cust_main_Mixin> - Mixin class for records that contain fields from cust_main
287 L<FS::cust_main_invoice> - Invoice destination class
289 L<FS::cust_class> - Customer classification class
291 L<FS::cust_category> - Customer category class
293 L<FS::cust_tag> - Customer tag class
295 L<FS::part_tag> - Tag definition class
297 L<FS::cust_main_exemption> - Customer tax exemption class
299 L<FS::cust_main_note> - Customer note class
301 L<FS::banned_pay> - Banned payment information class
303 L<FS::cust_bill> - Invoice class
305 L<FS::cust_statement> - Informational statement class
307 L<FS::cust_bill_pkg> - Invoice line item class
309 L<FS::cust_bill_pkg_detail> - Invoice line item detail class
311 L<FS::part_bill_event> - (Old) Invoice event definition class
313 L<FS::cust_bill_event> - (Old) Completed invoice event class
315 L<FS::part_event> - (New) Billing event definition class
317 L<FS::part_event_option> - (New) Billing event option class
319 L<FS::part_event::Condition> - (New) Billing event condition base class
321 L<FS::part_event::Action> - (New) Billing event action base class
323 L<FS::part_event_condition> - (New) Billing event condition class
325 L<FS::part_event_condition_option> - (New) Billing event condition option class
327 L<FS::part_event_condition_option_option> - (New) Billing event condition compound option class
329 L<FS::cust_event> - (New) Customer event class
331 L<FS::cust_bill_ApplicationCommon> - Base class for bill application classes
333 L<FS::cust_pay> - Payment class
335 L<FS::cust_pay_pending> - Pending payment class
337 L<FS::cust_pay_void> - Voided payment class
339 L<FS::cust_bill_pay> - Payment application class
341 L<FS::cust_bill_pay_pkg> - Line-item specific payment application class
343 L<FS::cust_bill_pay_batch> - Batch payment application class
345 L<FS::cust_credit> - Credit class
347 L<FS::cust_refund> - Refund class
349 L<FS::cust_credit_refund> - Refund application to credit class
351 L<FS::cust_credit_bill> - Credit application to invoice class
353 L<FS::cust_credit_bill_pkg> - Line-item specific credit application to invoice class
355 L<FS::cust_pay_refund> - Refund application to payment class
357 L<FS::pay_batch> - Credit card transaction queue class
359 L<FS::cust_pay_batch> - Credit card transaction member queue class
361 L<FS::prepay_credit> - Prepaid "calling card" credit class.
363 L<FS::nas> - Network Access Server class
365 L<FS::port> - NAS port class
367 L<FS::session> - User login session class
369 L<FS::queue> - Job queue
371 L<FS::queue_arg> - Job arguments
373 L<FS::queue_depend> - Job dependencies
375 L<FS::msg_template> - Message templates (customer notices)
377 L<FS::msgcat> - Message catalogs (error messages)
379 L<FS::clientapi_session>
381 L<FS::clientapi_session_field>
383 =head2 Historical database record classes
385 L<FS::h_Common> - History table base class
387 L<FS::h_cust_pay> - Historical record of customer payment changes
389 L<FS::h_cust_credit> - Historical record of customer credit changes
391 L<FS::h_cust_bill> - Historical record of customer tax changes (old-style)
393 L<FS::h_cust_svc> - Object method for h_cust_svc objects
395 L<FS::h_cust_tax_exempt> - Historical record of customer tax changes (old-style)
397 L<FS::h_domain_record> - Historical DNS entry objects
399 L<FS::h_svc_acct> - Historical account objects
401 L<FS::h_svc_broadband> - Historical broadband connection objects
403 L<FS::h_svc_domain> - Historical domain objects
405 L<FS::h_svc_external> - Historical externally tracked service objects
407 L<FS::h_svc_forward> - Historical mail forwarding alias objects
409 L<FS::h_svc_mailinglist> - Historical mailing list objects
411 L<FS::h_svc_phone> - Historical phone number objects
413 L<FS::h_svc_pbx> - Historical PBX objects
415 L<FS::h_svc_www> - Historical web virtual host objects
417 =head2 Remote API modules
419 L<FS::SelfService> - Self-service API
421 L<FS::SelfService::XMLRPC> - Self-service XML-RPC API
423 =head2 User Interface classes
425 L<FS::UI::Web> - Web user-interface class
427 L<FS::UI::bytecount> - Byte counter user-interface class
429 =head2 Command-line utilities
431 L<freeside-adduser> - Command line interface to add (freeside) users.
433 L<freeside-daily> - Run daily billing and collection events.
435 L<freeside-monthly> - Run monthly billing and invoice collection events.
437 L<freeside-dbdef-create> - Recreate database schema cache
439 L<freeside-deluser> - Command line interface to delete (freeside) users.
441 L<freeside-expiration-alerter> - Emails notifications of credit card expirations.
443 L<freeside-email> - Prints email addresses of all users on STDOUT
445 L<freeside-fetch> - Send a freeside page to a list of employees.
447 L<freeside-prepaidd> - Real-time daemon for prepaid packages
449 L<freeside-prune-applications> - Removes stray applications of credit, payment to bills, refunds, etc.
451 L<freeside-queued> - Job queue daemon
453 L<freeside-radgroup> - Command line utility to manipulate radius groups
455 L<freeside-reexport> - Command line tool to re-trigger export jobs for existing services
457 L<freeside-reset-fixed> - Command line tool to set the fixed columns for existing services
459 L<freeside-sqlradius-dedup-group> - Command line tool to eliminate duplicate usergroup entries from radius tables
461 L<freeside-sqlradius-radacctd> - Real-time radacct import daemon
463 L<freeside-sqlradius-reset> - Command line interface to reset and recreate RADIUS SQL tables
465 L<freeside-sqlradius-seconds> - Command line time-online tool
467 L<freeside-upgrade> - Upgrades database schema for new freeside verisons.
471 To quote perl(1), "If you're intending to read these straight through for the
472 first time, the suggested order will tend to reduce the number of forward
475 If you've never used OO modules before,
476 http://www.perl.com/doc/FMTEYEWTK/easy_objects.html might help you out.
480 Freeside is a billing and administration package for wired and wireless ISPs,
481 VoIP, hosting, service and content providers and other online businesses.
483 The Freeside home page is at <http://www.sisd.com/freeside>.
485 The main documentation is at <http://www.sisd.com/mediawiki>.
489 A mailing list for users is available. Send a blank message to
490 <freeside-users-subscribe@sisd.com> to subscribe.
492 A mailing list for developers is available. It is intended to be lower volume
493 and higher SNR than the users list. Send a blank message to
494 <freeside-devel-subscribe@sisd.com> to subscribe.
496 Commercial support is available; see
497 <http://www.sisd.com/freeside/commercial.html>.
501 Primarily Ivan Kohler, with help from many kind folks, including core
502 contributors Jeff Finucane, Kristian Hoffman, Jason Hall and Peter Bowen.
504 See the CREDITS file in the Freeside distribution for a (hopefully) complete
505 list and the individal files for details.
509 perl(1), main Freeside documentation at <http://www.sisd.com/mediawiki/>
513 Those modules which would be useful separately should be pulled out,
514 renamed appropriately and uploaded to CPAN. So far: DBIx::DBSchema, Net::SSH