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::Upgrade> - Upgrade subroutines
  29
  30 L<FS::Conf> - Freeside configuration values
  31
  32 L<FS::ConfItem> - Freeside configuration option meta-data.
  33
  34 L<FS::ConfDefaults> - Freeside configuration default and available values
  35
  36 L<FS::UID> - User class (not yet OO)
  37
  38 L<FS::CurrentUser> -  Package representing the current user
  39
  40 L<FS::CGI> - Non OO-subroutines for the web interface.
  41
  42 L<FS::Msgcat> - Message catalog
  43
  44 L<FS::SearchCache> - Search cache
  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::Table::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::ClientAPI_SessionCache> - ClientAPI session cache
  61
  62 L<FS::Pony> - A pony
  63
  64 L<FS::cust_main::Search> - Customer searching
  65
  66 L<FS::cust_main::Import> - Batch customer importing
  67
  68 =head2 Database record classes
  69
  70 L<FS::Record> - Database record base class
  71
  72 L<FS::m2m_Common> - Mixin class for classes in a many-to-many relationship
  73
  74 L<FS::m2name_Common> - Base class for tables with a related table listing names
  75
  76 L<FS::option_Common> - Base class for option sub-classes
  77
  78 L<FS::class_Common> - Base class for classification classes
  79
  80 L<FS::category_Common> - Base class for category (grooups of classifications) classes
  81
  82 L<FS::conf> - Configuration value class
  83
  84 L<FS::payinfo_Mixin>  - Mixin class for records in tables that contain payinfo.
  85
  86 L<FS::access_user> - Employees / internal users
  87
  88 L<FS::access_user_pref> - Employee preferences
  89
  90 L<FS::access_group> - Employee groups
  91
  92 L<FS::access_usergroup> - Employee group membership
  93
  94 L<FS::access_groupagent> - Group reseller access
  95
  96 L<FS::access_right> - Access rights
  97
  98 L<FS::svc_acct_pop> - POP (Point of Presence, not Post
  99 Office Protocol) class
 100
 101 L<FS::part_pop_local> - Local calling area class
 102
 103 L<FS::part_referral> - Referral class
 104
 105 L<FS::pkg_referral> - Package referral class
 106
 107 L<FS::cust_main_county> - Locale (tax rate) class
 108
 109 L<FS::cust_tax_exempt> - Tax exemption record class
 110
 111 L<FS::cust_tax_adjustment> - Tax adjustment record class
 112
 113 L<FS::cust_tax_exempt_pkg> - Line-item specific tax exemption record class
 114
 115 L<FS::svc_Common> - Service base class
 116
 117 L<FS::svc_Parent_Mixin> - Mixin class for svc_ classes with a parent_svcnum field
 118
 119 L<FS::svc_acct> - Account (shell, RADIUS, POP3) class
 120
 121 L<FS::acct_snarf> - External mail account class
 122
 123 L<FS::acct_rt_transaction> - Time worked application to account class
 124
 125 L<FS::radius_usergroup> - RADIUS groups
 126
 127 L<FS::svc_domain> - Domain class
 128
 129 L<FS::domain_record> - DNS zone entries
 130
 131 L<FS::registrar> - Domain registrar class
 132
 133 L<FS::cgp_rule> - Communigate pro rule class
 134
 135 L<FS::cgp_rule_condition> - Communigate pro rule condition class
 136
 137 L<FS::cgp_rule_action> - Communigate pro rule action class
 138
 139 L<FS::svc_forward> - Mail forwarding class
 140
 141 L<FS::svc_mailinglist> - (Customer) Mailing list class
 142
 143 L<FS::mailinglist> - Mailing list class
 144
 145 L<FS::mailinglistmember> - Mailing list member class
 146
 147 L<FS::svc_www> - Web virtual host class.
 148
 149 L<FS::svc_broadband> - DSL, wireless and other broadband class.
 150
 151 L<FS::svc_dsl> - DSL
 152
 153 L<FS::dsl_note> - DSL order notes
 154
 155 L<FS::addr_block> - Address block class
 156
 157 L<FS::router> - Router class
 158
 159 L<FS::part_virtual_field> - Broadband virtual field class
 160
 161 L<FS::svc_phone> - Phone service class
 162
 163 L<FS::phone_device> - Phone device class
 164
 165 L<FS::part_device> - Device definition class
 166
 167 L<FS::phone_avail> - Phone number availability cache
 168
 169 L<FS::cdr> - Call Detail Record class
 170
 171 L<FS::cdr_batch> - Call Detail Record batch class
 172
 173 L<FS::cdr_calltype> - CDR calltype class
 174
 175 L<FS::cdr_carrier> - CDR carrier class
 176
 177 L<FS::cdr_type> - CDR type class
 178
 179 L<FS::svc_external> - Externally tracked service class.
 180
 181 L<FS::svc_pbx> - PBX service class
 182
 183 L<FS::svc_cert> - Certificate service class
 184
 185 L<FS::inventory_class> - Inventory classes
 186
 187 L<FS::inventory_item> - Inventory items
 188
 189 L<FS::part_svc> - Service definition class
 190
 191 L<FS::part_svc_column> - Column constraint class
 192
 193 L<FS::export_svc> - Class linking service definitions (see L<FS::part_svc>)
 194 with exports (see L<FS::part_export>)
 195
 196 L<FS::part_export> - External provisioning export class
 197
 198 L<FS::part_export_option> - Export option class
 199
 200 L<FS::pkg_category> - Package category class (invoice oriented)
 201
 202 L<FS::pkg_class> - Package class class
 203
 204 L<FS::part_pkg> - Package definition class
 205
 206 L<FS::part_pkg_link> - Package definition link class
 207
 208 L<FS::part_pkg_taxclass> - Tax class class
 209
 210 L<FS::part_pkg_option> - Package definition option class
 211
 212 L<FS::part_pkg_report_option> - Package reporting classification class
 213
 214 L<FS::part_pkg_vendor> - Package external mapping class
 215
 216 L<FS::pkg_svc> - Class linking package definitions (see L<FS::part_pkg>) with
 217 service definitions (see L<FS::part_svc>)
 218
 219 L<FS::qual> - Service qualification class
 220
 221 L<FS::qual_option> - Qualification option class
 222
 223 L<FS::reg_code> - One-time registration codes
 224
 225 L<FS::reg_code_pkg> - Class linking registration codes (see L<FS::reg_code>) with package definitions (see L<FS::part_pkg>)
 226
 227 L<FS::rate> - Rate plans for call billing
 228
 229 L<FS::rate_region> - Rate regions for call billing
 230
 231 L<FS::rate_prefix> - Rate region prefixes for call billing
 232
 233 L<FS::rate_detail> - Rate plan detail for call billing
 234
 235 L<FS::usage_class> - Usage class class
 236
 237 L<FS::agent> - Agent (reseller) class
 238
 239 L<FS::agent_type> - Agent type class
 240
 241 L<FS::type_pkgs> - Class linking agent types (see L<FS::agent_type>) with package definitions (see L<FS::part_pkg>)
 242
 243 L<FS::payment_gateway> - Payment gateway class
 244
 245 L<FS::payment_gateway_option> - Payment gateway option class
 246
 247 L<FS::agent_payment_gateway> - Agent payment gateway class
 248
 249 L<FS::cust_svc> - Service class
 250
 251 L<FS::cust_pkg> - Customer package class
 252
 253 L<FS::cust_pkg_option> - Customer package option class
 254
 255 L<FS::cust_pkg_detail> - Customer package details class
 256
 257 L<FS:;cust_pkg_discount> - Customer package discount class
 258
 259 L<FS:;cust_bill_pkg_discount> - Customer package discount line item application class
 260
 261 L<FS:;discount> - Discount class
 262
 263 L<FS::reason_type> - Reason type class
 264
 265 L<FS::reason> - Reason class
 266
 267 L<FS::cust_pkg_reason> - Package reason class
 268
 269 L<FS::contact> - Contact class
 270
 271 L<FS::contact_phone> - Contact phone class
 272
 273 L<FS::phone_type> - Phone type class
 274
 275 L<FS::contact_email> - Contact email class
 276
 277 L<FS::prospect_main> - Prospect class
 278
 279 L<FS::cust_main> - Customer class
 280
 281 L<FS::cust_main::Billing> - Customer billing class
 282
 283 L<FS::cust_main::Billing_Realtime> - Customer real-time billing class
 284
 285 L<FS::cust_main::Packages> - Customer packages class
 286
 287 L<FS::cust_location> - Customer location class
 288
 289 L<FS::cust_main_Mixin> - Mixin class for records that contain fields from cust_main
 290
 291 L<FS::cust_main_invoice> - Invoice destination class
 292
 293 L<FS::cust_class> - Customer classification class
 294
 295 L<FS::cust_category> - Customer category class
 296
 297 L<FS::cust_tag> - Customer tag class
 298
 299 L<FS::part_tag> - Tag definition class
 300
 301 L<FS::cust_main_exemption> - Customer tax exemption class
 302
 303 L<FS::cust_main_note> - Customer note class
 304
 305 L<FS::banned_pay> - Banned payment information class
 306
 307 L<FS::cust_bill> - Invoice class
 308
 309 L<FS::cust_statement> - Informational statement class
 310
 311 L<FS::cust_bill_pkg> - Invoice line item class
 312
 313 L<FS::cust_bill_pkg_detail> - Invoice line item detail class
 314
 315 L<FS::part_bill_event> - (Old) Invoice event definition class
 316
 317 L<FS::cust_bill_event> - (Old) Completed invoice event class
 318
 319 L<FS::part_event> - (New) Billing event definition class
 320
 321 L<FS::part_event_option> - (New) Billing event option class
 322
 323 L<FS::part_event::Condition> - (New) Billing event condition base class
 324
 325 L<FS::part_event::Action> - (New) Billing event action base class
 326
 327 L<FS::part_event_condition> - (New) Billing event condition class
 328
 329 L<FS::part_event_condition_option> - (New) Billing event condition option class
 330
 331 L<FS::part_event_condition_option_option> - (New) Billing event condition compound option class
 332
 333 L<FS::cust_event> - (New) Customer event class
 334
 335 L<FS::cust_bill_ApplicationCommon> - Base class for bill application classes
 336
 337 L<FS::cust_pay> - Payment class
 338
 339 L<FS::cust_pay_pending> - Pending payment class
 340
 341 L<FS::cust_pay_void> - Voided payment class
 342
 343 L<FS::cust_bill_pay> - Payment application class
 344
 345 L<FS::cust_bill_pay_pkg> - Line-item specific payment application class
 346
 347 L<FS::cust_bill_pay_batch> - Batch payment application class
 348
 349 L<FS::cust_credit> - Credit class
 350
 351 L<FS::cust_refund> - Refund class
 352
 353 L<FS::cust_credit_refund> - Refund application to credit class
 354
 355 L<FS::cust_credit_bill> - Credit application to invoice class
 356
 357 L<FS::cust_credit_bill_pkg> - Line-item specific credit application to invoice class
 358
 359 L<FS::cust_pay_refund> - Refund application to payment class
 360
 361 L<FS::pay_batch> - Credit card transaction queue class
 362
 363 L<FS::cust_pay_batch> - Credit card transaction member queue class
 364
 365 L<FS::prepay_credit> - Prepaid "calling card" credit class.
 366
 367 L<FS::nas> - Network Access Server class
 368
 369 L<FS::port> - NAS port class
 370
 371 L<FS::session> - User login session class
 372
 373 L<FS::queue> - Job queue
 374
 375 L<FS::queue_arg> - Job arguments
 376
 377 L<FS::queue_depend> - Job dependencies
 378
 379 L<FS::msg_template> - Message templates (customer notices)
 380
 381 L<FS::msgcat> - Message catalogs (error messages)
 382
 383 L<FS::clientapi_session>
 384
 385 L<FS::clientapi_session_field>
 386
 387 =head2 Historical database record classes
 388
 389 L<FS::h_Common> - History table base class
 390
 391 L<FS::h_cust_pay> - Historical record of customer payment changes
 392
 393 L<FS::h_cust_credit> - Historical record of customer credit changes
 394
 395 L<FS::h_cust_bill> - Historical record of customer tax changes (old-style)
 396
 397 L<FS::h_cust_svc> - Object method for h_cust_svc objects
 398
 399 L<FS::h_cust_tax_exempt> - Historical record of customer tax changes (old-style)
 400
 401 L<FS::h_domain_record> - Historical DNS entry objects
 402
 403 L<FS::h_svc_acct> - Historical account objects
 404
 405 L<FS::h_svc_broadband> - Historical broadband connection objects
 406
 407 L<FS::h_svc_domain> - Historical domain objects
 408
 409 L<FS::h_svc_external> - Historical externally tracked service objects
 410
 411 L<FS::h_svc_forward> - Historical mail forwarding alias objects
 412
 413 L<FS::h_svc_mailinglist> - Historical mailing list objects
 414
 415 L<FS::h_svc_phone> - Historical phone number objects
 416
 417 L<FS::h_svc_pbx> - Historical PBX objects
 418
 419 L<FS::h_svc_www> - Historical web virtual host objects
 420
 421 =head2 Remote API modules
 422
 423 L<FS::SelfService> - Self-service API
 424
 425 L<FS::SelfService::XMLRPC> - Self-service XML-RPC API
 426
 427 =head2 User Interface classes
 428
 429 L<FS::UI::Web> - Web user-interface class
 430
 431 L<FS::UI::bytecount> - Byte counter user-interface class
 432
 433 =head2 Command-line utilities
 434
 435 L<freeside-adduser> - Command line interface to add (freeside) users.
 436
 437 L<freeside-daily> - Run daily billing and collection events.
 438
 439 L<freeside-monthly> - Run monthly billing and invoice collection events.
 440
 441 L<freeside-dbdef-create> - Recreate database schema cache
 442
 443 L<freeside-deluser> - Command line interface to delete (freeside) users.
 444
 445 L<freeside-expiration-alerter> - Emails notifications of credit card expirations.
 446
 447 L<freeside-email> -  Prints email addresses of all users on STDOUT
 448
 449 L<freeside-fetch> - Send a freeside page to a list of employees.
 450
 451 L<freeside-prepaidd> - Real-time daemon for prepaid packages
 452
 453 L<freeside-prune-applications> - Removes stray applications of credit, payment to bills, refunds, etc.
 454
 455 L<freeside-queued> - Job queue daemon
 456
 457 L<freeside-radgroup> - Command line utility to manipulate radius groups
 458
 459 L<freeside-reexport> - Command line tool to re-trigger export jobs for existing services
 460
 461 L<freeside-reset-fixed> - Command line tool to set the fixed columns for existing services
 462
 463 L<freeside-sqlradius-dedup-group> - Command line tool to eliminate duplicate usergroup entries from radius tables
 464
 465 L<freeside-sqlradius-radacctd> - Real-time radacct import daemon
 466
 467 L<freeside-sqlradius-reset> - Command line interface to reset and recreate RADIUS SQL tables
 468
 469 L<freeside-sqlradius-seconds> - Command line time-online tool
 470
 471 L<freeside-upgrade> - Upgrades database schema for new freeside verisons.
 472
 473 =head1 Notes
 474
 475 To quote perl(1), "If you're intending to read these straight through for the
 476 first time, the suggested order will tend to reduce the number of forward
 477 references."
 478
 479 If you've never used OO modules before,
 480 http://www.perl.com/doc/FMTEYEWTK/easy_objects.html might help you out.
 481
 482 =head1 DESCRIPTION
 483
 484 Freeside is a billing and administration package for wired and wireless ISPs,
 485 VoIP, hosting, service and content providers and other online businesses.
 486
 487 The Freeside home page is at <http://www.sisd.com/freeside>.
 488
 489 The main documentation is at <http://www.sisd.com/mediawiki>.
 490
 491 =head1 SUPPORT
 492
 493 A mailing list for users is available.  Send a blank message to
 494 <freeside-users-subscribe@sisd.com> to subscribe.
 495
 496 A mailing list for developers is available.  It is intended to be lower volume
 497 and higher SNR than the users list.  Send a blank message to
 498 <freeside-devel-subscribe@sisd.com> to subscribe.
 499
 500 Commercial support is available; see
 501 <http://www.sisd.com/freeside/commercial.html>.
 502
 503 =head1 AUTHORS
 504
 505 Primarily Ivan Kohler, with help from many kind folks, including core
 506 contributors Jeff Finucane, Kristian Hoffman, Jason Hall and Peter Bowen.
 507
 508 See the CREDITS file in the Freeside distribution for a (hopefully) complete
 509 list and the individal files for details.
 510
 511 =head1 SEE ALSO
 512
 513 perl(1), main Freeside documentation at <http://www.sisd.com/mediawiki/>
 514
 515 =head1 BUGS
 516
 517 Those modules which would be useful separately should be pulled out,
 518 renamed appropriately and uploaded to CPAN.  So far: DBIx::DBSchema, Net::SSH
 519 and Net::SCP...
 520
 521 =cut
 522