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/CGI.html | 5 + httemplate/docs/man/FS/Conf.html | 26 +++- httemplate/docs/man/FS/Record.html | 56 +++++--- httemplate/docs/man/FS/SessionClient.html | 2 +- httemplate/docs/man/FS/SignupClient.html | 193 +++++++++++++------------- httemplate/docs/man/FS/UID.html | 8 +- httemplate/docs/man/FS/cust_bill.html | 37 +++-- httemplate/docs/man/FS/cust_credit.html | 22 ++- httemplate/docs/man/FS/cust_main.html | 174 ++++++++++++++++++++--- httemplate/docs/man/FS/cust_main_invoice.html | 2 +- httemplate/docs/man/FS/cust_pay.html | 27 +++- httemplate/docs/man/FS/cust_pay_batch.html | 4 +- httemplate/docs/man/FS/cust_pkg.html | 56 +++++--- httemplate/docs/man/FS/cust_refund.html | 14 +- httemplate/docs/man/FS/cust_svc.html | 25 +++- httemplate/docs/man/FS/domain_record.html | 14 +- httemplate/docs/man/FS/part_pkg.html | 16 ++- httemplate/docs/man/FS/part_svc.html | 32 +++-- httemplate/docs/man/FS/prepay_credit.html | 14 +- httemplate/docs/man/FS/svc_Common.html | 9 +- httemplate/docs/man/FS/svc_acct.html | 76 ++++++++-- httemplate/docs/man/FS/svc_acct_pop.html | 22 ++- httemplate/docs/man/FS/svc_acct_sm.html | 31 +++-- httemplate/docs/man/FS/svc_domain.html | 19 ++- httemplate/docs/man/FS/svc_www.html | 18 +-- 25 files changed, 628 insertions(+), 274 deletions(-) (limited to 'httemplate/docs/man/FS') diff --git a/httemplate/docs/man/FS/CGI.html b/httemplate/docs/man/FS/CGI.html index 05f7823b4..54a0bf39b 100644 --- a/httemplate/docs/man/FS/CGI.html +++ b/httemplate/docs/man/FS/CGI.html @@ -79,12 +79,17 @@ Returns HTML tag for beginning an (invisible) table.

ntable

This is getting silly. +

small_custview CUSTNUM || CUST_MAIN_OBJECT, COUNTRYDEFAULT
+

+Sheesh. I should just switch to Mason.

BUGS

Not OO.

Not complete.

small_custview sooooo doesn't belong here. i should just switch to Mason.

NAME

FS::Conf - Read access to Freeside configuration values

FS::Conf - Freeside configuration values

SYNOPSIS

@@ -40,10 +40,12 @@ $value = $conf->config('key'); @list = $conf->config('key'); $bool = $conf->exists('key'); +

+  @config_items = $conf->config_items;

DESCRIPTION

Read access to Freeside configuration values. Keys currently map to filenames, +

Read and write Freeside configuration values. Keys currently map to filenames, but this may change in the future.

@@ -66,15 +68,29 @@ Returns the configuration value or values (depending on context) for key.

Returns true if the specified key exists, even if the corresponding value is undefined. +

touch
+

set
+

delete
+

config_items
+

+Returns all of the possible configuration items as FS::ConfItem objects. See +the FS::ConfItem manpage.

BUGS

Write access (with locking) should be implemented.

Write access (touch, set, delete) should be documented.

If this was more than just crud that will never be useful outside Freeside I'd +worry that config_items is freeside-specific and icky.

-    $value = $record->ut_float('column');
-    $value = $record->ut_number('column');
-    $value = $record->ut_numbern('column');
-    $value = $record->ut_money('column');
-    $value = $record->ut_text('column');
-    $value = $record->ut_textn('column');
-    $value = $record->ut_alpha('column');
-    $value = $record->ut_alphan('column');
-    $value = $record->ut_phonen('column');
-    $value = $record->ut_anythingn('column');

+ $error = $record->ut_float('column'); + $error = $record->ut_number('column'); + $error = $record->ut_numbern('column'); + $error = $record->ut_money('column'); + $error = $record->ut_text('column'); + $error = $record->ut_textn('column'); + $error = $record->ut_alpha('column'); + $error = $record->ut_alphan('column'); + $error = $record->ut_phonen('column'); + $error = $record->ut_anything('column'); + $error = $record->ut_name('column');

     $dbdef = reload_dbdef;
     $dbdef = reload_dbdef "/non/standard/filename";
@@ -125,6 +125,14 @@ objects.
 #regular FS::TABLE methods
 #on it.
 
+jsearch TABLE, HASHREF, SELECT, EXTRA_SQL, PRIMARY_TABLE, PRIMARY_KEY

+

+Experimental JOINed search method.  Using this method, you can execute a
+single SELECT spanning multiple tables, and cache the results for subsequent
+method calls.  Interface will almost definately change in an incompatible
+fashion.
+Arguments:
+
 
qsearchs TABLE, HASHREF

 

 Same as qsearch, except that if more than one record matches, it carps but
@@ -266,10 +274,29 @@ Check/untaint ip addresses.  IPv4 only for now.  May be null.
 

 Check/untaint host and domain names.
 
+
ut_name COLUMN

+

+Check/untaint proper names; allows alphanumerics, spaces and the following
+punctuation: , . - '
+May not be null.
+
+
ut_zip COLUMN

+

+Check/untaint zip codes.
+
+
ut_country COLUMN

+

+Check/untaint country codes.  Country names are changed to codes, if possible -
+see the Locale::Country manpage.
+
 
ut_anything COLUMN

 

 Untaints arbitrary data.  Be careful.
 
+
ut_enum COLUMN CHOICES_ARRAYREF

+

+Check/untaint a column, supplying all possible choices, like the ``enum'' type.
+
 
fields [ TABLE ]

 

 This can be used as both a subroutine and a method call.  It returns a list
@@ -303,10 +330,6 @@ This is depriciated.  Don't use it.
 
 
 

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

 BUGS
 This module should probably be renamed, since much of the functionality is
 of general use.  It is not completely unlike Adapter::DBI (see below).
@@ -323,7 +346,7 @@ true maps to the database (and WHERE clauses) would also help.
 A fallback check method should be provided which uses the dbdef.
 The ut_money method assumes money has two decimal digits.
 The Pg money kludge in the new method only strips `$'.
-The ut_phonen method assumes US-style phone numbers.
+The ut_phonen method only checks US-style phone numbers.
 The _quote function should probably use ut_float instead of a regex.
 All the subroutines probably should be methods, here or elsewhere.
 Probably should borrow/use some dbdef methods where appropriate (like sub
@@ -331,6 +354,7 @@ fields)
 As of 1.14, DBI fetchall_hashref( {} ) doesn't set fetchrow_hashref NAME_lc,
 or allow it to be set.  Working around it is ugly any way around - DBI should
 be fixed.  (only affects RDBMS which return uppercase column names)
+ut_zip should take an optional country like ut_phone.
 
 

 SEE ALSO
diff --git a/httemplate/docs/man/FS/SessionClient.html b/httemplate/docs/man/FS/SessionClient.html
index 615f35e0e..0abb2a6a1 100644
--- a/httemplate/docs/man/FS/SessionClient.html
+++ b/httemplate/docs/man/FS/SessionClient.html
@@ -83,7 +83,7 @@ optional, but must be correct if specified.
 
 

 VERSION
-$Id: SessionClient.html,v 1.1 2001-07-30 07:36:03 ivan Exp $
+$Id: SessionClient.html,v 1.3 2002-01-29 17:42:46 ivan Exp $
 
 

 BUGS
diff --git a/httemplate/docs/man/FS/SignupClient.html b/httemplate/docs/man/FS/SignupClient.html
index 844f64f33..3438c804a 100644
--- a/httemplate/docs/man/FS/SignupClient.html
+++ b/httemplate/docs/man/FS/SignupClient.html
@@ -1,124 +1,131 @@
 
 
 FS::SignupClient - Freeside signup client API
-
+
 
 
 
 
+
 
 
 
 
-	NAME
-	
SYNOPSIS
-	
DESCRIPTION
-	
SUBROUTINES
-	
VERSION
-	
BUGS
-	
SEE ALSO
+	
NAME
+	SYNOPSIS
+	DESCRIPTION
+	SUBROUTINES
+	BUGS
+	SEE ALSO
 
 
 
 
 
-
NAME
-
-FS::SignupClient - Freeside signup client API
-
+
NAME
+FS::SignupClient - Freeside signup client API
 
 

-SYNOPSIS
-
-
  use FS::SignupClient qw( signup_info new_customer );
-
-
-
  ( $locales, $packages, $pops ) = signup_info;
-
-
-
  $error = new_customer ( {
-    'first'          => $first,
-    'last'           => $last,
-    'ss'             => $ss,
-    'comapny'        => $company,
-    'address1'       => $address1,
-    'address2'       => $address2,
-    'city'           => $city,
-    'county'         => $county,
-    'state'          => $state,
-    'zip'            => $zip,
-    'country'        => $country,
-    'daytime'        => $daytime,
-    'night'          => $night,
-    'fax'            => $fax,
-    'payby'          => $payby,
-    'payinfo'        => $payinfo,
-    'paydate'        => $paydate,
-    'payname'        => $payname,
-    'invoicing_list' => $invoicing_list,
-    'pkgpart'        => $pkgpart,
-    'username'       => $username,
-    '_password'       => $password,
-    'popnum'         => $popnum,
-  } );
-
+SYNOPSIS
++  use FS::SignupClient qw( signup_info new_customer );
++  ( $locales, $packages, $pops ) = signup_info;
++  $error = new_customer ( {
+    'first'            => $first,
+    'last'             => $last,
+    'ss'               => $ss,
+    'comapny'          => $company,
+    'address1'         => $address1,
+    'address2'         => $address2,
+    'city'             => $city,
+    'county'           => $county,
+    'state'            => $state,
+    'zip'              => $zip,
+    'country'          => $country,
+    'daytime'          => $daytime,
+    'night'            => $night,
+    'fax'              => $fax,
+    'payby'            => $payby,
+    'payinfo'          => $payinfo,
+    'paydate'          => $paydate,
+    'payname'          => $payname,
+    'invoicing_list'   => $invoicing_list,
+    'referral_custnum' => $referral_custnum,
+    'pkgpart'          => $pkgpart,
+    'username'         => $username,
+    '_password'        => $password,
+    'popnum'           => $popnum,
+  } );
 
 

-DESCRIPTION
-
-This module provides an API for a remote signup server.
-
-

-It needs to be run as the freeside user. Because of this, the program which
-calls these subroutines should be written very carefully.
-
+
DESCRIPTION
+This module provides an API for a remote signup server.
+It needs to be run as the freeside user.  Because of this, the program which
+calls these subroutines should be written very carefully.
 
 

-SUBROUTINES
+SUBROUTINES
 
-signup_info

-
+
signup_info

+

 Returns three array references of hash references.
-
-
-The first set of hash references is of allowable locales. Each hash
-reference has the following keys: taxnum state county country
-
-

-The second set of hash references is of allowable packages. Each hash
-reference has the following keys: pkgpart pkg
-
-

-The third set of hash references is of allowable POPs (Points Of Presence).
-Each hash reference has the following keys: popnum city state ac exch
-
-
new_customer HASHREF

-
-Adds a customer to the remote Freeside system. Requires a hash reference as
-a paramater with the following keys: first last ss comapny address1
-address2 city county state zip country daytime night fax payby payinfo
-paydate payname invoicing_list pkgpart username _password popnum
-
-

-Returns a scalar error message, or the empty string for success.
-
-
+The first set of hash references is of allowable locales.  Each hash reference
+has the following keys:
+  taxnum
+  state
+  county
+  country
+The second set of hash references is of allowable packages.  Each hash
+reference has the following keys:
+  pkgpart
+  pkg
+The third set of hash references is of allowable POPs (Points Of Presence).
+Each hash reference has the following keys:
+  popnum
+  city
+  state
+  ac
+  exch
+
+
new_customer HASHREF

+

+Adds a customer to the remote Freeside system.  Requires a hash reference as
+a paramater with the following keys:
+  first
+  last
+  ss
+  comapny
+  address1
+  address2
+  city
+  county
+  state
+  zip
+  country
+  daytime
+  night
+  fax
+  payby
+  payinfo
+  paydate
+  payname
+  invoicing_list
+  referral_custnum
+  pkgpart
+  username
+  _password
+  popnum
+Returns a scalar error message, or the empty string for success.
+
 
 

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

-

-BUGS
+BUGS
 
 

-SEE ALSO
-
-fs_signupd, FS::SignupServer, FS::cust_main
-
-
+
SEE ALSO
+fs_signupd, the FS::SignupServer manpage, the FS::cust_main manpage
 
 
 
diff --git a/httemplate/docs/man/FS/UID.html b/httemplate/docs/man/FS/UID.html
index 9f4947765..3c28eebfd 100644
--- a/httemplate/docs/man/FS/UID.html
+++ b/httemplate/docs/man/FS/UID.html
@@ -31,7 +31,7 @@
 SYNOPSIS
    use FS::UID qw(adminsuidsetup cgisuidsetup dbh datasrc getotaker
-  checkeuid checkruid swapuid);
+  checkeuid checkruid);

   adminsuidsetup $user;

@@ -100,10 +100,6 @@ Returns true if effective UID is that of the freeside user.
 
 Returns true if the real UID is that of the freeside user.
 
-
swapuid

-

-Swaps real and effective UIDs.
-
 
getsecrets [ USER ]

 

 Sets the user to USER, if supplied.
@@ -122,7 +118,7 @@ coderef into the hash %FS::UID::callback :
 
 

 VERSION
-$Id: UID.html,v 1.1 2001-07-30 07:36:03 ivan Exp $
+$Id: UID.html,v 1.3 2002-01-29 17:42:46 ivan Exp $
 
 

 BUGS
diff --git a/httemplate/docs/man/FS/cust_bill.html b/httemplate/docs/man/FS/cust_bill.html
index 2e2ad37fe..8bdb87b56 100644
--- a/httemplate/docs/man/FS/cust_bill.html
+++ b/httemplate/docs/man/FS/cust_bill.html
@@ -49,6 +49,8 @@
   ( $total_previous_credits, @previous_cust_credit ) = $record->cust_credit;

   @cust_pay_objects = $cust_bill->cust_pay;

+  $tax_amount = $record->tax;

   @lines = $cust_bill->print_text;
   @lines = $cust_bill->print_text $time;

@@ -72,6 +74,8 @@ following fields are currently supported:

printed - how many times this invoice has been printed automatically (see collect in the FS::cust_main manpage).

closed - books closed flag, empty or `Y'
+

@@ -117,18 +121,34 @@ Returns the line items (see the FS::cust_bi

cust_credit

-Returns a list consisting of the total previous credited (see -the FS::cust_credit manpage) for this customer, followed by the previous outstanding -credits (FS::cust_credit objects). +Depreciated. See the cust_credited method. +

+ #Returns a list consisting of the total previous credited (see
+ #L<FS::cust_credit>) and unapplied for this customer, followed by the previous
+ #outstanding credits (FS::cust_credit objects).

cust_pay

-Returns all payments (see the FS::cust_pay manpage) for this invoice. +Depreciated. See the cust_bill_pay method. +

#Returns all payments (see the FS::cust_pay manpage) for this invoice.

cust_bill_pay
+

+Returns all payment applications (see the FS::cust_bill_pay manpage) for this invoice. +

cust_credited
+

+Returns all applied credits (see the FS::cust_credit_bill manpage) for this invoice. +

tax
+

+Returns the tax amount (see the FS::cust_bill_pkg manpage) for this invoice.

owed

Returns the amount owed (still outstanding) on this invoice, which is charged -minus all payments (see the FS::cust_pay manpage). +minus all payment applications (see the FS::cust_bill_pay manpage) and credit +applications (see the FS::cust_credit_bill manpage).

print_text [TIME];

@@ -141,7 +161,7 @@ It is specified as a UNIX timestamp; see perlfunc/``time''. Also see

VERSION

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

$Id: cust_bill.html,v 1.3 2002-01-29 17:42:46 ivan Exp $

BUGS

@@ -153,8 +173,9 @@ or something similar so the look can be completely customized?)

VERSION

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

$Id: cust_credit.html,v 1.3 2002-01-29 17:42:46 ivan Exp $

BUGS

@@ -110,7 +123,8 @@ amount minus all refunds (see the FS::cust_re

   $error = $record->bill;
   $error = $record->bill %options;
@@ -134,6 +137,8 @@ FS::Record.  The following fields are currently supported:
 
 
otaker - order taker (assigned automatically, see the FS::UID manpage)

 

+
comments - comments (optional)

+

 
 
 

@@ -145,15 +150,15 @@ Creates a new customer.  To add the customer to the database, see insert

+
insert [ CUST_PKG_HASHREF [ , INVOICING_LIST_ARYREF ] ]

 

 Adds this customer to the database.  If there is an error, returns the error,
 otherwise returns false.
-There is a special insert mode in which you pass a data structure to the insert
-method containing FS::cust_pkg and FS::svc_tablename objects.  When
-running under a transactional database, all records are inserted atomicly, or
-the transaction is rolled back.  There should be a better explanation of this,
-but until then, here's an example:
+CUST_PKG_HASHREF: If you pass a Tie::RefHash data structure to the insert
+method containing FS::cust_pkg and FS::svc_tablename objects, all records
+are inserted atomicly, or the transaction is rolled back.  Passing an empty
+hash reference is equivalent to not supplying this parameter.  There should be
+a better explanation of this, but until then, here's an example:
    use Tie::RefHash;
   tie %hash, 'Tie::RefHash'; #this part is important
@@ -162,6 +167,14 @@ but until then, here's an example:
     ...
   );
   $cust_main->insert( \%hash );
+INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
+be set as the invoicing list (see invoicing_list).  Errors return as
+expected and rollback the entire transaction; it is not necessary to call 
+check_invoicing_list first.  The invoicing_list is set after the records in the
+CUST_PKG_HASHREF above are inserted, so it is now possible to set an
+invoicing_list destination to the newly-created svc_acct.  Here's an example:
++  $cust_main->insert( {}, [ $email, 'POST' ] );
 
 
delete NEW_CUSTNUM

 

@@ -170,15 +183,23 @@ returns false.
 This will completely remove all traces of the customer record.  This is not
 what you want when a customer cancels service; for that, cancel all of the
 customer's packages (see cancel in the FS::cust_pkg manpage).
-If the customer has any packages, you need to pass a new (valid) customer
-number for those packages to be transferred to.
+If the customer has any uncancelled packages, you need to pass a new (valid)
+customer number for those packages to be transferred to.  Cancelled packages
+will be deleted.  Did I mention that this is NOT what you want when a customer
+cancels service and that you really should be looking see cancel in the FS::cust_pkg manpage?
 You can't delete a customer with invoices (see the FS::cust_bill manpage),
-or credits (see the FS::cust_credit manpage).
+or credits (see the FS::cust_credit manpage) or payments (see the FS::cust_pay manpage).
 
-
replace OLD_RECORD

+
replace OLD_RECORD [ INVOICING_LIST_ARYREF ]

 

 Replaces the OLD_RECORD with this one in the database.  If there is an error,
 returns the error, otherwise returns false.
+INVOICING_LIST_ARYREF: If you pass an arrarref to the insert method, it will
+be set as the invoicing list (see invoicing_list).  Errors return as
+expected and rollback the entire transaction; it is not necessary to call 
+check_invoicing_list first.  Here's an example:
++  $new_cust_main->replace( $old_cust_main, [ $email, 'POST' ] );
 
 
check

 

@@ -194,14 +215,49 @@ Returns all packages (see the FS::cust_pkg manpa
 

 Returns all non-cancelled packages (see the FS::cust_pkg manpage) for this customer.
 
+
suspended_pkgs

+

+Returns all suspended packages (see the FS::cust_pkg manpage) for this customer.
+
+
unflagged_suspended_pkgs

+

+Returns all unflagged suspended packages (see the FS::cust_pkg manpage) for this
+customer (thouse packages without the `manual_flag' set).
+
+
unsuspended_pkgs

+

+Returns all unsuspended (and uncancelled) packages (see the FS::cust_pkg manpage) for
+this customer.
+
+
unsuspend

+

+Unsuspends all unflagged suspended packages (see unflagged_suspended_pkgs
+and the FS::cust_pkg manpage) for this customer.  Always returns a list: an empty list
+on success or a list of errors.
+
+
suspend

+

+Suspends all unsuspended packages (see the FS::cust_pkg manpage) for this customer.
+Always returns a list: an empty list on success or a list of errors.
+
+
cancel

+

+Cancels all uncancelled packages (see the FS::cust_pkg manpage) for this customer.
+Always returns a list: an empty list on success or a list of errors.
+
 
bill OPTIONS

 

 Generates invoices (see the FS::cust_bill manpage) for this customer.  Usually used in
 conjunction with the collect method.
+Options are passed as name-value pairs.
 The only currently available option is `time', which bills the customer as if
 it were that time.  It is specified as a UNIX timestamp; see
 perlfunc/``time'').  Also see the Time::Local manpage and the Date::Parse manpage for conversion
-functions.
+functions.  For example:
++ use Date::Parse;
+ ...
+ $cust_main->bill( 'time' => str2time('April 20th, 2001') );
 If there is an error, returns the error, otherwise returns false.
 
 
collect OPTIONS

@@ -211,28 +267,66 @@ functions.
 Depending on the value of `payby', this may print an invoice (`BILL'), charge
 a credit card (`CARD'), or just add any necessary (pseudo-)payment (`COMP').
 If there is an error, returns the error, otherwise returns false.
+Options are passed as name-value pairs.
 Currently available options are:
 invoice_time - Use this time when deciding when to print invoices and
 late notices on those invoices.  The default is now.  It is specified as a UNIX timestamp; see perlfunc/``time'').  Also see the Time::Local manpage and the Date::Parse manpage
 for conversion functions.
-batch_card - Set this true to batch cards (see the cust_pay_batch manpage).  By
+
batch_card - Set this true to batch cards (see the FS::cust_pay_batch manpage).  By
 default, cards are processed immediately, which will generate an error if
 CyberCash is not installed.
 report_badcard - Set this true if you want bad card transactions to
 return an error.  By default, they don't.
+force_print - force printing even if invoice has been printed more than once
+every 30 days, and don't increment the `printed' field.
 
 
total_owed

 

 Returns the total owed for this customer on all invoices
-(see the FS::cust_bill manpage).
+(see owed in the FS::cust_bill manpage).
+
+
total_owed_date TIME

+

+Returns the total owed for this customer on all invoices with date earlier than
+TIME.  TIME is specified as a UNIX timestamp; see perlfunc/``time'').  Also
+see the Time::Local manpage and the Date::Parse manpage for conversion functions.
+
+
apply_credits

+

+Applies (see the FS::cust_credit_bill manpage) unapplied credits (see the FS::cust_credit manpage)
+to outstanding invoice balances in chronological order and returns the value
+of any remaining unapplied credits available for refund
+(see the FS::cust_refund manpage).
+
+
apply_payments

+

+Applies (see the FS::cust_bill_pay manpage) unapplied payments (see the FS::cust_pay manpage)
+to outstanding invoice balances in chronological order.
++ #and returns the value of any remaining unapplied payments.
 
 
total_credited

 

-Returns the total credits (see the FS::cust_credit manpage) for this customer.
+Returns the total outstanding credit (see the FS::cust_credit manpage) for this
+customer.  See credited in the FS::cust_credit manpage.
+
+
total_unapplied_payments

+

+Returns the total unapplied payments (see the FS::cust_pay manpage) for this customer.
+See unapplied in the FS::cust_pay manpage.
 
 
balance

 

-Returns the balance for this customer (total owed minus total credited).
+Returns the balance for this customer (total_owed minus total_credited
+minus total_unapplied_payments).
+
+
balance_date TIME

+

+Returns the balance for this customer, only considering invoices with date
+earlier than TIME (total_owed_date minus total_credited minus
+total_unapplied_payments).  TIME is specified as a UNIX timestamp; see
+perlfunc/``time'').  Also see the Time::Local manpage and the Date::Parse manpage for conversion
+functions.
 
 
invoicing_list [ ARRAYREF ]

 

@@ -248,11 +342,58 @@ check it without disturbing anything by passing nothing.
 

 Checks these arguements as valid input for the invoicing_list method.  If there
 is an error, returns the error, otherwise returns false.
+
+
default_invoicing_list

+

+Sets the invoicing list to all accounts associated with this customer.
+
+
invoicing_list_addpost

+

+Adds postal invoicing to this customer.  If this customer is already configured
+to receive postal invoices, does nothing.
+
+
referral_cust_main [ DEPTH [ EXCLUDE_HASHREF ] ]

+

+Returns an array of customers referred by this customer (referral_custnum set
+to this custnum).  If DEPTH is given, recurses up to the given depth, returning
+customers referred by customers referred by this customer and so on, inclusive.
+The default behavior is DEPTH 1 (no recursion).
+
+
referral_cust_pkg [ DEPTH ]

+

+Like referral_cust_main, except returns a flat list of all unsuspended packages
+for each customer.  The number of items in this list may be useful for
+comission calculations (perhaps after a grep).
+
+
credit AMOUNT, REASON

+

+Applies a credit to this customer.  If there is an error, returns the error,
+otherwise returns false.
+
+
charge AMOUNT PKG COMMENT

+

+Creates a one-time charge for this customer.  If there is an error, returns
+the error, otherwise returns false.
 
 
 

+SUBROUTINES
+
+check_and_rebuild_fuzzyfiles

+

+
rebuild_fuzzyfiles

+

+
all_last

+

+
all_company

+

+
append_fuzzyfiles LASTNAME COMPANY

+

+
+
+

 VERSION
-$Id: cust_main.html,v 1.1 2001-07-30 07:36:03 ivan Exp $
+$Id: cust_main.html,v 1.2 2002-01-29 16:33:15 ivan Exp $
 
 

 BUGS
@@ -264,7 +405,6 @@ 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).
 
 

diff --git a/httemplate/docs/man/FS/cust_main_invoice.html b/httemplate/docs/man/FS/cust_main_invoice.html
index 6ab7fa289..a7929a943 100644
--- a/httemplate/docs/man/FS/cust_main_invoice.html
+++ b/httemplate/docs/man/FS/cust_main_invoice.html
@@ -100,7 +100,7 @@ Returns the literal email address for this record (or `POST').
 
 

 VERSION
-$Id: cust_main_invoice.html,v 1.1 2001-07-30 07:36:03 ivan Exp $
+$Id: cust_main_invoice.html,v 1.3 2002-01-29 17:42:46 ivan Exp $
 
 

 BUGS
diff --git a/httemplate/docs/man/FS/cust_pay.html b/httemplate/docs/man/FS/cust_pay.html
index 803376260..ce057f068 100644
--- a/httemplate/docs/man/FS/cust_pay.html
+++ b/httemplate/docs/man/FS/cust_pay.html
@@ -50,7 +50,7 @@ currently supported:
 
 paynum - primary key (assigned automatically for new payments)

 

-
invnum - Invoice (see the FS::cust_bill manpage)

+
custnum - customer (see the FS::cust_main manpage)

 

 
paid - Amount of this payment

 

@@ -59,10 +59,12 @@ currently supported:
 

 
payby - `CARD' (credit cards), `BILL' (billing), or `COMP' (free)

 

-
payinfo - card number, P.O.#, or comp issuer (4-8 lowercase alphanumerics; think username)

+
payinfo - card number, check #, or comp issuer (4-8 lowercase alphanumerics; think username), respectively

 

 
paybatch - text field for tracking card processing

 

+
closed - books closed flag, empty or `Y'

+

 
 
 

@@ -74,8 +76,10 @@ Creates a new payment.  To add the payment to the databse, see 
 
insert

 

-Adds this payment to the databse, and updates the invoice (see
-the FS::cust_bill manpage).
+Adds this payment to the database.
+For backwards-compatibility and convenience, if the additional field invnum
+is defined, an FS::cust_bill_pay record for the full amount of the payment
+will be created.  In this case, custnum is optional.
 
 
delete

 

@@ -89,11 +93,21 @@ Currently unimplemented (accounting reasons).
 

 Checks all fields to make sure this is a valid payment.  If there is an error,
 returns the error, otherwise returns false.  Called by the insert method.
+
+
cust_bill_pay

+

+Returns all applications to invoices (see the FS::cust_bill_pay manpage) for this
+payment.
+
+
unapplied

+

+Returns the amount of this payment that is still unapplied; which is
+paid minus all payment applications (see the FS::cust_bill_pay manpage).
 
 
 

 VERSION
-$Id: cust_pay.html,v 1.1 2001-07-30 07:36:03 ivan Exp $
+$Id: cust_pay.html,v 1.2 2002-01-29 16:33:15 ivan Exp $
 
 

 BUGS
@@ -101,7 +115,8 @@ returns the error, otherwise returns false.  Called by the insert method.
 
 

 SEE ALSO
-the FS::Record manpage, the FS::cust_bill manpage, schema.html from the base documentation.
+the FS::cust_bill_pay manpage, the FS::cust_bill manpage, the FS::Record manpage, schema.html from the
+base documentation.
 
 
 
diff --git a/httemplate/docs/man/FS/cust_pay_batch.html b/httemplate/docs/man/FS/cust_pay_batch.html
index c1c73c301..052ccac39 100644
--- a/httemplate/docs/man/FS/cust_pay_batch.html
+++ b/httemplate/docs/man/FS/cust_pay_batch.html
@@ -49,7 +49,7 @@ 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

+
paybatchnum - primary key (automatically assigned)

 

 
cardnum

 

@@ -116,7 +116,7 @@ and repalce methods.
 
 

 VERSION
-$Id: cust_pay_batch.html,v 1.1 2001-07-30 07:36:03 ivan Exp $
+$Id: cust_pay_batch.html,v 1.3 2002-01-29 17:42:46 ivan Exp $
 
 

 BUGS
diff --git a/httemplate/docs/man/FS/cust_pkg.html b/httemplate/docs/man/FS/cust_pkg.html
index 459d1297c..9f1005da7 100644
--- a/httemplate/docs/man/FS/cust_pkg.html
+++ b/httemplate/docs/man/FS/cust_pkg.html
@@ -52,6 +52,8 @@
   $part_pkg = $record->part_pkg;

   @labels = $record->labels;

+  $seconds = $record->seconds_since($timestamp);

   $error = FS::cust_pkg::order( $custnum, \@pkgparts );
   $error = FS::cust_pkg::order( $custnum, \@pkgparts, \@remove_pkgnums ] );

@@ -79,6 +81,9 @@ inherits from FS::Record. The following fields are currently supported:

otaker - order taker (assigned automatically if null, see the FS::UID manpage)

manual_flag - If this field is set to 1, disables the automatic +unsuspension of this package when using the unsuspendauto config file.
+

Note: setup, bill, susp, expire and cancel are specified as UNIX timestamps; see perlfunc/``time''. Also see the Time::Local manpage and the Date::Parse manpage for @@ -95,26 +100,12 @@ Create a new billing item. To add the item to the database, see delete

-Currently unimplemented. You don't want to delete billing items, because there -would then be no record the customer ever purchased the item. Instead, see -the cancel method. +This method now works but you probably shouldn't use it. +

You don't want to delete billing items, because there would then be no record +the customer ever purchased the item. Instead, see the cancel method.

replace OLD_RECORD

@@ -158,16 +149,32 @@ package, then unsuspends the package itself (clears the susp field). Returns the definition for this billing item, as an FS::part_pkg object (see the FS::part_pkg manpage).

cust_svc
+

+Returns the services for this package, as FS::cust_svc objects (see +the FS::cust_svc manpage) +

labels

Returns a list of lists, calling the label method for all services (see the FS::cust_svc manpage) of this billing item. +

cust_main
+

+Returns the parent customer object (see the FS::cust_main manpage). +

seconds_since TIMESTAMP
+

+Returns the number of seconds all accounts (see the FS::svc_acct manpage) in this +package have been online since TIMESTAMP. +

TIMESTAMP is specified as a UNIX timestamp; see perlfunc/``time''. Also see +the Time::Local manpage and the Date::Parse manpage for conversion functions.

SUBROUTINES

order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF ]
+

order CUSTNUM, PKGPARTS_ARYREF, [ REMOVE_PKGNUMS_ARYREF [ RETURN_CUST_PKG_ARRAYREF ] ]

CUSTNUM is a customer (see the FS::cust_main manpage)

PKGPARTS is a list of pkgparts specifying the the billing item definitions (see @@ -176,12 +183,15 @@ permitted.

REMOVE_PKGNUMS is an optional list of pkgnums specifying the billing items to remove for this customer. The services (see the FS::cust_svc manpage) are moved to the new billing items. An error is returned if this is not possible (see -the FS::pkg_svc manpage).

+the FS::pkg_svc manpage). An empty arrayref is equivalent to not specifying this +parameter.

RETURN_CUST_PKG_ARRAYREF, if specified, will be filled in with the +newly-created cust_pkg objects.

VERSION

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

$Id: cust_pkg.html,v 1.2 2002-01-29 16:33:15 ivan Exp $

BUGS

@@ -194,11 +204,13 @@ 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.

Now that things are transactional should the check in the insert method be +moved to check ?

VERSION

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

$Id: cust_refund.html,v 1.3 2002-01-29 17:42:46 ivan Exp $

BUGS

diff --git a/httemplate/docs/man/FS/cust_svc.html b/httemplate/docs/man/FS/cust_svc.html index c1ca2d700..97a299c52 100644 --- a/httemplate/docs/man/FS/cust_svc.html +++ b/httemplate/docs/man/FS/cust_svc.html @@ -64,7 +64,7 @@ The following fields are currently supported:

Creates a new service. To add the refund to the database, see insert. Services are normally created by creating FS::svc_ objects (see -the FS::svc_acct manpage, the FS::svc_domain manpage, and the FS::svc_acct_sm manpage, among others). +the FS::svc_acct manpage, the FS::svc_domain manpage, and the FS::svc_forward manpage, among others).

insert

@@ -88,17 +88,38 @@ Checks all fields to make sure this is a valid service. If there is an error, returns the error, otehrwise returns false. Called by the insert and replace methods.

part_svc
+

+Returns the definition for this service, as a FS::part_svc object (see +the FS::part_svc manpage). +

cust_pkg
+

+Returns the definition for this service, as a FS::part_svc object (see +the FS::part_svc manpage). +

label

Returns a list consisting of: - The name of this service (from part_svc) - A meaningful identifier (username, domain, or mail alias) - The table name (i.e. svc_domain) for this service +

svc_x
+

+Returns the FS::svc_XXX object for this service (i.e. an FS::svc_acct object or +FS::svc_domain object, etc.) +

seconds_since TIMESTAMP
+

+See seconds_since in the FS::svc_acct manpage. Equivalent to +$cust_svc->svc_x->seconds_since, but more efficient. Meaningless for records +where svcdb is not ``svc_acct''.

VERSION

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

$Id: cust_svc.html,v 1.2 2002-01-29 16:33:16 ivan Exp $

BUGS

diff --git a/httemplate/docs/man/FS/domain_record.html b/httemplate/docs/man/FS/domain_record.html index 7a1bf3e32..0349f7b78 100644 --- a/httemplate/docs/man/FS/domain_record.html +++ b/httemplate/docs/man/FS/domain_record.html @@ -18,7 +18,6 @@

VERSION

BUGS

VERSION

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

$Id: domain_record.html,v 1.3 2002-01-29 17:42:46 ivan Exp $

BUGS

@@ -107,17 +106,6 @@ course, it's still better than editing the zone files directly. :)

HISTORY

$Log: domain_record.html,v $ -

Revision 1.1 2001-07-30 07:36:03 ivan -

templates!!! -

-Revision 1.2 2001/05/18 14:08:55 ivan -tyop

Revision 1.1 2000/02/03 05:16:52 ivan -beginning of DNS and Apache support

diff --git a/httemplate/docs/man/FS/part_pkg.html b/httemplate/docs/man/FS/part_pkg.html index 9aeaa3d3d..e1e96b54c 100644 --- a/httemplate/docs/man/FS/part_pkg.html +++ b/httemplate/docs/man/FS/part_pkg.html @@ -60,11 +60,21 @@ inherits from FS::Record. The following fields are currently supported:

comment - Text name of this billing item definition (non-customer-viewable)

setup - Setup fee
+

setup - Setup fee expression

freq - Frequency of recurring fee

recur - Recurring fee
+

recur - Recurring fee expression
+

setuptax - Setup fee tax exempt flag, empty or `Y'
+

recurtax - Recurring fee tax exempt flag, empty or `Y'
+

plan - Price plan
+

plandata - Price plan data
+

disabled - Disabled flag, empty or `Y'

setup and recur are evaluated as Safe perl expressions. You can use numbers @@ -120,7 +130,7 @@ SVCDB is specified and does not match the svcdb of the service definition,

VERSION

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

$Id: part_pkg.html,v 1.3 2002-01-29 17:42:46 ivan Exp $

BUGS

diff --git a/httemplate/docs/man/FS/part_svc.html b/httemplate/docs/man/FS/part_svc.html index ca0a5dc71..0f5126f81 100644 --- a/httemplate/docs/man/FS/part_svc.html +++ b/httemplate/docs/man/FS/part_svc.html @@ -31,8 +31,8 @@

   use FS::part_svc;

-  $record = new FS::part_referral \%hash
-  $record = new FS::part_referral { 'column' => 'value' };

+ $record = new FS::part_svc \%hash + $record = new FS::part_svc { 'column' => 'value' };

   $error = $record->insert;

@@ -52,11 +52,9 @@ FS::Record.  The following fields are currently supported:
 svc - text name of this service definition

 

 
svcdb - table used for this service.  See the FS::svc_acct manpage,
-the FS::svc_domain manpage, and the FS::svc_acct_sm manpage, among others.

+the FS::svc_domain manpage, and the FS::svc_forward manpage, among others.

 

-
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

+
disabled - Disabled flag, empty or `Y'

 

 
 
@@ -73,6 +71,10 @@ database, see insert.
 Adds this service definition to the database.  If there is an error, returns
 the error, otherwise returns false.
 

+
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

+

 
delete

 

 Currently unimplemented.
@@ -87,11 +89,19 @@ returns the error, otherwise returns false.
 Checks all fields to make sure this is a valid service definition.  If there is
 an error, returns the error, otherwise returns false.  Called by the insert
 and replace methods.
-
+
+
part_svc_column COLUMNNAME

+

+Returns the part_svc_column object (see the FS::part_svc_column manpage) for the given
+COLUMNNAME, or a new part_svc_column object if none exists.
+
+
all_part_svc_column

+

+
 
 

 VERSION
-$Id: part_svc.html,v 1.1 2001-07-30 07:36:03 ivan Exp $
+$Id: part_svc.html,v 1.3 2002-01-29 17:42:46 ivan Exp $
 
 

 BUGS
@@ -101,9 +111,9 @@ 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 manpage, the FS::svc_acct_sm manpage, the FS::svc_domain manpage, schema.html from the
-base documentation.
+the FS::Record manpage, the FS::part_svc_column manpage, the FS::part_pkg manpage, the FS::pkg_svc manpage,
+the FS::cust_svc manpage, the FS::svc_acct manpage, the FS::svc_forward manpage, the FS::svc_domain manpage,
+schema.html from the base documentation.
 
 
 
diff --git a/httemplate/docs/man/FS/prepay_credit.html b/httemplate/docs/man/FS/prepay_credit.html
index 4e77897a3..bb0c281c2 100644
--- a/httemplate/docs/man/FS/prepay_credit.html
+++ b/httemplate/docs/man/FS/prepay_credit.html
@@ -18,7 +18,6 @@
 	VERSION
 	BUGS
 	SEE ALSO
-	HISTORY
 
 
 
@@ -93,7 +92,7 @@ and replace methods.
 
 

 VERSION
-$Id: prepay_credit.html,v 1.1 2001-07-30 07:36:03 ivan Exp $
+$Id: prepay_credit.html,v 1.3 2002-01-29 17:42:46 ivan Exp $
 
 

 BUGS
@@ -101,17 +100,6 @@ and replace methods.
 
 SEE ALSO
 the FS::Record manpage, schema.html from the base documentation.
-
-

-HISTORY
-$Log: prepay_credit.html,v $
-
Revision 1.1  2001-07-30 07:36:03  ivan
-
templates!!!
-

-Revision 1.2  2000/02/02 20:22:18  ivan
-bugfix prepayment in signup server
-Revision 1.1  2000/01/31 05:22:23  ivan
-prepaid ``internet cards''
 
 
 
diff --git a/httemplate/docs/man/FS/svc_Common.html b/httemplate/docs/man/FS/svc_Common.html
index 100aee880..ccac5efa0 100644
--- a/httemplate/docs/man/FS/svc_Common.html
+++ b/httemplate/docs/man/FS/svc_Common.html
@@ -64,6 +64,11 @@ Sets all fields to their defaults (see the FS::p
 current values.  If there is an error, returns the error, otherwise returns
 the FS::part_svc object (use ref() to test the return).
 
+
cust_svc

+

+Returns the cust_svc record associated with this svc_ record, as a FS::cust_svc
+object (see the FS::cust_svc manpage).
+
 
suspend

 

 
unsuspend

@@ -76,13 +81,11 @@ methods.  Called by the cancel method of FS::cust_pkg (see VERSION
-$Id: svc_Common.html,v 1.1 2001-07-30 07:36:03 ivan Exp $
+$Id: svc_Common.html,v 1.3 2002-01-29 17:42:46 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
diff --git a/httemplate/docs/man/FS/svc_acct.html b/httemplate/docs/man/FS/svc_acct.html
index 81bc118df..9c41db3f0 100644
--- a/httemplate/docs/man/FS/svc_acct.html
+++ b/httemplate/docs/man/FS/svc_acct.html
@@ -49,6 +49,18 @@
   $error = $record->cancel;

   %hash = $record->radius;

+  %hash = $record->radius_reply;

+  %hash = $record->radius_check;

+  $domain = $record->domain;

+  $svc_domain = $record->svc_domain;

+  $email = $record->email;

+  $seconds_since = $record->seconds_since($timestamp);

DESCRIPTION

@@ -77,8 +89,14 @@ FS::svc_Common. The following fields are currently supported:

slipip - IP address

seconds -
+

domsvc - svcnum from svc_domain
+

radius_Radius_Attribute - Radius-Attribute

domsvc - service number of svc_domain with which to associate
+

@@ -96,7 +114,8 @@ otherwise returns false. defined. An FS::cust_svc record will be created and inserted.

If the configuration value (see the FS::Conf manpage) shellmachine exists, and the username, uid, and dir fields are defined, the command(s) specified in -the shellmachine-useradd configuration are exectued on shellmachine via ssh. +the shellmachine-useradd configuration are added to the job queue (see +the FS::queue manpage and the freeside-queued manpage) to be exectued on shellmachine via ssh. This behaviour can be surpressed by setting $FS::svc_acct::nossh_hack true. If the shellmachine-useradd configuration file does not exist,

@@ -108,6 +127,7 @@ it empty,
 is the default instead.  Otherwise the contents of the file are treated as
 a double-quoted perl string, with the following variables available:
 $username, $uid, $gid, $dir, and $shell.
+(TODOC: cyrus config file, the FS::queue manpage and the freeside-queued manpage)
 
 delete

 

@@ -116,7 +136,8 @@ error, otherwise returns false.
 The corresponding FS::cust_svc record will be deleted as well.
 If the configuration value (see the FS::Conf manpage) shellmachine exists, the
 command(s) specified in the shellmachine-userdel configuration file are
-executed on shellmachine via ssh.  This behavior can be surpressed by setting
+added to the job queue (see the FS::queue manpage and the freeside-queued manpage) to be executed
+on shellmachine via ssh.  This behavior can be surpressed by setting
 $FS::svc_acct::nossh_hack true.  If the shellmachine-userdel configuration
 file does not exist,
 @@ -128,6 +149,7 @@ is empty,
 is the default instead.  Otherwise the contents of the file are treated as a
 double-quoted perl string, with the following variables available:
 $username and $dir.
+(TODOC: cyrus config file)
 
 replace OLD_RECORD

 

@@ -135,9 +157,10 @@ Replaces OLD_RECORD with this one in the database.  If there is an error,
 returns the error, otherwise returns false.
 If the configuration value (see the FS::Conf manpage) shellmachine exists, and the 
 dir field has changed, the command(s) specified in the shellmachine-usermod
-configuraiton file are executed on shellmachine via ssh.  This behavior can
+configuraiton file are added to the job queue (see the FS::queue manpage and
+the freeside-queued manpage) to be executed on shellmachine via ssh.  This behavior can
 be surpressed by setting $FS::svc-acct::nossh_hack true.  If the
-shellmachine-userdel configuration file does not exist or is empty, :
+shellmachine-userdel configuration file does not exist or is empty,
    [ -d $old_dir ] && mv $old_dir $new_dir || (
     chmod u+t $old_dir;
@@ -148,8 +171,8 @@ shellmachine-userdel configuration file does not exist or is empty, :
     chown -R $uid.$gid $new_dir;
     rm -rf $old_dir
   )
-is executed on shellmachine via ssh.  This behaviour can be surpressed by
-setting $FS::svc_acct::nossh_hack true.
+is the default.  This behaviour can be surpressed by setting
+$FS::svc_acct::nossh_hack true.
 
 
suspend

 

@@ -193,11 +216,42 @@ Returns key/value pairs, suitable for assigning to a hash, for any RADIUS
 check attributes of this record.
 Accessing RADIUS attributes directly is not supported and will break in the
 future.
-
+
+
domain

+

+Returns the domain associated with this account.
+
+
svc_domain

+

+Returns the FS::svc_domain record for this account's domain (see
+the FS::svc_domain manpage.
+
+
cust_svc

+

+Returns the FS::cust_svc record for this account (see the FS::cust_svc manpage).
+sub cust_svc {
+  my $self = shift;
+  qsearchs( 'cust_svc', { 'svcnum' => $self->svcnum } );
+}
+
+
email

+

+Returns an email address associated with the account.
+
+
seconds_since TIMESTAMP

+

+Returns the number of seconds this account has been online since TIMESTAMP.
+See the FS::session manpage
+TIMESTAMP is specified as a UNIX timestamp; see perlfunc/``time''.  Also see
+the Time::Local manpage and the Date::Parse manpage for conversion functions.
+
+
ssh

+

+
 
 

 VERSION
-$Id: svc_acct.html,v 1.1 2001-07-30 07:36:03 ivan Exp $
+$Id: svc_acct.html,v 1.2 2002-01-29 16:33:16 ivan Exp $
 
 

 BUGS
@@ -210,8 +264,10 @@ counterintuitive.
 
 

 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 Net::SSH manpage, ssh, the FS::svc_acct_pop manpage,
+
the FS::svc_Common manpage, edit/part_svc.cgi from an installed web interface,
+export.html from the base documentation, 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::queue manpage,
+the freeside-queued manpage), the Net::SSH manpage, ssh, the FS::svc_acct_pop manpage,
 schema.html from the base documentation.
 
 
diff --git a/httemplate/docs/man/FS/svc_acct_pop.html b/httemplate/docs/man/FS/svc_acct_pop.html
index d65ca5778..80900627e 100644
--- a/httemplate/docs/man/FS/svc_acct_pop.html
+++ b/httemplate/docs/man/FS/svc_acct_pop.html
@@ -15,6 +15,7 @@
 	SYNOPSIS
 	DESCRIPTION
 	METHODS
+	SUBROUTINES
 	VERSION
 	BUGS
 	SEE ALSO
@@ -41,6 +42,8 @@
   $error = $record->delete;
    $error = $record->check;
++  $html = FS::svc_acct_pop::popselector( $popnum, $state );
 
 

 DESCRIPTION
@@ -88,19 +91,34 @@ returns the error, otherwise returns false.
 Checks all fields to make sure this is a valid point of presence.  If there is
 an error, returns the error, otherwise returns false.  Called by the insert
 and replace methods.
+
+
text

+

+Returns:
+``$city, $state ($ac)/$exch''
 
 
 

+SUBROUTINES
+
+popselector [ POPNUM [ STATE ] ]

+

+
+
+

 VERSION
-$Id: svc_acct_pop.html,v 1.1 2001-07-30 07:36:03 ivan Exp $
+$Id: svc_acct_pop.html,v 1.3 2002-01-29 17:42:46 ivan Exp $
 
 

 BUGS
 It should be renamed to part_pop.
+popselector?  putting web ui components in here?  they should probably live
+somewhere else...
 
 

 SEE ALSO
-the FS::Record manpage, the svc_acct manpage, schema.html from the base documentation.
+the FS::Record manpage, the FS::svc_acct manpage, the FS::part_pop_local manpage, schema.html from the
+base documentation.
 
 
 
diff --git a/httemplate/docs/man/FS/svc_acct_sm.html b/httemplate/docs/man/FS/svc_acct_sm.html
index ca50e7202..86c7b8b3b 100644
--- a/httemplate/docs/man/FS/svc_acct_sm.html
+++ b/httemplate/docs/man/FS/svc_acct_sm.html
@@ -13,6 +13,7 @@
 
 	NAME
 	SYNOPSIS
+	WARNING
 	DESCRIPTION
 	METHODS
 	VERSION
@@ -49,9 +50,14 @@
   $error = $record->cancel;

WARNING

FS::svc_acct_sm is depreciated. This class is only included for migration +purposes. See the FS::svc_forward manpage.

DESCRIPTION

An FS::svc_acct object represents a virtual mail alias. FS::svc_acct inherits -from FS::Record. The following fields are currently supported:

An FS::svc_acct_sm object represents a virtual mail alias. FS::svc_acct_sm +inherits from FS::Record. The following fields are currently supported:

svcnum - primary key (assigned automatcially for new accounts)

@@ -77,15 +83,17 @@ Adds this virtual mail alias 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.

If the configuration values (see the FS::Conf manpage) shellmachine and qmailmachines -exist, and domuser is `*' (meaning a catch-all mailbox), the command:

-  [ -e $dir/.qmail-$qdomain-default ] || {
-    touch $dir/.qmail-$qdomain-default;
-    chown $uid:$gid $dir/.qmail-$qdomain-default;
-  }

is executed on shellmachine via ssh (see dot-qmail/``EXTENSION ADDRESSES''). -This behaviour can be surpressed by setting $FS::svc_acct_sm::nossh_hack true.

+ #If the configuration values (see L<FS::Conf>) shellmachine and qmailmachines + #exist, and domuser is `*' (meaning a catch-all mailbox), the command: + # + # [ -e $dir/.qmail-$qdomain-default ] || { + # touch $dir/.qmail-$qdomain-default; + # chown $uid:$gid $dir/.qmail-$qdomain-default; + # } + # + #is executed on shellmachine via ssh (see L<dot-qmail/"EXTENSION ADDRESSES">). + #This behaviour can be surpressed by setting $FS::svc_acct_sm::nossh_hack true.

delete

@@ -123,7 +131,7 @@ replace methods.

VERSION

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

$Id: svc_acct_sm.html,v 1.3 2002-01-29 17:42:46 ivan Exp $

BUGS

@@ -132,6 +140,7 @@ replace methods.

VERSION

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

$Id: svc_domain.html,v 1.3 2002-01-29 17:42:46 ivan Exp $

BUGS

diff --git a/httemplate/docs/man/FS/svc_www.html b/httemplate/docs/man/FS/svc_www.html index e72b219be..0e7f4f197 100644 --- a/httemplate/docs/man/FS/svc_www.html +++ b/httemplate/docs/man/FS/svc_www.html @@ -18,7 +18,6 @@

VERSION

BUGS

VERSION

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

$Id: svc_www.html,v 1.3 2002-01-29 17:42:46 ivan Exp $

BUGS

@@ -129,21 +128,6 @@ and repalce methods.

HISTORY

$Log: svc_www.html,v $ -

Revision 1.1 2001-07-30 07:36:03 ivan -

templates!!! -

-Revision 1.4 2001/04/22 01:56:15 ivan -get rid of FS::SSH.pm (became Net::SSH and Net::SCP on CPAN)

Revision 1.3 2000/11/22 23:30:51 ivan -tyop

Revision 1.2 2000/03/01 08:13:59 ivan -compilation bugfixes

Revision 1.1 2000/02/03 05:16:52 ivan -beginning of DNS and Apache support

-- cgit v1.2.1