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::Locales> - Locales
44 L<FS::Msgcat> - Message catalog
46 L<FS::SearchCache> - Search cache
48 L<FS::AccessRight> - Access control rights.
50 L<FS::Report> - Report data objects
52 L<FS::Report::Table> - Report data objects
54 L<FS::Report::Table::Monthly> - Report data objects
56 L<FS::XMLRPC> - Backend XML::RPC server
58 L<FS::Misc> - Miscellaneous subroutines
60 L<FS::payby> - Payment types
62 L<FS::ClientAPI_SessionCache> - ClientAPI session cache
66 L<FS::cust_main::Search> - Customer searching
68 L<FS::cust_main::Import> - Batch customer importing
70 =head2 Database record classes
72 L<FS::Record> - Database record base class
74 L<FS::m2m_Common> - Mixin class for classes in a many-to-many relationship
76 L<FS::m2name_Common> - Base class for tables with a related table listing names
78 L<FS::option_Common> - Base class for option sub-classes
80 L<FS::class_Common> - Base class for classification classes
82 L<FS::category_Common> - Base class for category (grooups of classifications) classes
84 L<FS::conf> - Configuration value class
86 L<FS::payinfo_Mixin> - Mixin class for records in tables that contain payinfo.
88 L<FS::access_user> - Employees / internal users
90 L<FS::access_user_pref> - Employee preferences
92 L<FS::access_group> - Employee groups
94 L<FS::access_usergroup> - Employee group membership
96 L<FS::access_groupagent> - Group reseller access
98 L<FS::access_right> - Access rights
100 L<FS::svc_acct_pop> - POP (Point of Presence, not Post
101 Office Protocol) class
103 L<FS::part_pop_local> - Local calling area class
105 L<FS::part_referral> - Referral class
107 L<FS::pkg_referral> - Package referral class
109 L<FS::cust_main_county> - Locale (tax rate) class
111 L<FS::cust_tax_exempt> - Tax exemption record class
113 L<FS::cust_tax_adjustment> - Tax adjustment record class
115 L<FS::cust_tax_exempt_pkg> - Line-item specific tax exemption record class
117 L<FS::svc_Common> - Service base class
119 L<FS::svc_Parent_Mixin> - Mixin class for svc_ classes with a parent_svcnum field
121 L<FS::svc_acct> - Account (shell, RADIUS, POP3) class
123 L<FS::acct_snarf> - External mail account class
125 L<FS::acct_rt_transaction> - Time worked application to account class
127 L<FS::radius_usergroup> - RADIUS user group membership
129 L<FS::radius_group> - RADIUS groups
131 L<FS::svc_domain> - Domain class
133 L<FS::domain_record> - DNS zone entries
135 L<FS::registrar> - Domain registrar class
137 L<FS::cgp_rule> - Communigate pro rule class
139 L<FS::cgp_rule_condition> - Communigate pro rule condition class
141 L<FS::cgp_rule_action> - Communigate pro rule action class
143 L<FS::svc_forward> - Mail forwarding class
145 L<FS::svc_mailinglist> - (Customer) Mailing list class
147 L<FS::mailinglist> - Mailing list class
149 L<FS::mailinglistmember> - Mailing list member class
151 L<FS::svc_www> - Web virtual host class.
153 L<FS::svc_broadband> - DSL, wireless and other broadband class.
157 L<FS::dsl_device> - DSL device MAC addresses
159 L<FS::dsl_note> - DSL order notes
161 L<FS::addr_block> - Address block class
163 L<FS::router> - Router class
165 L<FS::tower> - Tower class
167 L<FS::tower_sector> - Tower sector class
169 L<FS::part_virtual_field> - Broadband virtual field class
171 L<FS::svc_phone> - Phone service class
173 L<FS::phone_device> - Phone device class
175 L<FS::part_device> - Device definition class
177 L<FS::phone_avail> - Phone number availability cache
179 L<FS::lata> - LATA number to name mapping class
181 L<FS::msa> - MSA number to name mapping class
183 L<FS::rate_center> - Rate center list (for bulk DID orders)
185 L<FS::did_vendor> - Bulk DID order vendor class
187 L<FS::did_order> - Bulk DID order class
189 L<FS::did_order_item> - Bulk DID order item class
191 L<FS::cdr> - Call Detail Record class
193 L<FS::cdr_batch> - Call Detail Record batch class
195 L<FS::cdr_calltype> - CDR calltype class
197 L<FS::cdr_carrier> - CDR carrier class
199 L<FS::cdr_type> - CDR type class
201 L<FS::svc_external> - Externally tracked service class.
203 L<FS::svc_pbx> - PBX service class
205 L<FS::svc_cert> - Certificate service class
207 L<FS::svc_dish> - Dish network service class
209 L<FS::svc_cable> - Cable service class
211 L<FS::cable_model> - Cable-modem model class
213 L<FS::cable_provider> - Cable provider class
215 L<FS::svc_alarm> - Alarm service class
217 L<FS::alarm_system> - Alarm system class
219 L<FS::alarm_type> - Alarm type (inputs and outputs) class
221 L<FS::alarm_station> - Alarm central station class
223 L<FS::inventory_class> - Inventory classes
225 L<FS::inventory_item> - Inventory items
227 L<FS::part_svc> - Service definition class
229 L<FS::part_svc_class> - Service class class
231 L<FS::part_svc_column> - Column constraint class
233 L<FS::export_svc> - Class linking service definitions (see L<FS::part_svc>)
234 with exports (see L<FS::part_export>)
236 L<FS::part_export> - External provisioning export class
238 L<FS::part_export_option> - Export option class
240 L<FS::pkg_category> - Package category class (invoice oriented)
242 L<FS::pkg_class> - Package class class
244 L<FS::part_pkg> - Package definition class
246 L<FS::part_pkg_msgcat> - Package definition localization class
248 L<FS::part_pkg_link> - Package definition link class
250 L<FS::part_pkg_taxclass> - Tax class class
252 L<FS::part_pkg_option> - Package definition option class
254 L<FS::part_pkg_report_option> - Package reporting classification class
256 L<FS::part_pkg_vendor> - Package external mapping class
258 L<FS::pkg_svc> - Class linking package definitions (see L<FS::part_pkg>) with
259 service definitions (see L<FS::part_svc>)
261 L<FS::qual> - Service qualification class
263 L<FS::qual_option> - Qualification option class
265 L<FS::reg_code> - One-time registration codes
267 L<FS::reg_code_pkg> - Class linking registration codes (see L<FS::reg_code>) with package definitions (see L<FS::part_pkg>)
269 L<FS::rate> - Rate plans for call billing
271 L<FS::rate_region> - Rate regions for call billing
273 L<FS::rate_prefix> - Rate region prefixes for call billing
275 L<FS::rate_detail> - Rate plan detail for call billing
277 L<FS::rate_tier> - Rate tiers for call billing
279 L<FS::rate_tier_details> - Rater tier details for call billing
281 L<FS::usage_class> - Usage class class
283 L<FS::sales> - Sales person class
285 L<FS::sales_pkg_class> - Sales person package class commission class
287 L<FS::agent> - Agent (reseller) class
289 L<FS::agent_pkg_class> - Agent (reseller) package class commission class
291 L<FS::agent_type> - Agent type class
293 L<FS::type_pkgs> - Class linking agent types (see L<FS::agent_type>) with package definitions (see L<FS::part_pkg>)
295 L<FS::payment_gateway> - Payment gateway class
297 L<FS::payment_gateway_option> - Payment gateway option class
299 L<FS::agent_payment_gateway> - Agent payment gateway class
301 L<FS::cust_svc> - Service class
303 L<FS::part_export_machine> - Export hostname choice class
305 L<FS::svc_export_machine> - Customer export hostname class
307 L<FS::cust_pkg> - Customer package class
309 L<FS::cust_pkg_option> - Customer package option class
311 L<FS::cust_pkg_detail> - Customer package details class
313 L<FS:;cust_pkg_discount> - Customer package discount class
315 L<FS:;cust_bill_pkg_discount> - Customer package discount line item application class
317 L<FS::discount> - Discount class
319 L<FS::discount_class> - Discount class class
321 L<FS::reason_type> - Reason type class
323 L<FS::reason> - Reason class
325 L<FS::cust_pkg_reason> - Package reason class
327 L<FS::contact_class> - Contact class class
329 L<FS::contact> - Contact class
331 L<FS::contact_phone> - Contact phone class
333 L<FS::phone_type> - Phone type class
335 L<FS::contact_email> - Contact email class
337 L<FS::prospect_main> - Prospect class
339 L<FS::cust_main> - Customer class
341 L<FS::cust_main::Billing> - Customer billing class
343 L<FS::cust_main::Billing_Realtime> - Customer real-time billing class
345 L<FS::cust_main::Packages> - Customer packages class
347 L<FS::cust_location> - Customer location class
349 L<FS::cust_main_Mixin> - Mixin class for records that contain fields from cust_main
351 L<FS::cust_main_invoice> - Invoice destination class
353 L<FS::cust_class> - Customer classification class
355 L<FS::cust_category> - Customer category class
357 L<FS::cust_tag> - Customer tag class
359 L<FS::part_tag> - Tag definition class
361 L<FS::cust_main_exemption> - Customer tax exemption class
363 L<FS::cust_main_note> - Customer note class
365 L<FS::cust_note_class> - Customer note classification class
367 L<FS::banned_pay> - Banned payment information class
369 L<FS::cust_bill> - Invoice class
371 L<FS::cust_statement> - Informational statement class
373 L<FS::cust_bill_pkg> - Invoice line item class
375 L<FS::cust_bill_pkg_detail> - Invoice line item detail class
377 L<FS::legacy_cust_bill> - Legacy data invoice class
379 L<FS::part_bill_event> - (Old) Invoice event definition class
381 L<FS::cust_bill_event> - (Old) Completed invoice event class
383 L<FS::part_event> - (New) Billing event definition class
385 L<FS::part_event_option> - (New) Billing event option class
387 L<FS::part_event::Condition> - (New) Billing event condition base class
389 L<FS::part_event::Action> - (New) Billing event action base class
391 L<FS::part_event_condition> - (New) Billing event condition class
393 L<FS::part_event_condition_option> - (New) Billing event condition option class
395 L<FS::part_event_condition_option_option> - (New) Billing event condition compound option class
397 L<FS::cust_event> - (New) Customer event class
399 L<FS::cust_bill_ApplicationCommon> - Base class for bill application classes
401 L<FS::cust_pay> - Payment class
403 L<FS::cust_pay_pending> - Pending payment class
405 L<FS::cust_pay_void> - Voided payment class
407 L<FS::cust_bill_pay> - Payment application class
409 L<FS::cust_bill_pay_pkg> - Line-item specific payment application class
411 L<FS::cust_bill_pay_batch> - Batch payment application class
413 L<FS::cust_credit> - Credit class
415 L<FS::cust_refund> - Refund class
417 L<FS::cust_credit_refund> - Refund application to credit class
419 L<FS::cust_credit_bill> - Credit application to invoice class
421 L<FS::cust_credit_bill_pkg> - Line-item specific credit application to invoice class
423 L<FS::cust_pay_refund> - Refund application to payment class
425 L<FS::pay_batch> - Credit card transaction queue class
427 L<FS::cust_pay_batch> - Credit card transaction member queue class
429 L<FS::prepay_credit> - Prepaid "calling card" credit class.
431 L<FS::nas> - Network Access Server class
433 L<FS::port> - NAS port class
435 L<FS::session> - User login session class
437 L<FS::queue> - Job queue
439 L<FS::queue_arg> - Job arguments
441 L<FS::queue_depend> - Job dependencies
443 L<FS::msg_template> - Message templates (customer notices)
445 L<FS::msgcat> - Message catalogs (error messages)
447 L<FS::clientapi_session>
449 L<FS::clientapi_session_field>
451 =head2 Historical database record classes
453 L<FS::h_Common> - History table base class
455 L<FS::h_cust_pay> - Historical record of customer payment changes
457 L<FS::h_cust_credit> - Historical record of customer credit changes
459 L<FS::h_cust_bill> - Historical record of customer tax changes (old-style)
461 L<FS::h_cust_svc> - Object method for h_cust_svc objects
463 L<FS::h_cust_tax_exempt> - Historical record of customer tax changes (old-style)
465 L<FS::h_domain_record> - Historical DNS entry objects
467 L<FS::h_svc_acct> - Historical account objects
469 L<FS::h_svc_broadband> - Historical broadband connection objects
471 L<FS::h_svc_cert> - Historical certificate services
473 L<FS::h_svc_dish> - Historical Dish Network services
475 L<FS::h_svc_domain> - Historical domain objects
477 L<FS::h_svc_dsl> - Historical DSL objects
479 L<FS::h_svc_external> - Historical externally tracked service objects
481 L<FS::h_svc_forward> - Historical mail forwarding alias objects
483 L<FS::h_svc_hardware> - Historical isntalled hardware service objects
485 L<FS::h_svc_mailinglist> - Historical mailing list objects
487 L<FS::h_svc_pbx> - Historical PBX objects
489 L<FS::h_svc_phone> - Historical phone number objects
491 L<FS::h_svc_port> - Historical port number objects
493 L<FS::h_svc_www> - Historical web virtual host objects
495 =head2 Remote API modules
497 L<FS::SelfService> - Self-service API
499 L<FS::SelfService::XMLRPC> - Self-service XML-RPC API
501 =head2 User Interface classes
503 L<FS::UI::Web> - Web user-interface class
505 L<FS::UI::bytecount> - Byte counter user-interface class
507 =head2 Command-line utilities
509 L<freeside-adduser> - Command line interface to add (freeside) users.
511 L<freeside-daily> - Run daily billing and collection events.
513 L<freeside-monthly> - Run monthly billing and invoice collection events.
515 L<freeside-dbdef-create> - Recreate database schema cache
517 L<freeside-deluser> - Command line interface to delete (freeside) users.
519 L<freeside-expiration-alerter> - Emails notifications of credit card expirations.
521 L<freeside-email> - Prints email addresses of all users on STDOUT
523 L<freeside-fetch> - Send a freeside page to a list of employees.
525 L<freeside-prepaidd> - Real-time daemon for prepaid packages
527 L<freeside-prune-applications> - Removes stray applications of credit, payment to bills, refunds, etc.
529 L<freeside-queued> - Job queue daemon
531 L<freeside-radgroup> - Command line utility to manipulate radius groups
533 L<freeside-reexport> - Command line tool to re-trigger export jobs for existing services
535 L<freeside-reset-fixed> - Command line tool to set the fixed columns for existing services
537 L<freeside-sqlradius-dedup-group> - Command line tool to eliminate duplicate usergroup entries from radius tables
539 L<freeside-sqlradius-radacctd> - Real-time radacct import daemon
541 L<freeside-sqlradius-reset> - Command line interface to reset and recreate RADIUS SQL tables
543 L<freeside-sqlradius-seconds> - Command line time-online tool
545 L<freeside-upgrade> - Upgrades database schema for new freeside verisons.
549 To quote perl(1), "If you're intending to read these straight through for the
550 first time, the suggested order will tend to reduce the number of forward
553 If you've never used OO modules before,
554 http://www.perl.com/doc/FMTEYEWTK/easy_objects.html might help you out.
558 Freeside is a billing and administration package for wired and wireless ISPs,
559 VoIP, hosting, service and content providers and other online businesses.
561 The Freeside home page is at <http://www.sisd.com/freeside>.
563 The main documentation is at <http://www.sisd.com/mediawiki>.
567 A mailing list for users is available. Send a blank message to
568 <freeside-users-subscribe@sisd.com> to subscribe.
570 A mailing list for developers is available. It is intended to be lower volume
571 and higher SNR than the users list. Send a blank message to
572 <freeside-devel-subscribe@sisd.com> to subscribe.
574 Commercial support is available; see
575 <http://www.sisd.com/freeside/commercial.html>.
607 See httemplate/docs/credits.html
611 perl(1), main Freeside documentation at <http://www.sisd.com/mediawiki/>
615 Those modules which would be useful separately should be pulled out,
616 renamed appropriately and uploaded to CPAN. So far: DBIx::DBSchema, Net::SSH