regenerated perl api docs from embedded pod
authorivan <ivan>
Tue, 9 Feb 1999 09:38:15 +0000 (09:38 +0000)
committerivan <ivan>
Tue, 9 Feb 1999 09:38:15 +0000 (09:38 +0000)
25 files changed:
htdocs/docs/man/CGI.txt
htdocs/docs/man/Invoice.txt
htdocs/docs/man/Record.txt
htdocs/docs/man/UID.txt
htdocs/docs/man/agent.txt
htdocs/docs/man/agent_type.txt
htdocs/docs/man/cust_bill.txt
htdocs/docs/man/cust_bill_pkg.txt
htdocs/docs/man/cust_credit.txt
htdocs/docs/man/cust_main.txt
htdocs/docs/man/cust_main_county.txt
htdocs/docs/man/cust_pay.txt
htdocs/docs/man/cust_pkg.txt
htdocs/docs/man/cust_refund.txt
htdocs/docs/man/cust_svc.txt
htdocs/docs/man/index.html
htdocs/docs/man/part_pkg.txt
htdocs/docs/man/part_referral.txt
htdocs/docs/man/part_svc.txt
htdocs/docs/man/pkg_svc.txt
htdocs/docs/man/svc_acct.txt
htdocs/docs/man/svc_acct_pop.txt
htdocs/docs/man/svc_acct_sm.txt
htdocs/docs/man/svc_domain.txt
htdocs/docs/man/type_pkgs.txt

index 15a5ca1..c8eb4ff 100644 (file)
@@ -24,9 +24,13 @@ SUBROUTINES
         Returns an HTML menubar.
 
     idiot ERROR
         Returns an HTML menubar.
 
     idiot ERROR
+        This is depriciated. Don't use it.
+
         Sends headers and an HTML error message.
 
     eidiot ERROR
         Sends headers and an HTML error message.
 
     eidiot ERROR
+        This is depriciated. Don't use it.
+
         Sends headers and an HTML error message, then exits.
 
     popurl LEVEL
         Sends headers and an HTML error message, then exits.
 
     popurl LEVEL
@@ -36,6 +40,12 @@ SUBROUTINES
     table
         Returns HTML tag for beginning a table.
 
     table
         Returns HTML tag for beginning a table.
 
+    itable
+        Returns HTML tag for beginning an (invisible) table.
+
+    ntable
+        This is getting silly.
+
 BUGS
     Not OO.
 
 BUGS
     Not OO.
 
@@ -54,11 +64,24 @@ HISTORY
     pod ivan@sisd.com 98-sep-12
 
     $Log: CGI.txt,v $
     pod ivan@sisd.com 98-sep-12
 
     $Log: CGI.txt,v $
-    Revision 1.2  1998-11-13 09:56:34  ivan
-    change configuration file layout to support multiple distinct databases (with
-    own set of config files, export, etc.)
- Revision 1.11 1998/11/12 07:43:54 ivan ***
-    empty log message ***
+    Revision 1.4  1999-04-08 13:39:31  ivan
+    convert from pod for 1.2.0 release
+ Revision 1.17 1999/02/07 09:59:43 ivan more
+    mod_perl fixes, and bugfixes Peter Wemm sent via email
+
+    Revision 1.16 1999/01/25 12:26:05 ivan yet more mod_perl stuff
+
+    Revision 1.15 1999/01/18 09:41:48 ivan all $cgi->header calls
+    now include ( '-expires' => 'now' ) for mod_perl (good idea
+    anyway)
+
+    Revision 1.14 1999/01/18 09:22:37 ivan changes to track email
+    addresses for email invoicing
+
+    Revision 1.12 1998/12/23 02:23:16 ivan popurl always has
+    trailing slash
+
+    Revision 1.11 1998/11/12 07:43:54 ivan *** empty log message ***
 
     Revision 1.10 1998/11/12 01:53:47 ivan added table command
 
 
     Revision 1.10 1998/11/12 01:53:47 ivan added table command
 
index 426359f..d0ca37f 100644 (file)
@@ -2,7 +2,7 @@ NAME
     FS::Invoice - Legacy stub
 
 SYNOPSIS
     FS::Invoice - Legacy stub
 
 SYNOPSIS
-    The functioanlity of FS::invoice has been integrated in
+    The functionality of FS::Invoice has been integrated in
     FS::cust_bill.
 
 HISTORY
     FS::cust_bill.
 
 HISTORY
index 8409c2e..e1902fe 100644 (file)
@@ -3,7 +3,7 @@ NAME
 
 SYNOPSIS
         use FS::Record;
 
 SYNOPSIS
         use FS::Record;
-        use FS::Record qw(dbh fields hfields qsearch qsearchs dbdef);
+        use FS::Record qw(dbh fields qsearch qsearchs dbdef);
 
         $record = new FS::Record 'table', \%hash;
         $record = new FS::Record 'table', { 'column' => 'value', ... };
 
         $record = new FS::Record 'table', \%hash;
         $record = new FS::Record 'table', { 'column' => 'value', ... };
@@ -28,11 +28,14 @@ SYNOPSIS
 
         $hashref = $record->hashref;
 
 
         $hashref = $record->hashref;
 
-        $error = $record->add;
+        $error = $record->insert;
+        #$error = $record->add; #depriciated
 
 
-        $error = $record->del;
+        $error = $record->delete;
+        #$error = $record->del; #depriciated
 
 
-        $error = $new_record->rep($old_record);
+        $error = $new_record->replace($old_record);
+        #$error = $new_record->rep($old_record); #depriciated
 
         $value = $record->unique('column');
 
 
         $value = $record->unique('column');
 
@@ -57,7 +60,8 @@ SYNOPSIS
         $fields = hfields('table');
         if ( $fields->{Field} ) { # etc.
 
         $fields = hfields('table');
         if ( $fields->{Field} ) { # etc.
 
-        @fields = fields 'table';
+        @fields = fields 'table'; #as a subroutine
+        @fields = $record->fields; #as a method call
 
 DESCRIPTION
     (Mostly) object-oriented interface to database records. Records
 
 DESCRIPTION
     (Mostly) object-oriented interface to database records. Records
@@ -65,15 +69,18 @@ DESCRIPTION
     as a base class for table-specific classes to inherit from, i.e.
     FS::cust_main.
 
     as a base class for table-specific classes to inherit from, i.e.
     FS::cust_main.
 
-METHODS
-    new TABLE, HASHREF
+CONSTRUCTORS
+    new [ TABLE, ] HASHREF
         Creates a new record. It doesn't store it in the database,
         Creates a new record. It doesn't store it in the database,
-        though. See the section on "add" for that.
+        though. See the section on "insert" for that.
 
         Note that the object stores this hash reference, not a
         distinct copy of the hash it points to. You can ask the
         object for a copy with the *hash* method.
 
 
         Note that the object stores this hash reference, not a
         distinct copy of the hash it points to. You can ask the
         object for a copy with the *hash* method.
 
+        TABLE can only be omitted when a dervived class overrides
+        the table method.
+
     qsearch TABLE, HASHREF
         Searches the database for all records matching (at least)
         the key/value pairs in HASHREF. Returns all the records
     qsearch TABLE, HASHREF
         Searches the database for all records matching (at least)
         the key/value pairs in HASHREF. Returns all the records
@@ -87,6 +94,7 @@ METHODS
         you either made a logic error in asking for a single item,
         or your data is corrupted.
 
         you either made a logic error in asking for a single item,
         or your data is corrupted.
 
+METHODS
     table
         Returns the table name.
 
     table
         Returns the table name.
 
@@ -118,17 +126,29 @@ METHODS
     hashref
         Returns a reference to the column/value hash.
 
     hashref
         Returns a reference to the column/value hash.
 
-    add Adds this record to the database. If there is an error, returns
-        the error, otherwise returns false.
+    insert
+        Inserts this record to the database. If there is an error,
+        returns the error, otherwise returns false.
+
+    add Depriciated (use insert instead).
 
 
-    del Delete this record from the database. If there is an error,
+    delete
+        Delete this record from the database. If there is an error,
         returns the error, otherwise returns false.
 
         returns the error, otherwise returns false.
 
-    rep OLD_RECORD
+    del Depriciated (use delete instead).
+
+    replace OLD_RECORD
         Replace the OLD_RECORD with this one in the database. If
         there is an error, returns the error, otherwise returns
         false.
 
         Replace the OLD_RECORD with this one in the database. If
         there is an error, returns the error, otherwise returns
         false.
 
+    rep Depriciated (use replace instead).
+
+    check
+        Not yet implemented, croaks. Derived classes should provide
+        a check method.
+
     unique COLUMN
         Replaces COLUMN in record with a unique number. Called by
         the add method on primary keys and single-field unique
     unique COLUMN
         Replaces COLUMN in record with a unique number. Called by
         the add method on primary keys and single-field unique
@@ -184,6 +204,11 @@ METHODS
     ut_anything COLUMN
         Untaints arbitrary data. Be careful.
 
     ut_anything COLUMN
         Untaints arbitrary data. Be careful.
 
+    fields [ TABLE ]
+        This can be used as both a subroutine and a method call. It
+        returns a list of the columns in this record's table, or an
+        explicitly specified table. (See the dbdef_table manpage).
+
 SUBROUTINES
     reload_dbdef([FILENAME])
             Load a database definition (see the FS::dbdef manpage),
 SUBROUTINES
     reload_dbdef([FILENAME])
             Load a database definition (see the FS::dbdef manpage),
@@ -207,9 +232,8 @@ SUBROUTINES
             It returns a hash-type list with the fields of this
             record's table set true.
 
             It returns a hash-type list with the fields of this
             record's table set true.
 
-    fields TABLE
-            This returns a list of the columns in this record's
-            table (See the dbdef_table manpage).
+VERSION
+        $Id: Record.txt,v 1.4 1999-02-09 09:37:51 ivan Exp $
 
 BUGS
         This module should probably be renamed, since much of the
 
 BUGS
         This module should probably be renamed, since much of the
@@ -251,6 +275,9 @@ BUGS
         All the subroutines probably should be methods, here or
         elsewhere.
 
         All the subroutines probably should be methods, here or
         elsewhere.
 
+        Probably should borrow/use some dbdef methods where
+        appropriate (like sub fields)
+
 SEE ALSO
         the FS::dbdef manpage, the FS::UID manpage, the DBI manpage
 
 SEE ALSO
         the FS::dbdef manpage, the FS::UID manpage, the DBI manpage
 
@@ -333,11 +360,33 @@ HISTORY
         ut_phonen got ''; at the end ivan@sisd.com 98-sep-27
 
         $Log: Record.txt,v $
         ut_phonen got ''; at the end ivan@sisd.com 98-sep-27
 
         $Log: Record.txt,v $
-        Revision 1.3  1998-11-13 09:56:36  ivan
-        change configuration file layout to support multiple distinct databases (with
-        own set of config files, export, etc.)
- Revision 1.4 1998/11/10 07:45:25 ivan
-        doc clarification
+        Revision 1.4  1999-02-09 09:37:51  ivan
+        regenerated perl api docs from embedded pod
+ Revision 1.12 1999/01/25 12:26:06 ivan
+        yet more mod_perl stuff
+
+        Revision 1.11 1999/01/18 09:22:38 ivan changes to track
+        email addresses for email invoicing
+
+        Revision 1.10 1998/12/29 11:59:33 ivan mostly properly OO,
+        some work still to be done with svc_ stuff
+
+        Revision 1.9 1998/11/21 07:26:45 ivan "Records identical"
+        carp tells us it is just a warning.
+
+        Revision 1.8 1998/11/15 11:02:04 ivan bugsquash
+
+        Revision 1.7 1998/11/15 10:56:31 ivan qsearch gets sames "IS
+        NULL" semantics as other WHERE clauses
+
+        Revision 1.6 1998/11/15 05:31:03 ivan bugfix for new config
+        layout
+
+        Revision 1.5 1998/11/13 09:56:51 ivan change configuration
+        file layout to support multiple distinct databases (with own
+        set of config files, export, etc.)
+
+        Revision 1.4 1998/11/10 07:45:25 ivan doc clarification
 
         Revision 1.2 1998/11/07 05:17:18 ivan In sub new, Pg wrapper
         for money fields from dbdef (FS::Record::fields $table), not
 
         Revision 1.2 1998/11/07 05:17:18 ivan In sub new, Pg wrapper
         for money fields from dbdef (FS::Record::fields $table), not
index e246364..7c4b1ab 100644 (file)
@@ -69,6 +69,9 @@ CALLBACKS
         $coderef = sub { warn "Hi, I'm returning your call!" };
         $FS::UID::callback{'Package::Name'};
 
         $coderef = sub { warn "Hi, I'm returning your call!" };
         $FS::UID::callback{'Package::Name'};
 
+VERSION
+    $Id: UID.txt,v 1.3 1999-02-09 09:37:52 ivan Exp $
+
 BUGS
     Too many package-global variables.
 
 BUGS
     Too many package-global variables.
 
@@ -111,11 +114,22 @@ HISTORY
     inlined suidsetup ivan@sisd.com 98-sep-12
 
     $Log: UID.txt,v $
     inlined suidsetup ivan@sisd.com 98-sep-12
 
     $Log: UID.txt,v $
-    Revision 1.2  1998-11-13 09:56:37  ivan
-    change configuration file layout to support multiple distinct databases (with
-    own set of config files, export, etc.)
- Revision 1.3 1998/11/08 10:45:42 ivan got sub
-    cgi for FS::CGI
+    Revision 1.3  1999-02-09 09:37:52  ivan
+    regenerated perl api docs from embedded pod
+ Revision 1.7 1999/01/18 09:22:40 ivan changes
+    to track email addresses for email invoicing
+
+    Revision 1.6 1998/11/15 05:27:48 ivan bugfix for new
+    configuration layout
+
+    Revision 1.5 1998/11/15 00:51:51 ivan eliminated some warnings
+    on certain fatal errors (well, it is less confusing)
+
+    Revision 1.4 1998/11/13 09:56:52 ivan change configuration file
+    layout to support multiple distinct databases (with own set of
+    config files, export, etc.)
+
+    Revision 1.3 1998/11/08 10:45:42 ivan got sub cgi for FS::CGI
 
     Revision 1.2 1998/11/08 09:38:43 ivan cgisuidsetup complains if
     you pass it a isa CGI::Base instead of an isa CGI (first step in
 
     Revision 1.2 1998/11/08 09:38:43 ivan cgisuidsetup complains if
     you pass it a isa CGI::Base instead of an isa CGI (first step in
index b0317f6..13a4f0c 100644 (file)
@@ -4,8 +4,8 @@ NAME
 SYNOPSIS
       use FS::agent;
 
 SYNOPSIS
       use FS::agent;
 
-      $record = create FS::agent \%hash;
-      $record = create FS::agent { 'column' => 'value' };
+      $record = new FS::agent \%hash;
+      $record = new FS::agent { 'column' => 'value' };
 
       $error = $record->insert;
 
 
       $error = $record->insert;
 
@@ -27,7 +27,7 @@ DESCRIPTION
     prog - For future use.
     freq - For future use.
 METHODS
     prog - For future use.
     freq - For future use.
 METHODS
-    create HASHREF
+    new HASHREF
         Creates a new agent. To add the agent to the database, see
         the section on "insert".
 
         Creates a new agent. To add the agent to the database, see
         the section on "insert".
 
@@ -49,9 +49,10 @@ METHODS
         there is an error, returns the error, otherwise returns
         false. Called by the insert and replace methods.
 
         there is an error, returns the error, otherwise returns
         false. Called by the insert and replace methods.
 
-BUGS
-    It doesn't properly override FS::Record yet.
+VERSION
+    $Id: agent.txt,v 1.3 1999-04-08 13:39:31 ivan Exp $
 
 
+BUGS
 SEE ALSO
     the FS::Record manpage, the FS::agent_type manpage, the
     FS::cust_main manpage, schema.html from the base documentation.
 SEE ALSO
     the FS::Record manpage, the FS::agent_type manpage, the
     FS::cust_main manpage, schema.html from the base documentation.
index ea1edec..5983fee 100644 (file)
@@ -4,8 +4,8 @@ NAME
 SYNOPSIS
       use FS::agent_type;
 
 SYNOPSIS
       use FS::agent_type;
 
-      $record = create FS::agent_type \%hash;
-      $record = create FS::agent_type { 'column' => 'value' };
+      $record = new FS::agent_type \%hash;
+      $record = new FS::agent_type { 'column' => 'value' };
 
       $error = $record->insert;
 
 
       $error = $record->insert;
 
@@ -27,7 +27,7 @@ DESCRIPTION
     typenum - primary key (assigned automatically for new agent types)
     atype - Text name of this agent type
 METHODS
     typenum - primary key (assigned automatically for new agent types)
     atype - Text name of this agent type
 METHODS
-    create HASHREF
+    new HASHREF
         Creates a new agent type. To add the agent type to the
         database, see the section on "insert".
 
         Creates a new agent type. To add the agent type to the
         database, see the section on "insert".
 
@@ -49,9 +49,10 @@ METHODS
         If there is an error, returns the error, otherwise returns
         false. Called by the insert and replace methods.
 
         If there is an error, returns the error, otherwise returns
         false. Called by the insert and replace methods.
 
-BUGS
-    It doesn't properly override FS::Record yet.
+VERSION
+    $Id: agent_type.txt,v 1.3 1999-04-08 13:39:31 ivan Exp $
 
 
+BUGS
 SEE ALSO
     the FS::Record manpage, the FS::agent manpage, the FS::type_pkgs
     manpage, the FS::cust_main manpage, the FS::part_pkg manpage,
 SEE ALSO
     the FS::Record manpage, the FS::agent manpage, the FS::type_pkgs
     manpage, the FS::cust_main manpage, the FS::part_pkg manpage,
@@ -70,3 +71,9 @@ HISTORY
 
     pod, added check in delete ivan@sisd.com 98-sep-21
 
 
     pod, added check in delete ivan@sisd.com 98-sep-21
 
+    $Log: agent_type.txt,v $
+    Revision 1.3  1999-04-08 13:39:31  ivan
+    convert from pod for 1.2.0 release
+ Revision 1.2 1998/12/29 11:59:35 ivan
+    mostly properly OO, some work still to be done with svc_ stuff
+
index bc0b64d..9780ca7 100644 (file)
@@ -4,8 +4,8 @@ NAME
 SYNOPSIS
       use FS::cust_bill;
 
 SYNOPSIS
       use FS::cust_bill;
 
-      $record = create FS::cust_bill \%hash;
-      $record = create FS::cust_bill { 'column' => 'value' };
+      $record = new FS::cust_bill \%hash;
+      $record = new FS::cust_bill { 'column' => 'value' };
 
       $error = $record->insert;
 
 
       $error = $record->insert;
 
@@ -41,7 +41,7 @@ DESCRIPTION
     printed - how many times this invoice has been printed automatically
     (see the section on "collect" in the FS::cust_main manpage).
 METHODS
     printed - how many times this invoice has been printed automatically
     (see the section on "collect" in the FS::cust_main manpage).
 METHODS
-    create HASHREF
+    new HASHREF
         Creates a new invoice. To add the invoice to the database,
         see the section on "insert". Invoices are normally created
         by calling the bill method of a customer object (see the
         Creates a new invoice. To add the invoice to the database,
         see the section on "insert". Invoices are normally created
         by calling the bill method of a customer object (see the
@@ -105,24 +105,19 @@ METHODS
         manpage. Also see the Time::Local manpage and the
         Date::Parse manpage for conversion functions.
 
         manpage. Also see the Time::Local manpage and the
         Date::Parse manpage for conversion functions.
 
+VERSION
+    $Id: cust_bill.txt,v 1.3 1999-02-09 09:37:55 ivan Exp $
+
 BUGS
     The delete method.
 
 BUGS
     The delete method.
 
-    It doesn't properly override FS::Record yet.
-
-    print_text formatting (and some logic :/) is in source as a
-    format declaration, which needs to be slurped in from a file.
-    the fork is rather kludgy as well. It could be cleaned with
-    swrite from man perlform, and the picture could be put in a
-    /var/spool/freeside/conf file. Also number of lines ($=).
+    print_text formatting (and some logic :/) is in source, but
+    needs to be slurped in from a file. Also number of lines ($=).
 
     missing print_ps for a nice postscript copy (maybe HylaFAX-
     cover-page-style or something similar so the look can be
     completely customized?)
 
 
     missing print_ps for a nice postscript copy (maybe HylaFAX-
     cover-page-style or something similar so the look can be
     completely customized?)
 
-    There is an off-by-one error in print_text which causes a visual
-    error: "Page 1 of 2" printed on some single-page invoices?
-
 SEE ALSO
     the FS::Record manpage, the FS::cust_main manpage, the
     FS::cust_pay manpage, the FS::cust_bill_pkg manpage, the
 SEE ALSO
     the FS::Record manpage, the FS::cust_main manpage, the
     FS::cust_pay manpage, the FS::cust_bill_pkg manpage, the
@@ -139,10 +134,21 @@ HISTORY
     pod, ingegrate with FS::Invoice ivan@sisd.com 98-sep-20
 
     $Log: cust_bill.txt,v $
     pod, ingegrate with FS::Invoice ivan@sisd.com 98-sep-20
 
     $Log: cust_bill.txt,v $
-    Revision 1.2  1998-11-13 09:56:38  ivan
-    change configuration file layout to support multiple distinct databases (with
-    own set of config files, export, etc.)
- Revision 1.2 1998/11/07 10:24:24 ivan
-    don't use depriciated FS::Bill and FS::Invoice, other
-    miscellania
+    Revision 1.3  1999-02-09 09:37:55  ivan
+    regenerated perl api docs from embedded pod
+ Revision 1.6 1999/01/25 12:26:07 ivan yet
+    more mod_perl stuff
+
+    Revision 1.5 1999/01/18 21:58:03 ivan esthetic: eq and ne were
+    used in a few places instead of == and !=
+
+    Revision 1.4 1998/12/29 11:59:36 ivan mostly properly OO, some
+    work still to be done with svc_ stuff
+
+    Revision 1.3 1998/11/13 09:56:53 ivan change configuration file
+    layout to support multiple distinct databases (with own set of
+    config files, export, etc.)
+
+    Revision 1.2 1998/11/07 10:24:24 ivan don't use depriciated
+    FS::Bill and FS::Invoice, other miscellania
 
 
index 1ca4b8c..d725c94 100644 (file)
@@ -4,8 +4,8 @@ NAME
 SYNOPSIS
       use FS::cust_bill_pkg;
 
 SYNOPSIS
       use FS::cust_bill_pkg;
 
-      $record = create FS::cust_bill_pkg \%hash;
-      $record = create FS::cust_bill_pkg { 'column' => 'value' };
+      $record = new FS::cust_bill_pkg \%hash;
+      $record = new FS::cust_bill_pkg { 'column' => 'value' };
 
       $error = $record->insert;
 
 
       $error = $record->insert;
 
@@ -32,7 +32,7 @@ DESCRIPTION
     functions.
 
 METHODS
     functions.
 
 METHODS
-    create HASHREF
+    new HASHREF
         Creates a new line item. To add the line item to the
         database, see the section on "insert". Line items are
         normally created by calling the bill method of a customer
         Creates a new line item. To add the line item to the
         database, see the section on "insert". Line items are
         normally created by calling the bill method of a customer
@@ -57,9 +57,10 @@ METHODS
         there is an error, returns the error, otherwise returns
         false. Called by the insert method.
 
         there is an error, returns the error, otherwise returns
         false. Called by the insert method.
 
-BUGS
-    It doesn't properly override FS::Record yet.
+VERSION
+    $Id: cust_bill_pkg.txt,v 1.3 1999-04-08 13:39:31 ivan Exp $
 
 
+BUGS
 SEE ALSO
     the FS::Record manpage, the FS::cust_bill manpage, the
     FS::cust_pkg manpage, the FS::cust_main manpage, schema.html
 SEE ALSO
     the FS::Record manpage, the FS::cust_bill manpage, the
     FS::cust_pkg manpage, the FS::cust_main manpage, schema.html
index 84591ee..c26c1fb 100644 (file)
@@ -4,8 +4,8 @@ NAME
 SYNOPSIS
       use FS::cust_credit;
 
 SYNOPSIS
       use FS::cust_credit;
 
-      $record = create FS::cust_credit \%hash;
-      $record = create FS::cust_credit { 'column' => 'value' };
+      $record = new FS::cust_credit \%hash;
+      $record = new FS::cust_credit { 'column' => 'value' };
 
       $error = $record->insert;
 
 
       $error = $record->insert;
 
@@ -30,7 +30,7 @@ DESCRIPTION
     otaker - order taker (assigned automatically, see the FS::UID manpage)
     reason - text
 METHODS
     otaker - order taker (assigned automatically, see the FS::UID manpage)
     reason - text
 METHODS
-    create HASHREF
+    new HASHREF
         Creates a new credit. To add the credit to the database, see
         the section on "insert".
 
         Creates a new credit. To add the credit to the database, see
         the section on "insert".
 
@@ -59,11 +59,12 @@ METHODS
         there is an error, returns the error, otherwise returns
         false. Called by the insert and replace methods.
 
         there is an error, returns the error, otherwise returns
         false. Called by the insert and replace methods.
 
+VERSION
+    $Id: cust_credit.txt,v 1.3 1999-04-08 13:39:32 ivan Exp $
+
 BUGS
     The delete method.
 
 BUGS
     The delete method.
 
-    It doesn't properly override FS::Record yet.
-
 SEE ALSO
     the FS::Record manpage, the FS::cust_refund manpage, the
     FS::cust_bill manpage, schema.html from the base documentation.
 SEE ALSO
     the FS::Record manpage, the FS::cust_refund manpage, the
     FS::cust_bill manpage, schema.html from the base documentation.
@@ -73,3 +74,15 @@ HISTORY
 
     pod, otaker from FS::UID ivan@sisd.com 98-sep-21
 
 
     pod, otaker from FS::UID ivan@sisd.com 98-sep-21
 
+    $Log: cust_credit.txt,v $
+    Revision 1.3  1999-04-08 13:39:32  ivan
+    convert from pod for 1.2.0 release
+ Revision 1.4 1999/01/25 12:26:08 ivan
+    yet more mod_perl stuff
+
+    Revision 1.3 1999/01/18 21:58:04 ivan esthetic: eq and ne were
+    used in a few places instead of == and !=
+
+    Revision 1.2 1998/12/29 11:59:38 ivan mostly properly OO, some
+    work still to be done with svc_ stuff
+
index f0625c1..707cf95 100644 (file)
@@ -4,8 +4,8 @@ NAME
 SYNOPSIS
       use FS::cust_main;
 
 SYNOPSIS
       use FS::cust_main;
 
-      $record = create FS::cust_main \%hash;
-      $record = create FS::cust_main { 'column' => 'value' };
+      $record = new FS::cust_main \%hash;
+      $record = new FS::cust_main { 'column' => 'value' };
 
       $error = $record->insert;
 
 
       $error = $record->insert;
 
@@ -58,7 +58,7 @@ DESCRIPTION
     tax - tax exempt, empty or `Y'
     otaker - order taker (assigned automatically, see the FS::UID manpage)
 METHODS
     tax - tax exempt, empty or `Y'
     otaker - order taker (assigned automatically, see the FS::UID manpage)
 METHODS
-    create HASHREF
+    new HASHREF
         Creates a new customer. To add the customer to the database,
         see the section on "insert".
 
         Creates a new customer. To add the customer to the database,
         see the section on "insert".
 
@@ -151,24 +151,52 @@ METHODS
         Returns the balance for this customer (total owed minus
         total credited).
 
         Returns the balance for this customer (total owed minus
         total credited).
 
-BUGS
-    The delete method.
+    invoicing_list [ ARRAYREF ]
+        If an arguement is given, sets these email addresses as
+        invoice recipients (see the FS::cust_main_invoice manpage).
+        Errors are not fatal and are not reported (except as
+        warnings), so use check_invoicing_list first.
+
+        Returns a list of email addresses (with svcnum entries
+        expanded).
+
+        Note: You can clear the invoicing list by passing an empty
+        ARRAYREF. You can check it without disturbing anything by
+        passing nothing.
+
+        This interface may change in the future.
 
 
-    It doesn't properly override FS::Record yet.
+    check_invoicing_list ARRAYREF
+        Checks these arguements as valid input for the
+        invoicing_list method. If there is an error, returns the
+        error, otherwise returns false.
 
 
-    hfields should be removed.
+VERSION
+    $Id: cust_main.txt,v 1.3 1999-02-09 09:37:58 ivan Exp $
+
+BUGS
+    The delete method.
 
     Bill and collect options should probably be passed as references
     instead of a list.
 
     CyberCash v2 forces us to define some variables in package main.
 
 
     Bill and collect options should probably be passed as references
     instead of a list.
 
     CyberCash v2 forces us to define some variables in package main.
 
+    There should probably be a configuration file with a list of
+    allowed credit card types.
+
+    CyberCash is the only processor.
+
+    No multiple currency support (probably a larger project than
+    just this module).
+
 SEE ALSO
     the FS::Record manpage, the FS::cust_pkg manpage, the
     FS::cust_bill manpage, the FS::cust_credit manpage the
     FS::cust_pay_batch manpage, the FS::agent manpage, the
     FS::part_referral manpage, the FS::cust_main_county manpage, the
 SEE ALSO
     the FS::Record manpage, the FS::cust_pkg manpage, the
     FS::cust_bill manpage, the FS::cust_credit manpage the
     FS::cust_pay_batch manpage, the FS::agent manpage, the
     FS::part_referral manpage, the FS::cust_main_county manpage, the
-    FS::UID manpage, schema.html from the base documentation.
+    FS::cust_main_invoice manpage, the FS::UID manpage, schema.html
+    from the base documentation.
 
 HISTORY
     ivan@voicenet.com 97-jul-28
 
 HISTORY
     ivan@voicenet.com 97-jul-28
@@ -199,10 +227,33 @@ HISTORY
     FS::UID::{datasrc,checkruid} ivan@sisd.com 98-sep-19-21
 
     $Log: cust_main.txt,v $
     FS::UID::{datasrc,checkruid} ivan@sisd.com 98-sep-19-21
 
     $Log: cust_main.txt,v $
-    Revision 1.2  1998-11-13 09:56:39  ivan
-    change configuration file layout to support multiple distinct databases (with
-    own set of config files, export, etc.)
- Revision 1.2 1998/11/07 10:24:25 ivan
-    don't use depriciated FS::Bill and FS::Invoice, other
-    miscellania
+    Revision 1.3  1999-02-09 09:37:58  ivan
+    regenerated perl api docs from embedded pod
+ Revision 1.10 1999/01/25 12:26:09 ivan
+    yet more mod_perl stuff
+
+    Revision 1.9 1999/01/18 09:22:41 ivan changes to track email
+    addresses for email invoicing
+
+    Revision 1.8 1998/12/29 11:59:39 ivan mostly properly OO, some
+    work still to be done with svc_ stuff
+
+    Revision 1.7 1998/12/16 09:58:52 ivan library support for
+    editing email invoice destinations (not in sub collect yet)
+
+    Revision 1.6 1998/11/18 09:01:42 ivan i18n! i18n!
+
+    Revision 1.5 1998/11/15 11:23:14 ivan use FS::table_name for all
+    searches to eliminate warnings, emit state/county when they
+    don't match
+
+    Revision 1.4 1998/11/15 05:30:48 ivan bugfix for new config
+    layout
+
+    Revision 1.3 1998/11/13 09:56:54 ivan change configuration file
+    layout to support multiple distinct databases (with own set of
+    config files, export, etc.)
+
+    Revision 1.2 1998/11/07 10:24:25 ivan don't use depriciated
+    FS::Bill and FS::Invoice, other miscellania
 
 
index 8e99397..9a4a60e 100644 (file)
@@ -5,8 +5,8 @@ NAME
 SYNOPSIS
       use FS::cust_main_county;
 
 SYNOPSIS
       use FS::cust_main_county;
 
-      $record = create FS::cust_main_county \%hash;
-      $record = create FS::cust_main_county { 'column' => 'value' };
+      $record = new FS::cust_main_county \%hash;
+      $record = new FS::cust_main_county { 'column' => 'value' };
 
       $error = $record->insert;
 
 
       $error = $record->insert;
 
@@ -24,9 +24,10 @@ DESCRIPTION
     taxnum - primary key (assigned automatically for new tax rates)
     state
     county
     taxnum - primary key (assigned automatically for new tax rates)
     state
     county
+    country
     tax - percentage
 METHODS
     tax - percentage
 METHODS
-    create HASHREF
+    new HASHREF
         Creates a new tax rate. To add the tax rate to the database,
         see the section on "insert".
 
         Creates a new tax rate. To add the tax rate to the database,
         see the section on "insert".
 
@@ -48,11 +49,10 @@ METHODS
         there is an error, returns the error, otherwise returns
         false. Called by the insert and replace methods.
 
         there is an error, returns the error, otherwise returns
         false. Called by the insert and replace methods.
 
-BUGS
-    It doesn't properly override FS::Record yet.
-
-    A country field (and possibly a currency field) should be added.
+VERSION
+    $Id: cust_main_county.txt,v 1.3 1999-04-08 13:39:32 ivan Exp $
 
 
+BUGS
 SEE ALSO
     the FS::Record manpage, the FS::cust_main manpage, the
     FS::cust_bill manpage, schema.html from the base documentation.
 SEE ALSO
     the FS::Record manpage, the FS::cust_main manpage, the
     FS::cust_bill manpage, schema.html from the base documentation.
@@ -65,3 +65,12 @@ HISTORY
 
     pod ivan@sisd.com 98-sep-21
 
 
     pod ivan@sisd.com 98-sep-21
 
+    $Log: cust_main_county.txt,v $
+    Revision 1.3  1999-04-08 13:39:32  ivan
+    convert from pod for 1.2.0 release
+ Revision 1.3 1998/12/29 11:59:41
+    ivan mostly properly OO, some work still to be done with svc_
+    stuff
+
+    Revision 1.2 1998/11/18 09:01:43 ivan i18n! i18n!
+
index 9f28d08..14843d0 100644 (file)
@@ -4,8 +4,8 @@ NAME
 SYNOPSIS
       use FS::cust_pay;
 
 SYNOPSIS
       use FS::cust_pay;
 
-      $record = create FS::cust_pay \%hash;
-      $record = create FS::cust_pay { 'column' => 'value' };
+      $record = new FS::cust_pay \%hash;
+      $record = new FS::cust_pay { 'column' => 'value' };
 
       $error = $record->insert;
 
 
       $error = $record->insert;
 
@@ -29,7 +29,7 @@ DESCRIPTION
     payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username)
     paybatch - text field for tracking card processing
 METHODS
     payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username)
     paybatch - text field for tracking card processing
 METHODS
-    create HASHREF
+    new HASHREF
         Creates a new payment. To add the payment to the databse,
         see the section on "insert".
 
         Creates a new payment. To add the payment to the databse,
         see the section on "insert".
 
@@ -48,9 +48,10 @@ METHODS
         there is an error, returns the error, otherwise returns
         false. Called by the insert method.
 
         there is an error, returns the error, otherwise returns
         false. Called by the insert method.
 
-BUGS
-    It doesn't properly override FS::Record yet.
+VERSION
+    $Id: cust_pay.txt,v 1.3 1999-04-08 13:39:32 ivan Exp $
 
 
+BUGS
     Delete and replace methods.
 
 SEE ALSO
     Delete and replace methods.
 
 SEE ALSO
@@ -64,3 +65,12 @@ HISTORY
 
     pod ivan@sisd.com 98-sep-21
 
 
     pod ivan@sisd.com 98-sep-21
 
+    $Log: cust_pay.txt,v $
+    Revision 1.3  1999-04-08 13:39:32  ivan
+    convert from pod for 1.2.0 release
+ Revision 1.3 1999/01/25 12:26:11 ivan yet
+    more mod_perl stuff
+
+    Revision 1.2 1998/12/29 11:59:43 ivan mostly properly OO, some
+    work still to be done with svc_ stuff
+
index c5d143d..7486456 100644 (file)
@@ -4,8 +4,8 @@ NAME
 SYNOPSIS
       use FS::cust_pkg;
 
 SYNOPSIS
       use FS::cust_pkg;
 
-      $record = create FS::cust_pkg \%hash;
-      $record = create FS::cust_pkg { 'column' => 'value' };
+      $record = new FS::cust_pkg \%hash;
+      $record = new FS::cust_pkg { 'column' => 'value' };
 
       $error = $record->insert;
 
 
       $error = $record->insert;
 
@@ -23,6 +23,8 @@ SYNOPSIS
 
       $part_pkg = $record->part_pkg;
 
 
       $part_pkg = $record->part_pkg;
 
+      @labels = $record->labels;
+
       $error = FS::cust_pkg::order( $custnum, \@pkgparts );
       $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
 
       $error = FS::cust_pkg::order( $custnum, \@pkgparts );
       $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );
 
@@ -46,7 +48,7 @@ DESCRIPTION
     conversion functions.
 
 METHODS
     conversion functions.
 
 METHODS
-    create HASHREF
+    new HASHREF
         Create a new billing item. To add the item to the database,
         see the section on "insert".
 
         Create a new billing item. To add the item to the database,
         see the section on "insert".
 
@@ -60,8 +62,6 @@ METHODS
         items, because there would then be no record the customer
         ever purchased the item. Instead, see the cancel method.
 
         items, because there would then be no record the customer
         ever purchased the item. Instead, see the cancel method.
 
-        sub delete { return "Can't delete cust_pkg records!"; }
-
     replace OLD_RECORD
         Replaces the OLD_RECORD with this one in the database. If
         there is an error, returns the error, otherwise returns
     replace OLD_RECORD
         Replaces the OLD_RECORD with this one in the database. If
         there is an error, returns the error, otherwise returns
@@ -70,7 +70,8 @@ METHODS
         Currently, custnum, setup, bill, susp, expire, and cancel
         may be changed.
 
         Currently, custnum, setup, bill, susp, expire, and cancel
         may be changed.
 
-        pkgpart may not be changed, but see the order subroutine.
+        Changing pkgpart may have disasterous effects. See the order
+        subroutine.
 
         setup and bill are normally updated by calling the bill
         method of a customer object (see the FS::cust_main manpage).
 
         setup and bill are normally updated by calling the bill
         method of a customer object (see the FS::cust_main manpage).
@@ -114,6 +115,11 @@ METHODS
         Returns the definition for this billing item, as an
         FS::part_pkg object (see L<FS::part_pkg).
 
         Returns the definition for this billing item, as an
         FS::part_pkg object (see L<FS::part_pkg).
 
+    labels
+        Returns a list of lists, calling the label method for all
+        services (see the FS::cust_svc manpage) of this billing
+        item.
+
 SUBROUTINES
     order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF ]
         CUSTNUM is a customer (see the FS::cust_main manpage)
 SUBROUTINES
     order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF ]
         CUSTNUM is a customer (see the FS::cust_main manpage)
@@ -128,9 +134,10 @@ SUBROUTINES
         items. An error is returned if this is not possible (see the
         FS::pkg_svc manpage).
 
         items. An error is returned if this is not possible (see the
         FS::pkg_svc manpage).
 
-BUGS
-    It doesn't properly override FS::Record yet.
+VERSION
+    $Id: cust_pkg.txt,v 1.3 1999-02-09 09:38:01 ivan Exp $
 
 
+BUGS
     sub order is not OO. Perhaps it should be moved to FS::cust_main
     and made so?
 
     sub order is not OO. Perhaps it should be moved to FS::cust_main
     and made so?
 
@@ -141,6 +148,13 @@ BUGS
     defines a standard method to pass dates to the recur_prog
     expression, it should do so.
 
     defines a standard method to pass dates to the recur_prog
     expression, it should do so.
 
+    FS::svc_acct, FS::svc_acct_sm, and FS::svc_domain are loaded via
+    'use' at compile time, rather than via 'require' in sub { setup,
+    suspend, unsuspend, cancel } because they use %FS::UID::callback
+    to load configuration values. Probably need a subroutine which
+    decides what to do based on whether or not we've fetched the
+    user yet, rather than a hash. See FS::UID and the TODO.
+
 SEE ALSO
     the FS::Record manpage, the FS::cust_main manpage, the
     FS::part_pkg manpage, the FS::cust_svc manpage , the FS::pkg_svc
 SEE ALSO
     the FS::Record manpage, the FS::cust_main manpage, the
     FS::part_pkg manpage, the FS::cust_svc manpage , the FS::pkg_svc
@@ -155,9 +169,19 @@ HISTORY
     pod ivan@sisd.com 98-sep-21
 
     $Log: cust_pkg.txt,v $
     pod ivan@sisd.com 98-sep-21
 
     $Log: cust_pkg.txt,v $
-    Revision 1.2  1998-11-13 09:56:40  ivan
-    change configuration file layout to support multiple distinct databases (with
-    own set of config files, export, etc.)
- Revision 1.2 1998/11/12 03:42:45 ivan
-    added label method
+    Revision 1.3  1999-02-09 09:38:01  ivan
+    regenerated perl api docs from embedded pod
+ Revision 1.6 1999/01/25 12:26:12 ivan yet
+    more mod_perl stuff
+
+    Revision 1.5 1999/01/18 21:58:07 ivan esthetic: eq and ne were
+    used in a few places instead of == and !=
+
+    Revision 1.4 1998/12/29 11:59:45 ivan mostly properly OO, some
+    work still to be done with svc_ stuff
+
+    Revision 1.3 1998/11/15 13:01:35 ivan allow pkgpart changing
+    (for per-customer custom pricing). warn about it in doc
+
+    Revision 1.2 1998/11/12 03:42:45 ivan added label method
 
 
index 392a0b5..a982ca6 100644 (file)
@@ -4,8 +4,8 @@ NAME
 SYNOPSIS
       use FS::cust_refund;
 
 SYNOPSIS
       use FS::cust_refund;
 
-      $record = create FS::cust_refund \%hash;
-      $record = create FS::cust_refund { 'column' => 'value' };
+      $record = new FS::cust_refund \%hash;
+      $record = new FS::cust_refund { 'column' => 'value' };
 
       $error = $record->insert;
 
 
       $error = $record->insert;
 
@@ -28,7 +28,7 @@ DESCRIPTION
     payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username)
     otaker - order taker (assigned automatically, see the FS::UID manpage)
 METHODS
     payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username)
     otaker - order taker (assigned automatically, see the FS::UID manpage)
 METHODS
-    create HASHREF
+    new HASHREF
         Creates a new refund. To add the refund to the database, see
         the section on "insert".
 
         Creates a new refund. To add the refund to the database, see
         the section on "insert".
 
@@ -47,9 +47,10 @@ METHODS
         there is an error, returns the error, otherwise returns
         false. Called by the insert method.
 
         there is an error, returns the error, otherwise returns
         false. Called by the insert method.
 
-BUGS
-    It doesn't properly override FS::Record yet.
+VERSION
+    $Id: cust_refund.txt,v 1.3 1999-04-08 13:39:32 ivan Exp $
 
 
+BUGS
     Delete and replace methods.
 
 SEE ALSO
     Delete and replace methods.
 
 SEE ALSO
@@ -64,3 +65,12 @@ HISTORY
 
     pod and finish up ivan@sisd.com 98-sep-21
 
 
     pod and finish up ivan@sisd.com 98-sep-21
 
+    $Log: cust_refund.txt,v $
+    Revision 1.3  1999-04-08 13:39:32  ivan
+    convert from pod for 1.2.0 release
+ Revision 1.3 1999/01/25 12:26:13 ivan
+    yet more mod_perl stuff
+
+    Revision 1.2 1998/12/29 11:59:46 ivan mostly properly OO, some
+    work still to be done with svc_ stuff
+
index adc1ca2..206d9d3 100644 (file)
@@ -4,8 +4,8 @@ NAME
 SYNOPSIS
       use FS::cust_svc;
 
 SYNOPSIS
       use FS::cust_svc;
 
-      $record = create FS::cust_svc \%hash
-      $record = create FS::cust_svc { 'column' => 'value' };
+      $record = new FS::cust_svc \%hash
+      $record = new FS::cust_svc { 'column' => 'value' };
 
       $error = $record->insert;
 
 
       $error = $record->insert;
 
@@ -25,7 +25,7 @@ DESCRIPTION
     pkgnum - Package (see the FS::cust_pkg manpage)
     svcpart - Service definition (see the FS::part_svc manpage)
 METHODS
     pkgnum - Package (see the FS::cust_pkg manpage)
     svcpart - Service definition (see the FS::part_svc manpage)
 METHODS
-    create HASHREF
+    new HASHREF
         Creates a new service. To add the refund to the database,
         see the section on "insert". Services are normally created
         by creating FS::svc_ objects (see the FS::svc_acct manpage,
         Creates a new service. To add the refund to the database,
         see the section on "insert". Services are normally created
         by creating FS::svc_ objects (see the FS::svc_acct manpage,
@@ -59,6 +59,9 @@ METHODS
         or mail alias) - The table name (i.e. svc_domain) for this
         service
 
         or mail alias) - The table name (i.e. svc_domain) for this
         service
 
+VERSION
+    $Id: cust_svc.txt,v 1.4 1999-04-08 13:39:32 ivan Exp $
+
 BUGS
     Behaviour of changing the svcpart of cust_svc records is
     undefined and should possibly be prohibited, and pkg_svc records
 BUGS
     Behaviour of changing the svcpart of cust_svc records is
     undefined and should possibly be prohibited, and pkg_svc records
@@ -66,6 +69,9 @@ BUGS
 
     pkg_svc records are not checked in general (here).
 
 
     pkg_svc records are not checked in general (here).
 
+    Deleting this record doesn't check or delete the svc_* record
+    associated with this record.
+
 SEE ALSO
     the FS::Record manpage, the FS::cust_pkg manpage, the
     FS::part_svc manpage, the FS::pkg_svc manpage, schema.html from
 SEE ALSO
     the FS::Record manpage, the FS::cust_pkg manpage, the
     FS::part_svc manpage, the FS::pkg_svc manpage, schema.html from
@@ -79,11 +85,12 @@ HISTORY
     pod ivan@sisd.com 98-sep-21
 
     $Log: cust_svc.txt,v $
     pod ivan@sisd.com 98-sep-21
 
     $Log: cust_svc.txt,v $
-    Revision 1.2  1998-11-13 09:56:41  ivan
-    change configuration file layout to support multiple distinct databases (with
-    own set of config files, export, etc.)
- Revision 1.4 1998/11/12 07:58:15 ivan
-    added svcdb to label
+    Revision 1.4  1999-04-08 13:39:32  ivan
+    convert from pod for 1.2.0 release
+ Revision 1.5 1998/12/29 11:59:47 ivan
+    mostly properly OO, some work still to be done with svc_ stuff
+
+    Revision 1.4 1998/11/12 07:58:15 ivan added svcdb to label
 
     Revision 1.3 1998/11/12 03:45:38 ivan use FS::table_name for all
     tables qsearch()'ed
 
     Revision 1.3 1998/11/12 03:45:38 ivan use FS::table_name for all
     tables qsearch()'ed
index 4f33dd4..c3307e8 100644 (file)
@@ -11,6 +11,7 @@
 <li><a href="cust_credit.txt">FS::cust_credit</a>
 <li><a href="cust_main.txt">FS::cust_main</a>
 <li><a href="cust_main_county.txt">FS::cust_main_county</a>
 <li><a href="cust_credit.txt">FS::cust_credit</a>
 <li><a href="cust_main.txt">FS::cust_main</a>
 <li><a href="cust_main_county.txt">FS::cust_main_county</a>
+<li><a href="cust_main_invoice.txt">FS::cust_main_invoice</a>
 <li><a href="cust_pay.txt">FS::cust_pay</a>
 <li><a href="cust_pkg.txt">FS::cust_pkg</a>
 <li><a href="cust_refund.txt">FS::cust_refund</a>
 <li><a href="cust_pay.txt">FS::cust_pay</a>
 <li><a href="cust_pkg.txt">FS::cust_pkg</a>
 <li><a href="cust_refund.txt">FS::cust_refund</a>
@@ -19,6 +20,7 @@
 <li><a href="part_referral.txt">FS::part_referral</a>
 <li><a href="part_svc.txt">FS::part_svc</a>
 <li><a href="pkg_svc.txt">FS::pkg_svc</a>
 <li><a href="part_referral.txt">FS::part_referral</a>
 <li><a href="part_svc.txt">FS::part_svc</a>
 <li><a href="pkg_svc.txt">FS::pkg_svc</a>
+<li><a href="svc_Common.txt">FS::svc_Common</a>
 <li><a href="svc_acct.txt">FS::svc_acct</a>
 <li><a href="svc_acct_pop.txt">FS::svc_acct_pop</a>
 <li><a href="svc_acct_sm.txt">FS::svc_acct_sm</a>
 <li><a href="svc_acct.txt">FS::svc_acct</a>
 <li><a href="svc_acct_pop.txt">FS::svc_acct_pop</a>
 <li><a href="svc_acct_sm.txt">FS::svc_acct_sm</a>
index dc1bce4..02aa109 100644 (file)
@@ -4,8 +4,10 @@ NAME
 SYNOPSIS
       use FS::part_pkg;
 
 SYNOPSIS
       use FS::part_pkg;
 
-      $record = create FS::part_pkg \%hash
-      $record = create FS::part_pkg { 'column' => 'value' };
+      $record = new FS::part_pkg \%hash
+      $record = new FS::part_pkg { 'column' => 'value' };
+
+      $custom_record = $template_record->clone;
 
       $error = $record->insert;
 
 
       $error = $record->insert;
 
@@ -16,7 +18,7 @@ SYNOPSIS
       $error = $record->check;
 
 DESCRIPTION
       $error = $record->check;
 
 DESCRIPTION
-    An FS::part_pkg represents a billing item definition.
+    An FS::part_pkg object represents a billing item definition.
     FS::part_pkg inherits from FS::Record. The following fields are
     currently supported:
 
     FS::part_pkg inherits from FS::Record. The following fields are
     currently supported:
 
@@ -31,11 +33,18 @@ DESCRIPTION
     are not yet defined.
 
 METHODS
     are not yet defined.
 
 METHODS
-    create HASHREF
+    new HASHREF
         Creates a new billing item definition. To add the billing
         item definition to the database, see the section on
         "insert".
 
         Creates a new billing item definition. To add the billing
         item definition to the database, see the section on
         "insert".
 
+    clone
+        An alternate constructor. Creates a new billing item
+        definition by duplicating an existing definition. A new
+        pkgpart is assigned and `(CUSTOM) ' is prepended to the
+        comment field. To add the billing item definition to the
+        database, see the section on "insert".
+
     insert
         Adds this billing item definition to the database. If there
         is an error, returns the error, otherwise returns false.
     insert
         Adds this billing item definition to the database. If there
         is an error, returns the error, otherwise returns false.
@@ -53,6 +62,9 @@ METHODS
         otherwise returns false. Called by the insert and replace
         methods.
 
         otherwise returns false. Called by the insert and replace
         methods.
 
+VERSION
+    $Id: part_pkg.txt,v 1.3 1999-04-08 13:39:32 ivan Exp $
+
 BUGS
     It doesn't properly override FS::Record yet.
 
 BUGS
     It doesn't properly override FS::Record yet.
 
@@ -71,3 +83,11 @@ HISTORY
 
     pod ivan@sisd.com 98-sep-21
 
 
     pod ivan@sisd.com 98-sep-21
 
+    $Log: part_pkg.txt,v $
+    Revision 1.3  1999-04-08 13:39:32  ivan
+    convert from pod for 1.2.0 release
+ Revision 1.5 1998/12/31 01:04:16 ivan doc
+
+    Revision 1.3 1998/11/15 13:00:15 ivan bugfix in clone method,
+    clone method doc clarification
+
index 5349963..fbc141c 100644 (file)
@@ -4,8 +4,8 @@ NAME
 SYNOPSIS
       use FS::part_referral;
 
 SYNOPSIS
       use FS::part_referral;
 
-      $record = create FS::part_referral \%hash
-      $record = create FS::part_referral { 'column' => 'value' };
+      $record = new FS::part_referral \%hash
+      $record = new FS::part_referral { 'column' => 'value' };
 
       $error = $record->insert;
 
 
       $error = $record->insert;
 
@@ -25,7 +25,7 @@ DESCRIPTION
     refnum - primary key (assigned automatically for new referrals)
     referral - Text name of this referral
 METHODS
     refnum - primary key (assigned automatically for new referrals)
     referral - Text name of this referral
 METHODS
-    create HASHREF
+    new HASHREF
         Creates a new referral. To add the referral to the database,
         see the section on "insert".
 
         Creates a new referral. To add the referral to the database,
         see the section on "insert".
 
@@ -45,9 +45,10 @@ METHODS
         there is an error, returns the error, otherwise returns
         false. Called by the insert and replace methods.
 
         there is an error, returns the error, otherwise returns
         false. Called by the insert and replace methods.
 
-BUGS
-    It doesn't properly override FS::Record yet.
+VERSION
+    $Id: part_referral.txt,v 1.3 1999-04-08 13:39:32 ivan Exp $
 
 
+BUGS
     The delete method is unimplemented.
 
 SEE ALSO
     The delete method is unimplemented.
 
 SEE ALSO
@@ -61,3 +62,9 @@ HISTORY
 
     pod ivan@sisd.com 98-sep-21
 
 
     pod ivan@sisd.com 98-sep-21
 
+    $Log: part_referral.txt,v $
+    Revision 1.3  1999-04-08 13:39:32  ivan
+    convert from pod for 1.2.0 release
+ Revision 1.2 1998/12/29 11:59:49 ivan
+    mostly properly OO, some work still to be done with svc_ stuff
+
index 680944e..71af2c4 100644 (file)
@@ -4,8 +4,8 @@ NAME
 SYNOPSIS
       use FS::part_svc;
 
 SYNOPSIS
       use FS::part_svc;
 
-      $record = create FS::part_referral \%hash
-      $record = create FS::part_referral { 'column' => 'value' };
+      $record = new FS::part_referral \%hash
+      $record = new FS::part_referral { 'column' => 'value' };
 
       $error = $record->insert;
 
 
       $error = $record->insert;
 
@@ -27,7 +27,7 @@ DESCRIPTION
     *svcdb*__*field* - Default or fixed value for *field* in *svcdb*.
     *svcdb*__*field*_flag - defines *svcdb*__*field* action: null, `D' for default, or `F' for fixed
 METHODS
     *svcdb*__*field* - Default or fixed value for *field* in *svcdb*.
     *svcdb*__*field*_flag - defines *svcdb*__*field* action: null, `D' for default, or `F' for fixed
 METHODS
-    create HASHREF
+    new HASHREF
         Creates a new service definition. To add the service
         definition to the database, see the section on "insert".
 
         Creates a new service definition. To add the service
         definition to the database, see the section on "insert".
 
@@ -48,11 +48,15 @@ METHODS
         otherwise returns false. Called by the insert and replace
         methods.
 
         otherwise returns false. Called by the insert and replace
         methods.
 
-BUGS
-    It doesn't properly override FS::Record yet.
+VERSION
+    $Id: part_svc.txt,v 1.3 1999-04-08 13:39:32 ivan Exp $
 
 
+BUGS
     Delete is unimplemented.
 
     Delete is unimplemented.
 
+    The list of svc_* tables is hardcoded. When svc_acct_pop is
+    renamed, this should be fixed.
+
 SEE ALSO
     the FS::Record manpage, the FS::part_pkg manpage, the
     FS::pkg_svc manpage, the FS::cust_svc manpage, the FS::svc_acct
 SEE ALSO
     the FS::Record manpage, the FS::part_pkg manpage, the
     FS::pkg_svc manpage, the FS::cust_svc manpage, the FS::svc_acct
@@ -67,3 +71,12 @@ HISTORY
 
     pod ivan@sisd.com 98-sep-21
 
 
     pod ivan@sisd.com 98-sep-21
 
+    $Log: part_svc.txt,v $
+    Revision 1.3  1999-04-08 13:39:32  ivan
+    convert from pod for 1.2.0 release
+ Revision 1.3 1999/02/07 09:59:44 ivan more
+    mod_perl fixes, and bugfixes Peter Wemm sent via email
+
+    Revision 1.2 1998/12/29 11:59:50 ivan mostly properly OO, some
+    work still to be done with svc_ stuff
+
index bde0043..d921642 100644 (file)
@@ -4,8 +4,8 @@ NAME
 SYNOPSIS
       use FS::pkg_svc;
 
 SYNOPSIS
       use FS::pkg_svc;
 
-      $record = create FS::pkg_svc \%hash;
-      $record = create FS::pkg_svc { 'column' => 'value' };
+      $record = new FS::pkg_svc \%hash;
+      $record = new FS::pkg_svc { 'column' => 'value' };
 
       $error = $record->insert;
 
 
       $error = $record->insert;
 
@@ -26,7 +26,7 @@ DESCRIPTION
     quantity - Quantity of this service definition that this billing item
     definition includes
 METHODS
     quantity - Quantity of this service definition that this billing item
     definition includes
 METHODS
-    create HASHREF
+    new HASHREF
         Create a new record. To add the record to the database, see
         the section on "insert".
 
         Create a new record. To add the record to the database, see
         the section on "insert".
 
@@ -47,9 +47,10 @@ METHODS
         there is an error, returns the error, otherwise returns
         false. Called by the insert and replace methods.
 
         there is an error, returns the error, otherwise returns
         false. Called by the insert and replace methods.
 
-BUGS
-    It doesn't properly override FS::Record yet.
+VERSION
+    $Id: pkg_svc.txt,v 1.3 1999-04-08 13:39:32 ivan Exp $
 
 
+BUGS
 SEE ALSO
     the FS::Record manpage, the FS::part_pkg manpage, the
     FS::part_svc manpage, schema.html from the base documentation.
 SEE ALSO
     the FS::Record manpage, the FS::part_pkg manpage, the
     FS::part_svc manpage, schema.html from the base documentation.
@@ -59,3 +60,13 @@ HISTORY
 
     pod ivan@sisd.com 98-sep-22
 
 
     pod ivan@sisd.com 98-sep-22
 
+    $Log: pkg_svc.txt,v $
+    Revision 1.3  1999-04-08 13:39:32  ivan
+    convert from pod for 1.2.0 release
+ Revision 1.3 1999/01/18 21:58:08 ivan
+    esthetic: eq and ne were used in a few places instead of == and
+    !=
+
+    Revision 1.2 1998/12/29 11:59:51 ivan mostly properly OO, some
+    work still to be done with svc_ stuff
+
index 4c4e8e2..f27c1d6 100644 (file)
@@ -4,8 +4,8 @@ NAME
 SYNOPSIS
       use FS::svc_acct;
 
 SYNOPSIS
       use FS::svc_acct;
 
-      $record = create FS::svc_acct \%hash;
-      $record = create FS::svc_acct { 'column' => 'value' };
+      $record = new FS::svc_acct \%hash;
+      $record = new FS::svc_acct { 'column' => 'value' };
 
       $error = $record->insert;
 
 
       $error = $record->insert;
 
@@ -23,7 +23,7 @@ SYNOPSIS
 
 DESCRIPTION
     An FS::svc_acct object represents an account. FS::svc_acct
 
 DESCRIPTION
     An FS::svc_acct object represents an account. FS::svc_acct
-    inherits from FS::Record. The following fields are currently
+    inherits from FS::svc_Common. The following fields are currently
     supported:
 
     svcnum - primary key (assigned automatcially for new accounts)
     supported:
 
     svcnum - primary key (assigned automatcially for new accounts)
@@ -39,7 +39,7 @@ DESCRIPTION
     slipip - IP address
     radius_*Radius_Attribute* - *Radius-Attribute*
 METHODS
     slipip - IP address
     radius_*Radius_Attribute* - *Radius-Attribute*
 METHODS
-    create HASHREF
+    new HASHREF
         Creates a new account. To add the account to the database,
         see the section on "insert".
 
         Creates a new account. To add the account to the database,
         see the section on "insert".
 
@@ -126,19 +126,22 @@ METHODS
 
         Sets any fixed values; see the FS::part_svc manpage.
 
 
         Sets any fixed values; see the FS::part_svc manpage.
 
-BUGS
-    It doesn't properly override FS::Record yet.
+VERSION
+    $Id: svc_acct.txt,v 1.3 1999-02-09 09:38:11 ivan Exp $
 
 
+BUGS
     The remote commands should be configurable.
 
     The remote commands should be configurable.
 
-    The create method should set defaults from part_svc (like the
-    check method sets fixed values).
+    The bits which ssh should fork before doing so.
+
+    The $recref stuff in sub check should be cleaned up.
 
 SEE ALSO
 
 SEE ALSO
-    the FS::Record manpage, the FS::Conf manpage, the FS::cust_svc
-    manpage, the FS::part_svc manpage, the FS::cust_pkg manpage, the
-    FS::SSH manpage, the ssh manpage, the FS::svc_acct_pop manpage,
-    schema.html from the base documentation.
+    the FS::svc_Common manpage, the FS::Record manpage, the FS::Conf
+    manpage, the FS::cust_svc manpage, the FS::part_svc manpage, the
+    FS::cust_pkg manpage, the FS::SSH manpage, the ssh manpage, the
+    FS::svc_acct_pop manpage, schema.html from the base
+    documentation.
 
 HISTORY
     ivan@voicenet.com 97-jul-16 - 21
 
 HISTORY
     ivan@voicenet.com 97-jul-16 - 21
@@ -167,8 +170,18 @@ HISTORY
     pod and FS::conf ivan@sisd.com 98-sep-22
 
     $Log: svc_acct.txt,v $
     pod and FS::conf ivan@sisd.com 98-sep-22
 
     $Log: svc_acct.txt,v $
-    Revision 1.2  1998-11-13 09:56:44  ivan
-    change configuration file layout to support multiple distinct databases (with
-    own set of config files, export, etc.)
+    Revision 1.3  1999-02-09 09:38:11  ivan
+    regenerated perl api docs from embedded pod
+ Revision 1.6 1999/01/25 12:26:15 ivan yet
+    more mod_perl stuff
+
+    Revision 1.5 1999/01/18 21:58:09 ivan esthetic: eq and ne were
+    used in a few places instead of == and !=
+
+    Revision 1.4 1998/12/30 00:30:45 ivan svc_ stuff is more
+    properly OO - has a common superclass FS::svc_Common
 
 
+    Revision 1.2 1998/11/13 09:56:55 ivan change configuration file
+    layout to support multiple distinct databases (with own set of
+    config files, export, etc.)
 
 
index ac09654..e8629fd 100644 (file)
@@ -4,8 +4,8 @@ NAME
 SYNOPSIS
       use FS::svc_acct_pop;
 
 SYNOPSIS
       use FS::svc_acct_pop;
 
-      $record = create FS::svc_acct_pop \%hash;
-      $record = create FS::svc_acct_pop { 'column' => 'value' };
+      $record = new FS::svc_acct_pop \%hash;
+      $record = new FS::svc_acct_pop { 'column' => 'value' };
 
       $error = $record->insert;
 
 
       $error = $record->insert;
 
@@ -26,17 +26,17 @@ DESCRIPTION
     ac - area code
     exch - exchange
 METHODS
     ac - area code
     exch - exchange
 METHODS
-    create HASHREF
+    new HASHREF
         Creates a new point of presence (if only it were that
         easy!). To add the point of presence to the database, see
         the section on "insert".
 
     insert
         Creates a new point of presence (if only it were that
         easy!). To add the point of presence to the database, see
         the section on "insert".
 
     insert
-        Adds this point of presence to the databaes. If there is an
+        Adds this point of presence to the database. If there is an
         error, returns the error, otherwise returns false.
 
     delete
         error, returns the error, otherwise returns false.
 
     delete
-        Currently unimplemented.
+        Removes this point of presence from the database.
 
     replace OLD_RECORD
         Replaces OLD_RECORD with this one in the database. If there
 
     replace OLD_RECORD
         Replaces OLD_RECORD with this one in the database. If there
@@ -47,9 +47,10 @@ METHODS
         presence. If there is an error, returns the error, otherwise
         returns false. Called by the insert and replace methods.
 
         presence. If there is an error, returns the error, otherwise
         returns false. Called by the insert and replace methods.
 
-BUGS
-    It doesn't properly override FS::Record yet.
+VERSION
+    $Id: svc_acct_pop.txt,v 1.3 1999-04-08 13:39:32 ivan Exp $
 
 
+BUGS
     It should be renamed to part_pop.
 
 SEE ALSO
     It should be renamed to part_pop.
 
 SEE ALSO
@@ -63,3 +64,9 @@ HISTORY
 
     pod ivan@sisd.com 98-sep-23
 
 
     pod ivan@sisd.com 98-sep-23
 
+    $Log: svc_acct_pop.txt,v $
+    Revision 1.3  1999-04-08 13:39:32  ivan
+    convert from pod for 1.2.0 release
+ Revision 1.2 1998/12/29 11:59:53 ivan
+    mostly properly OO, some work still to be done with svc_ stuff
+
index e9940af..f260d9f 100644 (file)
@@ -4,8 +4,8 @@ NAME
 SYNOPSIS
       use FS::svc_acct_sm;
 
 SYNOPSIS
       use FS::svc_acct_sm;
 
-      $record = create FS::svc_acct_sm \%hash;
-      $record = create FS::svc_acct_sm { 'column' => 'value' };
+      $record = new FS::svc_acct_sm \%hash;
+      $record = new FS::svc_acct_sm { 'column' => 'value' };
 
       $error = $record->insert;
 
 
       $error = $record->insert;
 
@@ -31,7 +31,7 @@ DESCRIPTION
     domuid - uid of the target account (see the FS::svc_acct manpage)
     domuser - virtual username
 METHODS
     domuid - uid of the target account (see the FS::svc_acct manpage)
     domuser - virtual username
 METHODS
-    create HASHREF
+    new HASHREF
         Creates a new virtual mail alias. To add the virtual mail
         alias to the database, see the section on "insert".
 
         Creates a new virtual mail alias. To add the virtual mail
         alias to the database, see the section on "insert".
 
@@ -93,11 +93,14 @@ METHODS
 
         Sets any fixed values; see the FS::part_svc manpage.
 
 
         Sets any fixed values; see the FS::part_svc manpage.
 
-BUGS
-    It doesn't properly override FS::Record yet.
+VERSION
+    $Id: svc_acct_sm.txt,v 1.2 1999-02-09 09:38:13 ivan Exp $
 
 
+BUGS
     The remote commands should be configurable.
 
     The remote commands should be configurable.
 
+    The $recref stuff in sub check should be cleaned up.
+
 SEE ALSO
     the FS::Record manpage, the FS::Conf manpage, the FS::cust_svc
     manpage, the FS::part_svc manpage, the FS::cust_pkg manpage, the
 SEE ALSO
     the FS::Record manpage, the FS::Conf manpage, the FS::cust_svc
     manpage, the FS::part_svc manpage, the FS::cust_pkg manpage, the
index da8c060..bc69535 100644 (file)
@@ -4,8 +4,8 @@ NAME
 SYNOPSIS
       use FS::svc_domain;
 
 SYNOPSIS
       use FS::svc_domain;
 
-      $record = create FS::svc_domain \%hash;
-      $record = create FS::svc_domain { 'column' => 'value' };
+      $record = new FS::svc_domain \%hash;
+      $record = new FS::svc_domain { 'column' => 'value' };
 
       $error = $record->insert;
 
 
       $error = $record->insert;
 
@@ -23,13 +23,13 @@ SYNOPSIS
 
 DESCRIPTION
     An FS::svc_domain object represents a domain. FS::svc_domain
 
 DESCRIPTION
     An FS::svc_domain object represents a domain. FS::svc_domain
-    inherits from FS::Record. The following fields are currently
+    inherits from FS::svc_Common. The following fields are currently
     supported:
 
     svcnum - primary key (assigned automatically for new accounts)
     domain
 METHODS
     supported:
 
     svcnum - primary key (assigned automatically for new accounts)
     domain
 METHODS
-    create HASHREF
+    new HASHREF
         Creates a new domain. To add the domain to the database, see
         the section on "insert".
 
         Creates a new domain. To add the domain to the database, see
         the section on "insert".
 
@@ -103,26 +103,26 @@ METHODS
     submit_internic
         Submits a registration email for this domain.
 
     submit_internic
         Submits a registration email for this domain.
 
-BUGS
-    It doesn't properly override FS::Record yet.
+VERSION
+    $Id: svc_domain.txt,v 1.3 1999-02-09 09:38:14 ivan Exp $
 
 
+BUGS
     All BIND/DNS fields should be included (and exported).
 
     All BIND/DNS fields should be included (and exported).
 
-    All registries should be supported.
+    Delete doesn't send a registration template.
 
 
-    Not all configuration access is through FS::Conf!
+    All registries should be supported.
 
     Should change action to a real field.
 
 
     Should change action to a real field.
 
-SEE ALSO
-    the FS::Record manpage, the FS::Conf manpage, the FS::cust_svc
-    manpage, the FS::part_svc manpage, the FS::cust_pkg manpage, the
-    FS::SSH manpage, the ssh manpage, the dot-qmail manpage,
-    schema.html from the base documentation, config.html from the
-    base documentation.
+    The $recref stuff in sub check should be cleaned up.
 
 
-VERSION
-    $Id: svc_domain.txt,v 1.2 1998-11-13 09:56:45 ivan Exp $
+SEE ALSO
+    the FS::svc_Common manpage, the FS::Record manpage, the FS::Conf
+    manpage, the FS::cust_svc manpage, the FS::part_svc manpage, the
+    FS::cust_pkg manpage, the FS::SSH manpage, the ssh manpage, the
+    dot-qmail manpage, schema.html from the base documentation,
+    config.html from the base documentation.
 
 HISTORY
     ivan@voicenet.com 97-jul-21
 
 HISTORY
     ivan@voicenet.com 97-jul-21
@@ -140,10 +140,18 @@ HISTORY
     pod, some FS::Conf (not complete) ivan@sisd.com 98-sep-23
 
     $Log: svc_domain.txt,v $
     pod, some FS::Conf (not complete) ivan@sisd.com 98-sep-23
 
     $Log: svc_domain.txt,v $
-    Revision 1.2  1998-11-13 09:56:45  ivan
-    change configuration file layout to support multiple distinct databases (with
-    own set of config files, export, etc.)
- Revision 1.2 1998/10/14 08:18:21 ivan
-    More informative error messages and better doc for admin contact
-    email stuff
+    Revision 1.3  1999-02-09 09:38:14  ivan
+    regenerated perl api docs from embedded pod
+ Revision 1.6 1999/01/25 12:26:17 ivan
+    yet more mod_perl stuff
+
+    Revision 1.5 1998/12/30 00:30:47 ivan svc_ stuff is more
+    properly OO - has a common superclass FS::svc_Common
+
+    Revision 1.3 1998/11/13 09:56:57 ivan change configuration file
+    layout to support multiple distinct databases (with own set of
+    config files, export, etc.)
+
+    Revision 1.2 1998/10/14 08:18:21 ivan More informative error
+    messages and better doc for admin contact email stuff
 
 
index 9822b48..f575e20 100644 (file)
@@ -4,8 +4,8 @@ NAME
 SYNOPSIS
       use FS::type_pkgs;
 
 SYNOPSIS
       use FS::type_pkgs;
 
-      $record = create FS::type_pkgs \%hash;
-      $record = create FS::type_pkgs { 'column' => 'value' };
+      $record = new FS::type_pkgs \%hash;
+      $record = new FS::type_pkgs { 'column' => 'value' };
 
       $error = $record->insert;
 
 
       $error = $record->insert;
 
@@ -24,7 +24,7 @@ DESCRIPTION
     typenum - Agent type, see the FS::agent_type manpage
     pkgpart - Billing item definition, see the FS::part_pkg manpage
 METHODS
     typenum - Agent type, see the FS::agent_type manpage
     pkgpart - Billing item definition, see the FS::part_pkg manpage
 METHODS
-    create HASHREF
+    new HASHREF
         Create a new record. To add the record to the database, see
         the section on "insert".
 
         Create a new record. To add the record to the database, see
         the section on "insert".
 
@@ -45,6 +45,14 @@ METHODS
         there is an error, returns the error, otherwise returns
         false. Called by the insert and replace methods.
 
         there is an error, returns the error, otherwise returns
         false. Called by the insert and replace methods.
 
+VERSION
+    $Id: type_pkgs.txt,v 1.3 1999-04-08 13:39:32 ivan Exp $
+
+BUGS
+SEE ALSO
+    the FS::Record manpage, the FS::agent_type manpage, the
+    FS::part_pkgs manpage, schema.html from the base documentation.
+
 HISTORY
     Defines the relation between agent types and pkgparts (Which
     pkgparts can the different [types of] agents sell?)
 HISTORY
     Defines the relation between agent types and pkgparts (Which
     pkgparts can the different [types of] agents sell?)
@@ -53,3 +61,9 @@ HISTORY
 
     change to ut_ FS::Record, fixed bugs ivan@sisd.com 97-dec-10
 
 
     change to ut_ FS::Record, fixed bugs ivan@sisd.com 97-dec-10
 
+    $Log: type_pkgs.txt,v $
+    Revision 1.3  1999-04-08 13:39:32  ivan
+    convert from pod for 1.2.0 release
+ Revision 1.2 1998/12/29 11:59:58 ivan
+    mostly properly OO, some work still to be done with svc_ stuff
+