From: ivan Date: Thu, 8 Apr 1999 13:39:32 +0000 (+0000) Subject: convert from pod for 1.2.0 release X-Git-Tag: freeside_1_2_0~11 X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=commitdiff_plain;h=991f8f1fd45bb229c3d2d28abae7356d94534a03 convert from pod for 1.2.0 release --- diff --git a/htdocs/docs/man/Conf.txt b/htdocs/docs/man/Conf.txt index 816df7995..01b7cf5e6 100644 --- a/htdocs/docs/man/Conf.txt +++ b/htdocs/docs/man/Conf.txt @@ -47,8 +47,11 @@ HISTORY sub exists forgot to fetch $dir ivan@sisd.com 98-sep-27 $Log: Conf.txt,v $ - Revision 1.4 1999-02-09 09:37:48 ivan - regenerated perl api docs from embedded pod - Revision 1.2 1998/11/13 04:08:44 ivan no - default default_dir (ironic) + Revision 1.5 1999-04-08 13:39:31 ivan + convert from pod for 1.2.0 release + Revision 1.3 1999/03/29 01:29:33 ivan die + unless the configuration directory exists + + Revision 1.2 1998/11/13 04:08:44 ivan no default default_dir + (ironic) diff --git a/htdocs/docs/man/Record.txt b/htdocs/docs/man/Record.txt index e1902fee8..1708e3c67 100644 --- a/htdocs/docs/man/Record.txt +++ b/htdocs/docs/man/Record.txt @@ -233,7 +233,7 @@ SUBROUTINES record's table set true. VERSION - $Id: Record.txt,v 1.4 1999-02-09 09:37:51 ivan Exp $ + $Id: Record.txt,v 1.5 1999-04-08 13:39:31 ivan Exp $ BUGS This module should probably be renamed, since much of the @@ -360,10 +360,21 @@ HISTORY ut_phonen got ''; at the end ivan@sisd.com 98-sep-27 $Log: Record.txt,v $ - 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.5 1999-04-08 13:39:31 ivan + convert from pod for 1.2.0 release + Revision 1.15 1999/04/08 12:08:59 ivan + fix up PostgreSQL money fields so you can actually use them + as numbers. bah. + + Revision 1.14 1999/04/07 14:58:31 ivan more kludges to get + around different null/empty handling in Perl vs. MySQL vs. + PostgreSQL etc. + + Revision 1.13 1999/03/29 11:55:43 ivan eliminate warnings in + ut_money + + 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 diff --git a/htdocs/docs/man/UID.txt b/htdocs/docs/man/UID.txt index 7c4b1abc5..efe3b6670 100644 --- a/htdocs/docs/man/UID.txt +++ b/htdocs/docs/man/UID.txt @@ -70,7 +70,7 @@ CALLBACKS $FS::UID::callback{'Package::Name'}; VERSION - $Id: UID.txt,v 1.3 1999-02-09 09:37:52 ivan Exp $ + $Id: UID.txt,v 1.4 1999-04-08 13:39:31 ivan Exp $ BUGS Too many package-global variables. @@ -114,10 +114,13 @@ HISTORY inlined suidsetup ivan@sisd.com 98-sep-12 $Log: UID.txt,v $ - 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.4 1999-04-08 13:39:31 ivan + convert from pod for 1.2.0 release + Revision 1.8 1999/02/23 07:23:23 ivan oops, + don't comment out &swapuid in &adminsuidsetup! + + 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 diff --git a/htdocs/docs/man/cust_bill.txt b/htdocs/docs/man/cust_bill.txt index 9780ca7c6..c11840117 100644 --- a/htdocs/docs/man/cust_bill.txt +++ b/htdocs/docs/man/cust_bill.txt @@ -106,7 +106,7 @@ METHODS Date::Parse manpage for conversion functions. VERSION - $Id: cust_bill.txt,v 1.3 1999-02-09 09:37:55 ivan Exp $ + $Id: cust_bill.txt,v 1.4 1999-04-08 13:39:31 ivan Exp $ BUGS The delete method. @@ -134,10 +134,13 @@ HISTORY pod, ingegrate with FS::Invoice ivan@sisd.com 98-sep-20 $Log: cust_bill.txt,v $ - 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.4 1999-04-08 13:39:31 ivan + convert from pod for 1.2.0 release + Revision 1.7 1999/02/09 09:55:05 ivan + invoices show line items for each service in a package (see the + label method of FS::cust_svc) + + 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 != diff --git a/htdocs/docs/man/cust_main.txt b/htdocs/docs/man/cust_main.txt index 707cf956b..bef2b9d94 100644 --- a/htdocs/docs/man/cust_main.txt +++ b/htdocs/docs/man/cust_main.txt @@ -172,7 +172,7 @@ METHODS error, otherwise returns false. VERSION - $Id: cust_main.txt,v 1.3 1999-02-09 09:37:58 ivan Exp $ + $Id: cust_main.txt,v 1.4 1999-04-08 13:39:32 ivan Exp $ BUGS The delete method. @@ -227,10 +227,29 @@ HISTORY FS::UID::{datasrc,checkruid} ivan@sisd.com 98-sep-19-21 $Log: cust_main.txt,v $ - 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.4 1999-04-08 13:39:32 ivan + convert from pod for 1.2.0 release + Revision 1.16 1999/04/07 14:32:19 ivan + more &invoicing_list logic to skip searches when there is no + custnum + + Revision 1.15 1999/04/07 13:41:54 ivan in &invoicing_list, don't + search if there's no custnum yet + + Revision 1.14 1999/03/29 12:06:15 ivan buglet in email invoices + fixed + + Revision 1.13 1999/02/28 20:09:03 ivan allow spaces in zip + codes, for (at least) canada. pointed out by Clayton Gray + + + Revision 1.12 1999/02/27 21:24:22 ivan parse paydate correctly + for cybercash + + Revision 1.11 1999/02/23 08:09:27 ivan beginnings of one-screen + new customer entry and some other miscellania + + 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 diff --git a/htdocs/docs/man/cust_main_invoice.txt b/htdocs/docs/man/cust_main_invoice.txt new file mode 100644 index 000000000..5d50a9f26 --- /dev/null +++ b/htdocs/docs/man/cust_main_invoice.txt @@ -0,0 +1,98 @@ +NAME + FS::cust_main_invoice - Object methods for cust_main_invoice + records + +SYNOPSIS + use FS::cust_main_invoice; + + $record = new FS::cust_main_invoice \%hash; + $record = new FS::cust_main_invoice { 'column' => 'value' }; + + $error = $record->insert; + + $error = $new_record->replace($old_record); + + $error = $record->delete; + + $error = $record->check; + + $email_address = $record->address; + +DESCRIPTION + An FS::cust_main_invoice object represents an invoice + destination. FS::cust_main_invoice inherits from FS::Record. The + following fields are currently supported: + + destnum - primary key + custnum - customer (see the FS::cust_main manpage) + dest - Invoice destination: If numeric, a svcnum, if string, a literal email address, or `POST' to enable mailing (the default if no cust_main_invoice records exist) +METHODS + new HASHREF + Creates a new invoice destination. To add the invoice + destination to the database, see the section on "insert". + + Note that this stores the hash reference, not a distinct + copy of the hash it points to. You can ask the object for a + copy with the *hash* method. + + insert + Adds this record to the database. If there is an error, + returns the error, otherwise returns false. + + delete + Delete this record from the database. + + replace OLD_RECORD + Replaces the OLD_RECORD with this one in the database. If + there is an error, returns the error, otherwise returns + false. + + check + Checks all fields to make sure this is a valid invoice + destination. If there is an error, returns the error, + otherwise returns false. Called by the insert and repalce + methods. + + checkdest + Checks the dest field only. + + address + Returns the literal email address for this record (or + `POST'). + +VERSION + $Id: cust_main_invoice.txt,v 1.1 1999-04-08 13:39:32 ivan Exp $ + +BUGS +SEE ALSO + the FS::Record manpage, the FS::cust_main manpage + +HISTORY + ivan@voicenet.com 97-jul-1 + + added hfields ivan@sisd.com 97-nov-13 + + $Log: cust_main_invoice.txt,v $ + Revision 1.1 1999-04-08 13:39:32 ivan + convert from pod for 1.2.0 release + Revision 1.6 1999/01/25 12:26:10 + ivan yet more mod_perl stuff + + Revision 1.5 1999/01/18 21:58:05 ivan esthetic: eq and ne were + used in a few places instead of == and != + + Revision 1.4 1999/01/18 09:22:42 ivan changes to track email + addresses for email invoicing + + Revision 1.3 1998/12/29 11:59:42 ivan mostly properly OO, some + work still to be done with svc_ stuff + + Revision 1.2 1998/12/16 09:58:53 ivan library support for + editing email invoice destinations (not in sub collect yet) + + Revision 1.1 1998/12/16 07:40:02 ivan new table + + Revision 1.3 1998/11/15 04:33:00 ivan updates for newest versoin + + Revision 1.2 1998/11/15 03:48:49 ivan update for current version + diff --git a/htdocs/docs/man/cust_pay_batch.txt b/htdocs/docs/man/cust_pay_batch.txt new file mode 100644 index 000000000..2d6267843 --- /dev/null +++ b/htdocs/docs/man/cust_pay_batch.txt @@ -0,0 +1,96 @@ +NAME + FS::cust_pay_batch - Object methods for batch cards + +SYNOPSIS + use FS::cust_pay_batch; + + $record = new FS::cust_pay_batch \%hash; + $record = new FS::cust_pay_batch { 'column' => 'value' }; + + $error = $record->insert; + + $error = $new_record->replace($old_record); + + $error = $record->delete; + + $error = $record->check; + +DESCRIPTION + An FS::cust_pay_batch object represents a credit card + transaction ready to be batched (sent to a processor). + FS::cust_pay_batch inherits from FS::Record. Typically called by + the collect method of an FS::cust_main object. The following + fields are currently supported: + + trancode - 77 for charges + cardnum + exp - card expiration + amount + invnum - invoice + custnum - customer + payname - name on card + first - name + last - name + address1 + address2 + city + state + zip + country +METHODS + new HASHREF + Creates a new record. To add the record to the database, see + the section on "insert". + + Note that this stores the hash reference, not a distinct + copy of the hash it points to. You can ask the object for a + copy with the *hash* method. + + insert + Adds this record to the database. If there is an error, + returns the error, otherwise returns false. + + delete + Delete this record from the database. If there is an error, + returns the error, otherwise returns false. + + replace OLD_RECORD + #inactive # #Replaces the OLD_RECORD with this one in the + database. If there is an error, #returns the error, + otherwise returns false. + + check + Checks all fields to make sure this is a valid transaction. + If there is an error, returns the error, otherwise returns + false. Called by the insert and repalce methods. + +VERSION + $Id: cust_pay_batch.txt,v 1.1 1999-04-08 13:39:32 ivan Exp $ + +BUGS + There should probably be a configuration file with a list of + allowed credit card types. + +SEE ALSO + the FS::cust_main manpage, the FS::Record manpage + +HISTORY + ivan@voicenet.com 97-jul-1 + + added hfields ivan@sisd.com 97-nov-13 + + $Log: cust_pay_batch.txt,v $ + Revision 1.1 1999-04-08 13:39:32 ivan + convert from pod for 1.2.0 release + Revision 1.3 1998/12/29 11:59:44 + ivan mostly properly OO, some work still to be done with svc_ + stuff + + Revision 1.2 1998/11/18 09:01:44 ivan i18n! i18n! + + Revision 1.1 1998/11/15 05:19:58 ivan long overdue + + Revision 1.3 1998/11/15 04:33:00 ivan updates for newest versoin + + Revision 1.2 1998/11/15 03:48:49 ivan update for current version + diff --git a/htdocs/docs/man/cust_pkg.txt b/htdocs/docs/man/cust_pkg.txt index 7486456fe..395403192 100644 --- a/htdocs/docs/man/cust_pkg.txt +++ b/htdocs/docs/man/cust_pkg.txt @@ -57,6 +57,21 @@ METHODS If there is an error, returns the error, otherwise returns false. + sub insert { my $self = shift; + + # custnum might not have have been defined in sub check (for one-shot new + # customers), so check it here instead + + my $error = $self->ut_number('custnum'); + return $error if $error + + return "Unknown customer" + unless qsearchs( 'cust_main', { 'custnum' => $self->custnum } ); + + $self->SUPER::insert; + + } + delete Currently unimplemented. You don't want to delete billing items, because there would then be no record the customer @@ -135,7 +150,7 @@ SUBROUTINES FS::pkg_svc manpage). VERSION - $Id: cust_pkg.txt,v 1.3 1999-02-09 09:38:01 ivan Exp $ + $Id: cust_pkg.txt,v 1.4 1999-04-08 13:39:32 ivan Exp $ BUGS sub order is not OO. Perhaps it should be moved to FS::cust_main @@ -169,10 +184,20 @@ HISTORY pod ivan@sisd.com 98-sep-21 $Log: cust_pkg.txt,v $ - 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.4 1999-04-08 13:39:32 ivan + convert from pod for 1.2.0 release + Revision 1.9 1999/03/29 01:11:51 ivan use + FS::type_pkgs + + Revision 1.8 1999/03/25 13:48:14 ivan allow empty custnum in sub + check (but call that an error in sub insert), for one-screen new + customer entry + + Revision 1.7 1999/02/09 09:55:06 ivan invoices show line items + for each service in a package (see the label method of + FS::cust_svc) + + 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 != diff --git a/htdocs/docs/man/index.html b/htdocs/docs/man/index.html index c3307e868..79fda2e04 100644 --- a/htdocs/docs/man/index.html +++ b/htdocs/docs/man/index.html @@ -13,6 +13,7 @@
  • FS::cust_main_county
  • FS::cust_main_invoice
  • FS::cust_pay +
  • FS::cust_pay_batch
  • FS::cust_pkg
  • FS::cust_refund
  • FS::cust_svc diff --git a/htdocs/docs/man/svc_Common.txt b/htdocs/docs/man/svc_Common.txt new file mode 100644 index 000000000..d63b8f245 --- /dev/null +++ b/htdocs/docs/man/svc_Common.txt @@ -0,0 +1,75 @@ +NAME + FS::svc_Common - Object method for all svc_ records + +SYNOPSIS + use FS::svc_Common; + + @ISA = qw( FS::svc_Common ); + +DESCRIPTION + FS::svc_Common is intended as a base class for table-specific + classes to inherit from, i.e. FS::svc_acct. FS::svc_Common + inherits from FS::Record. + +METHODS + insert + Adds this record to the database. If there is an error, + returns the error, otherwise returns false. + + The additional fields pkgnum and svcpart (see the + FS::cust_svc manpage) should be defined. An FS::cust_svc + record will be created and inserted. + + delete + Deletes this account from the database. If there is an + error, returns the error, otherwise returns false. + + The corresponding FS::cust_svc record will be deleted as + well. + + setfixed + Sets any fixed fields for this service (see the FS::part_svc + manpage). If there is an error, returns the error, otherwise + returns the FS::part_svc object (use ref() to test the + return). Usually called by the check method. + + setdefault + Sets all fields to their defaults (see the FS::part_svc + manpage), overriding their current values. If there is an + error, returns the error, otherwise returns the FS::part_svc + object (use ref() to test the return). + + suspend + unsuspend + cancel + Stubs - return false (no error) so derived classes don't + need to define these methods. Called by the cancel method of + FS::cust_pkg (see the FS::cust_pkg manpage). + +VERSION + $Id: svc_Common.txt,v 1.1 1999-04-08 13:39:32 ivan Exp $ + +BUGS + The setfixed method return value. + + The new method should set defaults from part_svc (like the check + method sets fixed values)? + +SEE ALSO + the FS::Record manpage, the FS::cust_svc manpage, the + FS::part_svc manpage, the FS::cust_pkg manpage, schema.html from + the base documentation. + +HISTORY + $Log: svc_Common.txt,v $ + Revision 1.1 1999-04-08 13:39:32 ivan + convert from pod for 1.2.0 release + Revision 1.3 1999/03/25 13:31:29 ivan + added setdefault method (generalized setfixed method to setx + method) + + Revision 1.2 1999/01/25 12:26:14 ivan yet more mod_perl stuff + + Revision 1.1 1998/12/30 00:30:45 ivan svc_ stuff is more + properly OO - has a common superclass FS::svc_Common + diff --git a/htdocs/docs/man/svc_acct.txt b/htdocs/docs/man/svc_acct.txt index f27c1d653..7eb5be47b 100644 --- a/htdocs/docs/man/svc_acct.txt +++ b/htdocs/docs/man/svc_acct.txt @@ -127,7 +127,7 @@ METHODS Sets any fixed values; see the FS::part_svc manpage. VERSION - $Id: svc_acct.txt,v 1.3 1999-02-09 09:38:11 ivan Exp $ + $Id: svc_acct.txt,v 1.4 1999-04-08 13:39:32 ivan Exp $ BUGS The remote commands should be configurable. @@ -170,10 +170,12 @@ HISTORY pod and FS::conf ivan@sisd.com 98-sep-22 $Log: svc_acct.txt,v $ - 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.4 1999-04-08 13:39:32 ivan + convert from pod for 1.2.0 release + Revision 1.7 1999/04/07 14:37:37 ivan use + FS::part_svc and FS::svc_acct_pop to avoid warnings + + 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 != diff --git a/htdocs/docs/man/svc_acct_sm.txt b/htdocs/docs/man/svc_acct_sm.txt index f260d9f75..dc0773f0f 100644 --- a/htdocs/docs/man/svc_acct_sm.txt +++ b/htdocs/docs/man/svc_acct_sm.txt @@ -94,7 +94,7 @@ METHODS Sets any fixed values; see the FS::part_svc manpage. VERSION - $Id: svc_acct_sm.txt,v 1.2 1999-02-09 09:38:13 ivan Exp $ + $Id: svc_acct_sm.txt,v 1.3 1999-04-08 13:39:32 ivan Exp $ BUGS The remote commands should be configurable. diff --git a/htdocs/docs/man/svc_domain.txt b/htdocs/docs/man/svc_domain.txt index bc69535a0..939a940ac 100644 --- a/htdocs/docs/man/svc_domain.txt +++ b/htdocs/docs/man/svc_domain.txt @@ -104,7 +104,7 @@ METHODS Submits a registration email for this domain. VERSION - $Id: svc_domain.txt,v 1.3 1999-02-09 09:38:14 ivan Exp $ + $Id: svc_domain.txt,v 1.4 1999-04-08 13:39:32 ivan Exp $ BUGS All BIND/DNS fields should be included (and exported). @@ -140,10 +140,12 @@ HISTORY pod, some FS::Conf (not complete) ivan@sisd.com 98-sep-23 $Log: svc_domain.txt,v $ - 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.4 1999-04-08 13:39:32 ivan + convert from pod for 1.2.0 release + Revision 1.7 1999/04/07 14:40:15 ivan + use all stuff that's qsearch'ed to avoid warnings + + 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