#22830 API documentation

[freeside.git] / FS / FS.pm

diff --git a/FS/FS.pm b/FS/FS.pm
index 3716212..3b19737 100644 (file)
--- a/FS/FS.pm
+++ b/FS/FS.pm
@@ -3,7 +3,7 @@ package FS;
 use strict;
 use vars qw($VERSION);
 
-$VERSION = '%%%VERSION%%%';
+$VERSION = '4.0git';
 
 #find missing entries in this file with:
 # for a in `ls *pm | cut -d. -f1`; do grep 'L<FS::'$a'>' ../FS.pm >/dev/null || echo "missing $a" ; done
@@ -87,6 +87,8 @@ L<FS::payinfo_Mixin>  - Mixin class for records in tables that contain payinfo.
 
 L<FS::access_user> - Employees / internal users
 
+L<FS::access_user_session> - Access sessions
+
 L<FS::access_user_pref> - Employee preferences
 
 L<FS::access_group> - Employee groups
@@ -97,6 +99,10 @@ L<FS::access_groupagent> - Group reseller access
 
 L<FS::access_right> - Access rights
 
+L<FS::sched_item> - Installers / schedulable resources
+
+L<FS::sched_avail> - Installer/resource availability
+
 L<FS::svc_acct_pop> - POP (Point of Presence, not Post
 Office Protocol) class
 
@@ -202,16 +208,44 @@ L<FS::svc_external> - Externally tracked service class.
 
 L<FS::svc_pbx> - PBX service class
 
+L<FS::pbx_extension> - PBX extension class
+
+L<FS::pbx_device> - PBX device class
+
 L<FS::svc_cert> - Certificate service class
 
 L<FS::svc_dish> - Dish network service class
 
+L<FS::svc_cable> - Cable service class
+
+L<FS::cable_model> - Cable-modem model class
+
+L<FS::cable_provider> - Cable provider class
+
+L<FS::svc_alarm> - Alarm service class
+
+L<FS::alarm_system> - Alarm system class
+
+L<FS::alarm_type> - Alarm type (inputs and outputs) class
+
+L<FS::alarm_station> - Alarm central station class
+
+L<FS::svc_conferencing> - Conferencing service class
+
+L<FS::conferencing_type> - Conferencing type class
+
+L<FS::conferencing_quality> - Conferencing quality class
+
+L<FS::svc_video> - Video (IPTV/video-on-demand) service class
+
 L<FS::inventory_class> - Inventory classes
 
 L<FS::inventory_item> - Inventory items
 
 L<FS::part_svc> - Service definition class
 
+L<FS::part_svc_class> - Service class class
+
 L<FS::part_svc_column> - Column constraint class
 
 L<FS::export_svc> - Class linking service definitions (see L<FS::part_svc>)
@@ -227,6 +261,16 @@ L<FS::pkg_class> - Package class class
 
 L<FS::part_pkg> - Package definition class
 
+L<FS::part_pkg_msgcat> - Package definition localization class
+
+L<FS::part_pkg_usageprice> - Package definition usage pricing add-on class
+
+L<FS::cust_pkg_usageprice> - Customer package usage pricing add-on class
+
+L<FS::part_pkg_currency> - Package definition local currency prices
+
+L<FS::currency_exchange> - Currency exchange rates
+
 L<FS::part_pkg_link> - Package definition link class
 
 L<FS::part_pkg_taxclass> - Tax class class
@@ -262,8 +306,16 @@ L<FS::rate_tier_details> - Rater tier details for call billing
 
 L<FS::usage_class> - Usage class class
 
+L<FS::sales> - Sales person class
+
+L<FS::sales_pkg_class> - Sales person package class commission class
+
 L<FS::agent> - Agent (reseller) class
 
+L<FS::agent_currency> - Agent (reseller) currency class
+
+L<FS::agent_pkg_class> - Agent (reseller) package class commission class
+
 L<FS::agent_type> - Agent type class
 
 L<FS::type_pkgs> - Class linking agent types (see L<FS::agent_type>) with package definitions (see L<FS::part_pkg>)
@@ -276,6 +328,10 @@ L<FS::agent_payment_gateway> - Agent payment gateway class
 
 L<FS::cust_svc> - Service class
 
+L<FS::part_export_machine> - Export hostname choice class
+
+L<FS::svc_export_machine> - Customer export hostname class
+
 L<FS::cust_pkg> - Customer package class
 
 L<FS::cust_pkg_option> - Customer package option class
@@ -286,7 +342,9 @@ L<FS:;cust_pkg_discount> - Customer package discount class
 
 L<FS:;cust_bill_pkg_discount> - Customer package discount line item application class
 
-L<FS:;discount> - Discount class
+L<FS::discount> - Discount class
+
+L<FS::discount_class> - Discount class class
 
 L<FS::reason_type> - Reason type class
 
@@ -314,12 +372,16 @@ L<FS::cust_main::Billing_Realtime> - Customer real-time billing class
 
 L<FS::cust_main::Packages> - Customer packages class
 
+L<FS::cust_payby> - Customer payment information class
+
 L<FS::cust_location> - Customer location class
 
 L<FS::cust_main_Mixin> - Mixin class for records that contain fields from cust_main
 
 L<FS::cust_main_invoice> - Invoice destination class
 
+L<FS::cust_main_credit_limit> - Customer credit limit events class
+
 L<FS::cust_class> - Customer classification class
 
 L<FS::cust_category> - Customer category class
@@ -468,6 +530,8 @@ L<FS::SelfService> - Self-service API
 
 L<FS::SelfService::XMLRPC> - Self-service XML-RPC API
 
+L<FS::API> - Backoffice XML-RPC API
+
 =head2 User Interface classes
 
 L<FS::UI::Web> - Web user-interface class