FS/FS.pm

   1 package FS;
   2
   3 use strict;
   4 use vars qw($VERSION);
   5
   6 $VERSION = '%%%VERSION%%%';
   7
   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
  10
  11 1;
  12 __END__
  13
  14 =head1 NAME
  15
  16 FS - Freeside Perl modules
  17
  18 =head1 SYNOPSIS
  19
  20 Freeside perl modules and CLI utilities.
  21
  22 =head2 Utility classes
  23
  24 L<FS::Schema> - Freeside database schema
  25
  26 L<FS::Setup> - Setup subroutines
  27
  28 L<FS::Conf> - Freeside configuration values
  29
  30 L<FS::ConfItem> - Freeside configuration option meta-data.
  31
  32 L<FS::ConfDefaults> - Freeside configuration default and available values
  33
  34 L<FS::UID> - User class (not yet OO)
  35
  36 L<FS::CurrentUser> -  Package representing the current user
  37
  38 L<FS::CGI> - Non OO-subroutines for the web interface.
  39
  40 L<FS::Msgcat> - Message catalog
  41
  42 L<FS::SearchCache> - Search cache
  43
  44 L<FS::raddb> - RADIUS dictionary
  45
  46 L<FS::AccessRight> - Access control rights.
  47
  48 L<FS::Report> - Report data objects
  49
  50 L<FS::Report::Table> - Report data objects
  51
  52 L<FS::Report::Monthly> - Report data objects
  53
  54 L<FS::XMLRPC> - Backend XML::RPC server
  55
  56 L<FS::Misc> - Miscellaneous subroutines
  57
  58 L<FS::payby> - Payment types
  59
  60 L<FS::Pony> - A pony
  61
  62 =head2 Database record classes
  63
  64 L<FS::Record> - Database record base class
  65
  66 L<FS::m2m_Common> - Mixin class for classes in a many-to-many relationship
  67
  68 L<FS::m2name_Common> - Base class for tables with a related table listing names
  69
  70 L<FS::option_Common> - Base class for option sub-classes
  71
  72 L<FS::pkg_class> - Package class class
  73
  74 L<FS::payinfo_Mixin>  - Mixin class for records in tables that contain payinfo.
  75
  76 L<FS::access_user> - Employees / internal users
  77
  78 L<FS::access_user_pref> - Employee preferences
  79
  80 L<FS::access_group> - Employee groups
  81
  82 L<FS::access_usergroup> - Employee group membership
  83
  84 L<FS::access_groupagent> - Group reseller access
  85
  86 L<FS::access_right> - Access rights
  87
  88 L<FS::svc_acct_pop> - POP (Point of Presence, not Post
  89 Office Protocol) class
  90
  91 L<FS::part_pop_local> - Local calling area class
  92
  93 L<FS::part_referral> - Referral class
  94
  95 L<FS::cust_main_county> - Locale (tax rate) class
  96
  97 L<FS::cust_tax_exempt> - Tax exemption record class
  98
  99 L<FS::cust_tax_exempt_pkg> - Line-item specific tax exemption record class
 100
 101 L<FS::svc_Common> - Service base class
 102
 103 L<FS::svc_Parent_Mixin> - Mixin class for svc_ classes with a parent_svcnum field
 104
 105 L<FS::svc_acct> - Account (shell, RADIUS, POP3) class
 106
 107 L<FS::acct_snarf> - External mail account class
 108
 109 L<FS::radius_usergroup> - RADIUS groups
 110
 111 L<FS::svc_domain> - Domain class
 112
 113 L<FS::domain_record> - DNS zone entries
 114
 115 L<FS::registrar> - Domain registrar class
 116
 117 L<FS::svc_forward> - Mail forwarding class
 118
 119 L<FS::svc_www> - Web virtual host class.
 120
 121 L<FS::svc_broadband> - DSL, wireless and other broadband class.
 122
 123 L<FS::addr_block> - Address block class
 124
 125 L<FS::router> - Router class
 126
 127 L<FS::svc_phone> - Phone service class
 128
 129 L<FS::cdr> - Call Detail Record class
 130
 131 L<FS::cdr_calltype> - CDR calltype class
 132
 133 L<FS::cdr_carrier> - CDR carrier class
 134
 135 L<FS::cdr_upstream_rate> - CDR upstream rate class
 136
 137 L<FS::cdr_type> - CDR type class
 138
 139 L<FS::svc_external> - Externally tracked service class.
 140
 141 L<FS::inventory_class> - Inventory classes
 142
 143 L<FS::inventory_item> - Inventory items
 144
 145 L<FS::part_svc> - Service definition class
 146
 147 L<FS::part_svc_column> - Column constraint class
 148
 149 L<FS::export_svc> - Class linking service definitions (see L<FS::part_svc>)
 150 with exports (see L<FS::part_export>)
 151
 152 L<FS::part_export> - External provisioning export class
 153
 154 L<FS::part_export_option> - Export option class
 155
 156 L<FS::pkg_class> - Package class class
 157
 158 L<FS::part_pkg> - Package definition class
 159
 160 L<FS::part_pkg_option> - Package definition option class
 161
 162 L<FS::pkg_svc> - Class linking package definitions (see L<FS::part_pkg>) with
 163 service definitions (see L<FS::part_svc>)
 164
 165 L<FS::reg_code> - One-time registration codes
 166
 167 L<FS::reg_code_pkg> - Class linking registration codes (see L<FS::reg_code>) with package definitions (see L<FS::part_pkg>)
 168
 169 L<FS::rate> - Rate plans for call billing
 170
 171 L<FS::rate_region> - Rate regions for call billing
 172
 173 L<FS::rate_prefix> - Rate region prefixes for call billing
 174
 175 L<FS::rate_detail> - Rate plan detail for call billing
 176
 177 L<FS::agent> - Agent (reseller) class
 178
 179 L<FS::agent_type> - Agent type class
 180
 181 L<FS::type_pkgs> - Class linking agent types (see L<FS::agent_type>) with package definitions (see L<FS::part_pkg>)
 182
 183 L<FS::payment_gateway> - Payment gateway class
 184
 185 L<FS::payment_gateway_option> - Payment gateway option class
 186
 187 L<FS::agent_payment_gateway> - Agent payment gateway class
 188
 189 L<FS::cust_svc> - Service class
 190
 191 L<FS::cust_pkg> - Customer package class
 192
 193 L<FS::cust_pkg_option> - Customer package option class
 194
 195 L<FS::reason_type> - Reason type class
 196
 197 L<FS::reason> - Reason class
 198
 199 L<FS::cust_pkg_reason> - Package reason class
 200
 201 L<FS::cust_main> - Customer class
 202
 203 L<FS::cust_main_Mixin> - Mixin class for records that contain fields from cust_main
 204
 205 L<FS::cust_main_invoice> - Invoice destination class
 206
 207 L<FS::cust_main_note> - Customer note class
 208
 209 L<FS::banned_pay> - Banned payment information class
 210
 211 L<FS::cust_bill> - Invoice class
 212
 213 L<FS::cust_bill_pkg> - Invoice line item class
 214
 215 L<FS::cust_bill_pkg_detail> - Invoice line item detail class
 216
 217 L<FS::part_bill_event> - Invoice event definition class
 218
 219 L<FS::cust_bill_event> - Completed invoice event class
 220
 221 L<FS::cust_bill_ApplicationCommon> - Base class for bill application classes
 222
 223 L<FS::cust_pay> - Payment class
 224
 225 L<FS::cust_pay_void> - Voided payment class
 226
 227 L<FS::cust_bill_pay> - Payment application class
 228
 229 L<FS::cust_bill_pay_pkg> - Line-item specific payment application class
 230
 231 L<FS::cust_bill_pay_batch> - Batch payment application class
 232
 233 L<FS::cust_credit> - Credit class
 234
 235 L<FS::cust_refund> - Refund class
 236
 237 L<FS::cust_credit_refund> - Refund application to credit class
 238
 239 L<FS::cust_credit_bill> - Credit application to invoice class
 240
 241 L<FS::cust_credit_bill_pkg> - Line-item specific credit application to invoice class
 242
 243 L<FS::cust_pay_refund> - Refund application to payment class
 244
 245 L<FS::pay_batch> - Credit card transaction queue class
 246
 247 L<FS::cust_pay_batch> - Credit card transaction member queue class
 248
 249 L<FS::prepay_credit> - Prepaid "calling card" credit class.
 250
 251 L<FS::nas> - Network Access Server class
 252
 253 L<FS::port> - NAS port class
 254
 255 L<FS::session> - User login session class
 256
 257 L<FS::queue> - Job queue
 258
 259 L<FS::queue_arg> - Job arguments
 260
 261 L<FS::queue_depend> - Job dependencies
 262
 263 L<FS::msgcat> - Message catalogs
 264
 265 L<FS::clientapi_session>
 266
 267 L<FS::clientapi_session_field>
 268
 269 =head2 Historical database record classes
 270
 271 L<FS::h_Common> - History table base class
 272
 273 L<FS::h_cust_bill> - Historical record of customer tax changes (old-style)
 274
 275 L<FS::h_cust_svc> - Object method for h_cust_svc objects
 276
 277 L<FS::h_cust_tax_exempt> - Historical record of customer tax changes (old-style)
 278
 279 L<FS::h_domain_record> - Historical DNS entry objects
 280
 281 L<FS::h_svc_acct> - Historical account objects
 282
 283 L<FS::h_svc_broadband> - Historical broadband connection objects
 284
 285 L<FS::h_svc_domain> - Historical domain objects
 286
 287 L<FS::h_svc_external> - Historical externally tracked service objects
 288
 289 L<FS::h_svc_forward> - Historical mail forwarding alias objects
 290
 291 L<FS::h_svc_phone> - Historical phone number objects
 292
 293 L<FS::h_svc_www> - Historical web virtual host objects
 294
 295 =head2 Client API
 296
 297 L<FS::ClientAPI>
 298
 299 L<FS::ClientAPI_SessionCache>
 300
 301 L<FS::ClientAPI::Signup>
 302
 303 L<FS::ClientAPI::passwd>
 304
 305 L<FS::ClientAPI::MyAccount>
 306
 307 L<FS::ClientAPI::Agent>
 308
 309 =head2 Remote API modules
 310
 311 L<FS::SelfService>
 312
 313 L<FS::SignupClient>
 314
 315 L<FS::SessionClient>
 316
 317 L<FS::MailAdminServer> (deprecated in favor of the self-service server)
 318
 319 =head2 User Interface classes
 320
 321 L<FS::UI::Web> - Web user-interface class
 322
 323 L<FS::UI::bytecount> - Byte counter user-interface class
 324
 325 =head2 Command-line utilities
 326
 327 L<freeside-adduser>
 328
 329 L<freeside-queued>
 330
 331 L<freeside-daily>
 332
 333 L<freeside-expiration-alerter>
 334
 335 L<freeside-email>
 336
 337 L<freeside-cc-receipts-report>
 338
 339 L<freeside-credit-report>
 340
 341 L<freeside-receivables-report>
 342
 343 L<freeside-tax-report>
 344
 345 L<freeside-bill>
 346
 347 L<freeside-overdue>
 348
 349 =head1 Notes
 350
 351 To quote perl(1), "If you're intending to read these straight through for the
 352 first time, the suggested order will tend to reduce the number of forward
 353 references."
 354
 355 If you've never used OO modules before,
 356 http://www.perl.com/doc/FMTEYEWTK/easy_objects.html might help you out.
 357
 358 =head1 DESCRIPTION
 359
 360 Freeside is a billing and administration package for wired and wireless ISPs,
 361 VoIP, hosting, service and content providers and other online businesses.
 362
 363 The Freeside home page is at <http://www.sisd.com/freeside>.
 364
 365 The main documentation is at <http://www.sisd.com/mediawiki>.
 366
 367 =head1 SUPPORT
 368
 369 A mailing list for users is available.  Send a blank message to
 370 <freeside-users-subscribe@sisd.com> to subscribe.
 371
 372 A mailing list for developers is available.  It is intended to be lower volume
 373 and higher SNR than the users list.  Send a blank message to
 374 <freeside-devel-subscribe@sisd.com> to subscribe.
 375
 376 Commercial support is available; see
 377 <http://www.sisd.com/freeside/commercial.html>.
 378
 379 =head1 AUTHORS
 380
 381 Primarily Ivan Kohler, with help from many kind folks, including core
 382 contributors Jeff Finucane, Kristian Hoffman, Jason Hall and Peter Bowen.
 383
 384 See the CREDITS file in the Freeside distribution for a (hopefully) complete
 385 list and the individal files for details.
 386
 387 =head1 SEE ALSO
 388
 389 perl(1), main Freeside documentation at <http://www.sisd.com/mediawiki/>
 390
 391 =head1 BUGS
 392
 393 Those modules which would be useful separately should be pulled out,
 394 renamed appropriately and uploaded to CPAN.  So far: DBIx::DBSchema, Net::SSH
 395 and Net::SCP...
 396
 397 =cut
 398