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