FS/FS.pm

   1 package FS;
   2
   3 use strict;
   4 use vars qw($VERSION);
   5
   6 $VERSION = '4.0git';
   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::Locales> - Locales
  43
  44 L<FS::Msgcat> - Message catalog
  45
  46 L<FS::SearchCache> - Search cache
  47
  48 L<FS::AccessRight> - Access control rights.
  49
  50 L<FS::Report> - Report data objects
  51
  52 L<FS::Report::Table> - Report data objects
  53
  54 L<FS::Report::Table::Monthly> - Report data objects
  55
  56 L<FS::XMLRPC> - Backend XML::RPC server
  57
  58 L<FS::Misc> - Miscellaneous subroutines
  59
  60 L<FS::payby> - Payment types
  61
  62 L<FS::ClientAPI_SessionCache> - ClientAPI session cache
  63
  64 L<FS::Pony> - A pony
  65
  66 L<FS::cust_main::Search> - Customer searching
  67
  68 L<FS::cust_main::Import> - Batch customer importing
  69
  70 =head2 Database record classes
  71
  72 L<FS::Record> - Database record base class
  73
  74 L<FS::m2m_Common> - Mixin class for classes in a many-to-many relationship
  75
  76 L<FS::m2name_Common> - Base class for tables with a related table listing names
  77
  78 L<FS::option_Common> - Base class for option sub-classes
  79
  80 L<FS::class_Common> - Base class for classification classes
  81
  82 L<FS::category_Common> - Base class for category (grooups of classifications) classes
  83
  84 L<FS::conf> - Configuration value class
  85
  86 L<FS::payinfo_Mixin>  - Mixin class for records in tables that contain payinfo.
  87
  88 L<FS::access_user> - Employees / internal users
  89
  90 L<FS::access_user_session> - Access sessions
  91
  92 L<FS::access_user_pref> - Employee preferences
  93
  94 L<FS::access_group> - Employee groups
  95
  96 L<FS::access_usergroup> - Employee group membership
  97
  98 L<FS::access_groupagent> - Group reseller access
  99
 100 L<FS::access_right> - Access rights
 101
 102 L<FS::sched_item> - Installers / schedulable resources
 103
 104 L<FS::sched_avail> - Installer/resource availability
 105
 106 L<FS::svc_acct_pop> - POP (Point of Presence, not Post
 107 Office Protocol) class
 108
 109 L<FS::part_pop_local> - Local calling area class
 110
 111 L<FS::part_referral> - Referral class
 112
 113 L<FS::pkg_referral> - Package referral class
 114
 115 L<FS::cust_main_county> - Locale (tax rate) class
 116
 117 L<FS::cust_tax_exempt> - Tax exemption record class
 118
 119 L<FS::cust_tax_adjustment> - Tax adjustment record class
 120
 121 L<FS::cust_tax_exempt_pkg> - Line-item specific tax exemption record class
 122
 123 L<FS::svc_Common> - Service base class
 124
 125 L<FS::svc_Parent_Mixin> - Mixin class for svc_ classes with a parent_svcnum field
 126
 127 L<FS::svc_acct> - Account (shell, RADIUS, POP3) class
 128
 129 L<FS::acct_snarf> - External mail account class
 130
 131 L<FS::acct_rt_transaction> - Time worked application to account class
 132
 133 L<FS::radius_usergroup> - RADIUS user group membership
 134
 135 L<FS::radius_group> - RADIUS groups
 136
 137 L<FS::svc_domain> - Domain class
 138
 139 L<FS::domain_record> - DNS zone entries
 140
 141 L<FS::registrar> - Domain registrar class
 142
 143 L<FS::cgp_rule> - Communigate pro rule class
 144
 145 L<FS::cgp_rule_condition> - Communigate pro rule condition class
 146
 147 L<FS::cgp_rule_action> - Communigate pro rule action class
 148
 149 L<FS::svc_forward> - Mail forwarding class
 150
 151 L<FS::svc_mailinglist> - (Customer) Mailing list class
 152
 153 L<FS::mailinglist> - Mailing list class
 154
 155 L<FS::mailinglistmember> - Mailing list member class
 156
 157 L<FS::svc_www> - Web virtual host class.
 158
 159 L<FS::svc_broadband> - DSL, wireless and other broadband class.
 160
 161 L<FS::svc_dsl> - DSL
 162
 163 L<FS::dsl_device> - DSL device MAC addresses
 164
 165 L<FS::dsl_note> - DSL order notes
 166
 167 L<FS::addr_block> - Address block class
 168
 169 L<FS::router> - Router class
 170
 171 L<FS::tower> - Tower class
 172
 173 L<FS::tower_sector> - Tower sector class
 174
 175 L<FS::part_virtual_field> - Broadband virtual field class
 176
 177 L<FS::svc_phone> - Phone service class
 178
 179 L<FS::phone_device> - Phone device class
 180
 181 L<FS::part_device> - Device definition class
 182
 183 L<FS::phone_avail> - Phone number availability cache
 184
 185 L<FS::lata> - LATA number to name mapping class
 186
 187 L<FS::msa> - MSA number to name mapping class
 188
 189 L<FS::rate_center> - Rate center list (for bulk DID orders)
 190
 191 L<FS::did_vendor> - Bulk DID order vendor class
 192
 193 L<FS::did_order> - Bulk DID order class
 194
 195 L<FS::did_order_item> - Bulk DID order item class
 196
 197 L<FS::cdr> - Call Detail Record class
 198
 199 L<FS::cdr_batch> - Call Detail Record batch class
 200
 201 L<FS::cdr_calltype> - CDR calltype class
 202
 203 L<FS::cdr_carrier> - CDR carrier class
 204
 205 L<FS::cdr_type> - CDR type class
 206
 207 L<FS::svc_external> - Externally tracked service class.
 208
 209 L<FS::svc_pbx> - PBX service class
 210
 211 L<FS::pbx_extension> - PBX extension class
 212
 213 L<FS::pbx_device> - PBX device class
 214
 215 L<FS::svc_cert> - Certificate service class
 216
 217 L<FS::svc_dish> - Dish network service class
 218
 219 L<FS::svc_cable> - Cable service class
 220
 221 L<FS::cable_model> - Cable-modem model class
 222
 223 L<FS::cable_provider> - Cable provider class
 224
 225 L<FS::svc_alarm> - Alarm service class
 226
 227 L<FS::alarm_system> - Alarm system class
 228
 229 L<FS::alarm_type> - Alarm type (inputs and outputs) class
 230
 231 L<FS::alarm_station> - Alarm central station class
 232
 233 L<FS::svc_conferencing> - Conferencing service class
 234
 235 L<FS::conferencing_type> - Conferencing type class
 236
 237 L<FS::conferencing_quality> - Conferencing quality class
 238
 239 L<FS::svc_video> - Video (IPTV/video-on-demand) service class
 240
 241 L<FS::inventory_class> - Inventory classes
 242
 243 L<FS::inventory_item> - Inventory items
 244
 245 L<FS::part_svc> - Service definition class
 246
 247 L<FS::part_svc_class> - Service class class
 248
 249 L<FS::part_svc_column> - Column constraint class
 250
 251 L<FS::export_svc> - Class linking service definitions (see L<FS::part_svc>)
 252 with exports (see L<FS::part_export>)
 253
 254 L<FS::part_export> - External provisioning export class
 255
 256 L<FS::part_export_option> - Export option class
 257
 258 L<FS::pkg_category> - Package category class (invoice oriented)
 259
 260 L<FS::pkg_class> - Package class class
 261
 262 L<FS::part_pkg> - Package definition class
 263
 264 L<FS::part_pkg_msgcat> - Package definition localization class
 265
 266 L<FS::part_pkg_usageprice> - Package definition usage pricing add-on class
 267
 268 L<FS::cust_pkg_usageprice> - Customer package usage pricing add-on class
 269
 270 L<FS::part_pkg_currency> - Package definition local currency prices
 271
 272 L<FS::currency_exchange> - Currency exchange rates
 273
 274 L<FS::part_pkg_link> - Package definition link class
 275
 276 L<FS::part_pkg_taxclass> - Tax class class
 277
 278 L<FS::part_pkg_option> - Package definition option class
 279
 280 L<FS::part_pkg_report_option> - Package reporting classification class
 281
 282 L<FS::part_pkg_vendor> - Package external mapping class
 283
 284 L<FS::pkg_svc> - Class linking package definitions (see L<FS::part_pkg>) with
 285 service definitions (see L<FS::part_svc>)
 286
 287 L<FS::qual> - Service qualification class
 288
 289 L<FS::qual_option> - Qualification option class
 290
 291 L<FS::reg_code> - One-time registration codes
 292
 293 L<FS::reg_code_pkg> - Class linking registration codes (see L<FS::reg_code>) with package definitions (see L<FS::part_pkg>)
 294
 295 L<FS::rate> - Rate plans for call billing
 296
 297 L<FS::rate_region> - Rate regions for call billing
 298
 299 L<FS::rate_prefix> - Rate region prefixes for call billing
 300
 301 L<FS::rate_detail> - Rate plan detail for call billing
 302
 303 L<FS::rate_tier> - Rate tiers for call billing
 304
 305 L<FS::rate_tier_details> - Rater tier details for call billing
 306
 307 L<FS::usage_class> - Usage class class
 308
 309 L<FS::sales> - Sales person class
 310
 311 L<FS::sales_pkg_class> - Sales person package class commission class
 312
 313 L<FS::agent> - Agent (reseller) class
 314
 315 L<FS::agent_currency> - Agent (reseller) currency class
 316
 317 L<FS::agent_pkg_class> - Agent (reseller) package class commission class
 318
 319 L<FS::agent_type> - Agent type class
 320
 321 L<FS::type_pkgs> - Class linking agent types (see L<FS::agent_type>) with package definitions (see L<FS::part_pkg>)
 322
 323 L<FS::payment_gateway> - Payment gateway class
 324
 325 L<FS::payment_gateway_option> - Payment gateway option class
 326
 327 L<FS::agent_payment_gateway> - Agent payment gateway class
 328
 329 L<FS::cust_svc> - Service class
 330
 331 L<FS::part_export_machine> - Export hostname choice class
 332
 333 L<FS::svc_export_machine> - Customer export hostname class
 334
 335 L<FS::cust_pkg> - Customer package class
 336
 337 L<FS::cust_pkg_option> - Customer package option class
 338
 339 L<FS::cust_pkg_detail> - Customer package details class
 340
 341 L<FS::cust_pkg_discount> - Customer package discount class
 342
 343 L<FS::cust_bill_pkg_discount> - Customer package discount line item application class
 344
 345 L<FS::discount> - Discount class
 346
 347 L<FS::discount_class> - Discount class class
 348
 349 L<FS::reason_type> - Reason type class
 350
 351 L<FS::reason> - Reason class
 352
 353 L<FS::cust_pkg_reason> - Package reason class
 354
 355 L<FS::contact_class> - Contact class class
 356
 357 L<FS::contact> - Contact class
 358
 359 L<FS::contact_phone> - Contact phone class
 360
 361 L<FS::phone_type> - Phone type class
 362
 363 L<FS::contact_email> - Contact email class
 364
 365 L<FS::prospect_main> - Prospect class
 366
 367 L<FS::cust_main> - Customer class
 368
 369 L<FS::cust_main::Billing> - Customer billing class
 370
 371 L<FS::cust_main::Billing_Realtime> - Customer real-time billing class
 372
 373 L<FS::cust_main::Packages> - Customer packages class
 374
 375 L<FS::cust_payby> - Customer payment information class
 376
 377 L<FS::cust_location> - Customer location class
 378
 379 L<FS::cust_main_Mixin> - Mixin class for records that contain fields from cust_main
 380
 381 L<FS::cust_main_invoice> - Invoice destination class
 382
 383 L<FS::cust_main_credit_limit> - Customer credit limit events class
 384
 385 L<FS::cust_class> - Customer classification class
 386
 387 L<FS::cust_category> - Customer category class
 388
 389 L<FS::cust_tag> - Customer tag class
 390
 391 L<FS::part_tag> - Tag definition class
 392
 393 L<FS::cust_main_exemption> - Customer tax exemption class
 394
 395 L<FS::cust_main_note> - Customer note class
 396
 397 L<FS::cust_note_class> - Customer note classification class
 398
 399 L<FS::banned_pay> - Banned payment information class
 400
 401 L<FS::cust_bill> - Invoice class
 402
 403 L<FS::cust_statement> - Informational statement class
 404
 405 L<FS::cust_bill_pkg> - Invoice line item class
 406
 407 L<FS::cust_bill_pkg_detail> - Invoice line item detail class
 408
 409 L<FS::legacy_cust_bill> - Legacy data invoice class
 410
 411 L<FS::part_bill_event> - (Old) Invoice event definition class
 412
 413 L<FS::cust_bill_event> - (Old) Completed invoice event class
 414
 415 L<FS::part_event> - (New) Billing event definition class
 416
 417 L<FS::part_event_option> - (New) Billing event option class
 418
 419 L<FS::part_event::Condition> - (New) Billing event condition base class
 420
 421 L<FS::part_event::Action> - (New) Billing event action base class
 422
 423 L<FS::part_event_condition> - (New) Billing event condition class
 424
 425 L<FS::part_event_condition_option> - (New) Billing event condition option class
 426
 427 L<FS::part_event_condition_option_option> - (New) Billing event condition compound option class
 428
 429 L<FS::cust_event> - (New) Customer event class
 430
 431 L<FS::cust_bill_ApplicationCommon> - Base class for bill application classes
 432
 433 L<FS::cust_pay> - Payment class
 434
 435 L<FS::cust_pay_pending> - Pending payment class
 436
 437 L<FS::cust_pay_void> - Voided payment class
 438
 439 L<FS::cust_bill_pay> - Payment application class
 440
 441 L<FS::cust_bill_pay_pkg> - Line-item specific payment application class
 442
 443 L<FS::cust_bill_pay_batch> - Batch payment application class
 444
 445 L<FS::cust_credit> - Credit class
 446
 447 L<FS::cust_refund> - Refund class
 448
 449 L<FS::cust_credit_refund> - Refund application to credit class
 450
 451 L<FS::cust_credit_bill> - Credit application to invoice class
 452
 453 L<FS::cust_credit_bill_pkg> - Line-item specific credit application to invoice class
 454
 455 L<FS::cust_pay_refund> - Refund application to payment class
 456
 457 L<FS::pay_batch> - Credit card transaction queue class
 458
 459 L<FS::cust_pay_batch> - Credit card transaction member queue class
 460
 461 L<FS::prepay_credit> - Prepaid "calling card" credit class.
 462
 463 L<FS::nas> - Network Access Server class
 464
 465 L<FS::port> - NAS port class
 466
 467 L<FS::session> - User login session class
 468
 469 L<FS::queue> - Job queue
 470
 471 L<FS::queue_arg> - Job arguments
 472
 473 L<FS::queue_depend> - Job dependencies
 474
 475 L<FS::queue_stat> - Job statistics
 476
 477 L<FS::msg_template> - Message templates (customer notices)
 478
 479 L<FS::msgcat> - Message catalogs (error messages)
 480
 481 L<FS::clientapi_session>
 482
 483 L<FS::clientapi_session_field>
 484
 485 =head2 Historical database record classes
 486
 487 L<FS::h_Common> - History table base class
 488
 489 L<FS::h_cust_pay> - Historical record of customer payment changes
 490
 491 L<FS::h_cust_credit> - Historical record of customer credit changes
 492
 493 L<FS::h_cust_bill> - Historical record of customer tax changes (old-style)
 494
 495 L<FS::h_cust_svc> - Object method for h_cust_svc objects
 496
 497 L<FS::h_cust_tax_exempt> - Historical record of customer tax changes (old-style)
 498
 499 L<FS::h_domain_record> - Historical DNS entry objects
 500
 501 L<FS::h_svc_acct> - Historical account objects
 502
 503 L<FS::h_svc_broadband> - Historical broadband connection objects
 504
 505 L<FS::h_svc_cert> - Historical certificate services
 506
 507 L<FS::h_svc_dish> - Historical Dish Network services
 508
 509 L<FS::h_svc_domain> - Historical domain objects
 510
 511 L<FS::h_svc_dsl> - Historical DSL objects
 512
 513 L<FS::h_svc_external> - Historical externally tracked service objects
 514
 515 L<FS::h_svc_forward> - Historical mail forwarding alias objects
 516
 517 L<FS::h_svc_hardware> - Historical isntalled hardware service objects
 518
 519 L<FS::h_svc_mailinglist> - Historical mailing list objects
 520
 521 L<FS::h_svc_pbx> - Historical PBX objects
 522
 523 L<FS::h_svc_phone> - Historical phone number objects
 524
 525 L<FS::h_svc_port> - Historical port number objects
 526
 527 L<FS::h_svc_www> - Historical web virtual host objects
 528
 529 =head2 Remote API modules
 530
 531 L<FS::SelfService> - Self-service API
 532
 533 L<FS::SelfService::XMLRPC> - Self-service XML-RPC API
 534
 535 L<FS::API> - Backoffice XML-RPC API
 536
 537 =head2 User Interface classes
 538
 539 L<FS::UI::Web> - Web user-interface class
 540
 541 L<FS::UI::bytecount> - Byte counter user-interface class
 542
 543 =head2 Command-line utilities
 544
 545 =head3 Setup and upgrade
 546
 547 L<freeside-adduser> - Command line interface to add (freeside) users.
 548
 549 L<freeside-deluser> - Command line interface to delete (freeside) users.
 550
 551 L<freeside-dbdef-create> - Recreate database schema cache
 552
 553 L<freeside-setup> - Create new database
 554
 555 L<freeside-upgrade> - Upgrades database schema for new freeside verisons.
 556
 557 L<freeside-lata-import> - Seed LATA data
 558
 559 L<freeside-msa-import> - Seed MSA data
 560
 561 =head3 Cron
 562
 563 L<freeside-daily> - Run daily billing and collection events.
 564
 565 L<freeside-monthly> - Run monthly billing and invoice collection events.
 566
 567 L<freeside-expiration-alerter> - Emails notifications of credit card expirations.
 568
 569 =head3 Cron (payment batches)
 570
 571 L<freeside-eftca-download> - Download EFT Canada batch results
 572
 573 L<freeside-eftca-upload> - Upload an EFT Canada batch
 574
 575 L<freeside-paymentech-download> - Download Chase Paymentech batch results
 576
 577 L<freeside-paymentech-upload> - Upload a Chase Paymentech batch
 578
 579 =head3 Usage
 580
 581 L<freeside-cdr-sftp_and_import> - Download and import CDR files
 582
 583 L<freeside-ipifony-download> - Download usage data from IPifony
 584
 585 =head3 Misc. Tools (retreiving data)
 586
 587 L<freeside-email> -  Prints email addresses of all users on STDOUT
 588
 589 L<freeside-username_list> - List all usernames in the sytem
 590
 591 L<freeside-phonenum_list> - List all phone numbers in the system
 592
 593 =head3 Misc. Tools (taking actions)
 594
 595 L<freeside-fetch> - Send a freeside page to a list of employees.
 596
 597 L<freeside-prune-applications> - Removes stray applications of credit, payment to bills, refunds, etc.
 598
 599 =head3 Services
 600
 601 L<freeside-reexport> - Command line tool to re-trigger export jobs for existing services
 602
 603 L<freeside-reset-fixed> - Command line tool to set the fixed columns for existing services
 604
 605 =head3 RADIUS
 606
 607 L<freeside-radgroup> - Command line utility to manipulate radius groups
 608
 609 L<freeside-sqlradius-dedup-group> - Command line tool to eliminate duplicate usergroup entries from radius tables
 610
 611 L<freeside-sqlradius-reset> - Command line interface to reset and recreate RADIUS SQL tables
 612
 613 L<freeside-sqlradius-seconds> - Command line time-online tool
 614
 615 =head2 Daemons
 616
 617 L<freeside-cdrd> - CDR daemon
 618
 619 L<freeside-cdrrated> - Real-time CDR rating daemon
 620
 621 L<freeside-cdrrewrited> - CDR rewriting daemon
 622
 623 L<freeside-prepaidd> - Real-time daemon for prepaid packages
 624
 625 L<freeside-queued> - Job queue daemon
 626
 627 L<freeside-selvservice-server> - Self-service server
 628
 629 L<freeside-selfservice-xmlrpcd> - Self-service XML-RPC server
 630
 631 L<freeside-sqlradius-radacctd> - Real-time radacct import daemon
 632
 633 L<freeside-torrus-srvderive> - Torrus virtual port combining daemon
 634
 635 L<freeside-xmlrpcd> - Back-office XML-RPC server
 636
 637 =head1 Notes
 638
 639 To quote perl(1), "If you're intending to read these straight through for the
 640 first time, the suggested order will tend to reduce the number of forward
 641 references."
 642
 643 If you've never used OO modules before,
 644 http://www.perl.com/doc/FMTEYEWTK/easy_objects.html might help you out.
 645
 646 =head1 DESCRIPTION
 647
 648 Freeside is a billing and administration package for wired and wireless ISPs,
 649 VoIP, hosting, service and content providers and other online businesses.
 650
 651 The Freeside home page is at <http://freeside.biz/>.
 652
 653 The main documentation is at <http://freeside.biz/mediawiki>.
 654
 655 =head1 SUPPORT
 656
 657 A mailing list for users is available.  Send a blank message to
 658 <freeside-users-subscribe@freeside.biz> to subscribe.
 659
 660 A mailing list for developers is available.  It is intended to be lower volume
 661 and higher SNR than the users list.  Send a blank message to
 662 <freeside-devel-subscribe@freeside.biz> to subscribe.
 663
 664 Commercial products and services are available; see
 665 <http://freeside.biz/freeside/products.html> and <http://freeside.biz/freeside/services.html>.
 666
 667 =head1 AUTHORS
 668
 669 =head2 CORE TEAM
 670
 671 Jeremy Davis
 672
 673 Jason Hall
 674
 675 Ivan Kohler
 676
 677 Mark Wells
 678
 679 =head2 CORE EMERITUS
 680
 681 Peter Bowen
 682
 683 Jeff Finucane
 684
 685 Kristian Hoffman
 686
 687 Erik Levinson
 688
 689 Brian McCane
 690
 691 Richard Siddall
 692
 693 Matt Simerson
 694
 695 =head2 CONTRIBUTORS
 696
 697 See httemplate/docs/credits.html
 698
 699 =head1 SEE ALSO
 700
 701 perl(1), main Freeside documentation at <http://freeside.biz/mediawiki/>
 702
 703 =head1 BUGS
 704
 705 Those modules which would be useful separately should be pulled out,
 706 renamed appropriately and uploaded to CPAN.  So far: DBIx::DBSchema, Net::SSH
 707 and Net::SCP...
 708
 709 =cut
 710