From 6991d4986df7fb3a6c7c49b5ae1b3713e87a16c4 Mon Sep 17 00:00:00 2001 From: ivan Date: Tue, 29 Jan 2002 16:33:16 +0000 Subject: - web interface for hourly account charges! (FS::cust_pkg, FS::cust_svc and FS::svc_acct seconds_since methods) - Makefile target to regenerate HTML manpages on install - FS.pm doc update - $FS::Record::Debug now dumps all SQL - new FS::cust_main methods: ->cancel, ->invoicing_list_addpost - start of a billing event web interface - cust_pay::upgrade_replace doesn't error out if history includes overapplied payments --- httemplate/docs/man/FS.html | 62 ++++++++++++++++++++++++++++++++------------- 1 file changed, 44 insertions(+), 18 deletions(-) (limited to 'httemplate/docs/man/FS.html') diff --git a/httemplate/docs/man/FS.html b/httemplate/docs/man/FS.html index 23e8ca42f..7db6bb9fd 100644 --- a/httemplate/docs/man/FS.html +++ b/httemplate/docs/man/FS.html @@ -17,12 +17,17 @@
  • Utility classes
  • Database record classes
    • -
  • User Interface classes (under development; not yet usable)
    • + + +
  • Remote API modules
    • +
  • DESCRIPTION
    • -
  • VERSION
  • SUPPORT
  • AUTHOR
  • SEE ALSO
    • @@ -37,29 +42,32 @@

    SYNOPSIS

    -

    FS is the unofficial (i.e. non-CPAN) prefix for the Perl module portion of the -Freeside ISP billing software. This includes:

    +

    Freeside perl modules and CLI utilities.

    Utility classes

    the FS::Conf manpage - Freeside configuration values

    +

    the FS::ConfItem manpage - Freeside configuration option meta-data.

    the FS::UID manpage - User class (not yet OO)

    -

    the FS::CGI manpage - Non OO-subroutines for the web interface. This is -depriciated. Future development will be focused on the FS::UI user-interface -classes (see below).

    +

    the FS::CGI manpage - Non OO-subroutines for the web interface.

    Database record classes

    the FS::Record manpage - Database record base class

    the FS::svc_acct_pop manpage - POP (Point of Presence, not Post Office Protocol) class

    +

    the FS::part_pop_local manpage - Local calling area class

    the FS::part_referral manpage - Referral class

    the FS::cust_main_county manpage - Locale (tax rate) class

    the FS::svc_Common manpage - Service base class

    the FS::svc_acct manpage - Account (shell, RADIUS, POP3) class

    the FS::svc_domain manpage - Domain class

    the FS::domain_record manpage - DNS zone entries

    -

    the FS::svc_acct_sm manpage - Vitual mail alias class

    +

    the FS::svc_forward manpage - Mail forwarding class

    +

    the FS::svc_acct_sm manpage - (Depreciated) Vitual mail alias class

    the FS::svc_www manpage - Web virtual host class.

    the FS::part_svc manpage - Service definition class

    +

    the FS::part_svc_column manpage - Column constraint class

    +

    the FS::part_export manpage - External provisioning export class

    +

    the FS::part_export_option manpage - Export option class

    the FS::part_pkg manpage - Package (billing item) definition class

    the FS::pkg_svc manpage - Class linking package (billing item) definitions (see the FS::part_pkg manpage) with service definitions @@ -76,16 +84,36 @@ definitions (see the FS::part_pkg manpage) wi class

    the FS::cust_bill manpage - Invoice class

    the FS::cust_bill_pkg manpage - Invoice line item class

    +

    the FS::part_bill_event manpage - Invoice event definition class

    +

    the FS::cust_bill_event manpage - Completed invoice event class

    the FS::cust_pay manpage - Payment class

    +

    the FS::cust_bill_pay manpage - Payment application class

    the FS::cust_credit manpage - Credit class

    the FS::cust_refund manpage - Refund class

    +

    the FS::cust_credit_refund manpage - Refund application class

    +

    the FS::cust_credit_bill manpage - Credit invoice application class

    the FS::cust_pay_batch manpage - Credit card transaction queue class

    the FS::prepay_credit manpage - Prepaid ``calling card'' credit class.

    the FS::nas manpage - Network Access Server class

    the FS::port manpage - NAS port class

    the FS::session manpage - User login session class

    +

    the FS::queue manpage - Job queue

    +

    the FS::queue_arg manpage - Job arguments

    -

    User Interface classes (under development; not yet usable)

    +
    +

    Remote API modules

    +

    the FS::SignupClient manpage

    +

    the FS::SessionClient manpage

    +

    the FS::MailAdminServer manpage

    +

    +

    Command-line utilities

    +

    the freeside-email manpage

    +

    the freeside-queued manpage

    +

    the freeside-adduser manpage

    +

    the freeside-bill manpage

    +

    the freeside-overdue manpage

    +

    +

    User Interface classes (under (stalled) development; not yet usable)

    the FS::UI::Base manpage - User-interface base class

    the FS::UI::Gtk manpage - Gtk user-interface class

    the FS::UI::CGI manpage - CGI (HTML) user-interface class

    @@ -95,22 +123,23 @@ class

    To quote perl(1), ``If you're intending to read these straight through for the first time, the suggested order will tend to reduce the number of forward references.''

    +

    If you've never used OO modules before, +http://www.cpan.org/doc/FMTEYEWTK/easy_objects.html might help you out.

    DESCRIPTION

    Freeside is a billing and administration package for Internet Service Providers.

    The Freeside home page is at <http://www.sisd.com/freeside>.

    -

    The main documentation is in htdocs/docs.

    -

    -

    -

    VERSION

    -

    $Id: FS.html,v 1.1 2001-07-30 07:36:03 ivan Exp $

    +

    The main documentation is in httemplate/docs.

    SUPPORT

    -

    A mailing list for users and developers is available. Send a blank message to +

    A mailing list for users is available. Send a blank message to <ivan-freeside-subscribe@sisd.com> to subscribe.

    +

    A mailing list for developers is available. It is intended to be lower volume +and higher SNR than the users list. Send a blank message to +<ivan-freeside-devel-subscribe@sisd.com> to subscribe.

    Commercial support is available; see <http://www.sisd.com/freeside/commercial.html>.

    @@ -126,9 +155,6 @@ list and the individal files for details.

    BUGS

    -

    The version number of the FS Perl extension differs from the version of the -Freeside distribution, which are both different from the CVS version tag for -each file, which appears under the VERSION heading.

    Those modules which would be useful separately should be pulled out, renamed appropriately and uploaded to CPAN. So far: DBIx::DBSchema, Net::SSH and Net::SCP...

    -- cgit v1.2.1