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