<HTML>
<HEAD>
<TITLE>FS::SignupClient - Freeside signup client API</TITLE>
-<LINK REV="made" HREF="mailto:none">
+<LINK REV="made" HREF="mailto:perl@packages.debian.org">
</HEAD>
<BODY>
+<A NAME="__index__"></A>
<!-- INDEX BEGIN -->
<UL>
- <LI><A HREF="#NAME">NAME</A>
- <LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
- <LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
- <LI><A HREF="#SUBROUTINES">SUBROUTINES</A>
- <LI><A HREF="#VERSION">VERSION</A>
- <LI><A HREF="#BUGS">BUGS</A>
- <LI><A HREF="#SEE_ALSO">SEE ALSO</A>
+ <LI><A HREF="#name">NAME</A></LI>
+ <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
+ <LI><A HREF="#description">DESCRIPTION</A></LI>
+ <LI><A HREF="#subroutines">SUBROUTINES</A></LI>
+ <LI><A HREF="#bugs">BUGS</A></LI>
+ <LI><A HREF="#see also">SEE ALSO</A></LI>
</UL>
<!-- INDEX END -->
<HR>
<P>
-<H1><A NAME="NAME">NAME</A></H1>
-<P>
-FS::SignupClient - Freeside signup client API
-
+<H1><A NAME="name">NAME</A></H1>
+<P>FS::SignupClient - Freeside signup client API</P>
<P>
<HR>
-<H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
-<P>
-<PRE> use FS::SignupClient qw( signup_info new_customer );
-</PRE>
-<P>
-<PRE> ( $locales, $packages, $pops ) = signup_info;
-</PRE>
-<P>
-<PRE> $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,
- } );
-</PRE>
+<H1><A NAME="synopsis">SYNOPSIS</A></H1>
+<PRE>
+ use FS::SignupClient qw( signup_info new_customer );</PRE>
+<PRE>
+ ( $locales, $packages, $pops ) = signup_info;</PRE>
+<PRE>
+ $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,
+ } );</PRE>
<P>
<HR>
-<H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
-<P>
-This module provides an API for a remote signup server.
-
-<P>
-It needs to be run as the freeside user. Because of this, the program which
-calls these subroutines should be written very carefully.
-
+<H1><A NAME="description">DESCRIPTION</A></H1>
+<P>This module provides an API for a remote signup server.</P>
+<P>It needs to be run as the freeside user. Because of this, the program which
+calls these subroutines should be written very carefully.</P>
<P>
<HR>
-<H1><A NAME="SUBROUTINES">SUBROUTINES</A></H1>
+<H1><A NAME="subroutines">SUBROUTINES</A></H1>
<DL>
-<DT><STRONG><A NAME="item_signup_info">signup_info</A></STRONG><DD>
-<P>
+<DT><STRONG><A NAME="item_signup_info">signup_info</A></STRONG><BR>
+<DD>
Returns three array references of hash references.
-
-<P>
-The first set of hash references is of allowable locales. Each hash
-reference has the following keys: taxnum state county country
-
-<P>
-The second set of hash references is of allowable packages. Each hash
-reference has the following keys: pkgpart pkg
-
-<P>
-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
-
-<DT><STRONG><A NAME="item_new_customer">new_customer HASHREF</A></STRONG><DD>
-<P>
-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
-
-<P>
-Returns a scalar error message, or the empty string for success.
-
-</DL>
+<P>The first set of hash references is of allowable locales. Each hash reference
+has the following keys:
+ taxnum
+ state
+ county
+ country</P>
+<P>The second set of hash references is of allowable packages. Each hash
+reference has the following keys:
+ pkgpart
+ pkg</P>
+<P>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</P>
+<P></P>
+<DT><STRONG><A NAME="item_new_customer_HASHREF">new_customer HASHREF</A></STRONG><BR>
+<DD>
+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
+<P>Returns a scalar error message, or the empty string for success.</P>
+<P></P></DL>
<P>
<HR>
-<H1><A NAME="VERSION">VERSION</A></H1>
-<P>
-$Id: SignupClient.html,v 1.1 2001-07-30 07:36:03 ivan Exp $
-
-<P>
-<HR>
-<H1><A NAME="BUGS">BUGS</A></H1>
+<H1><A NAME="bugs">BUGS</A></H1>
<P>
<HR>
-<H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
-<P>
-<EM>fs_signupd</EM>, <A HREF="./htdocs/docs/man/FS/SignupServer.html">FS::SignupServer</A>, <A HREF="./htdocs/docs/man/FS/cust_main.html">FS::cust_main</A>
-
-
+<H1><A NAME="see also">SEE ALSO</A></H1>
+<P><EM>fs_signupd</EM>, <A HREF="../FS/SignupServer.html">the FS::SignupServer manpage</A>, <A HREF=".././FS/cust_main.html">the FS::cust_main manpage</A></P>
</BODY>
projects / freeside.git / blobdiff