3 <TITLE>FS::SignupClient - Freeside signup client API</TITLE>
4 <LINK REV="made" HREF="mailto:none">
13 <LI><A HREF="#NAME">NAME</A>
14 <LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
15 <LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
16 <LI><A HREF="#SUBROUTINES">SUBROUTINES</A>
17 <LI><A HREF="#VERSION">VERSION</A>
18 <LI><A HREF="#BUGS">BUGS</A>
19 <LI><A HREF="#SEE_ALSO">SEE ALSO</A>
25 <H1><A NAME="NAME">NAME</A></H1>
27 FS::SignupClient - Freeside signup client API
31 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
33 <PRE> use FS::SignupClient qw( signup_info new_customer );
36 <PRE> ( $locales, $packages, $pops ) = signup_info;
39 <PRE> $error = new_customer ( {
43 'comapny' => $company,
44 'address1' => $address1,
45 'address2' => $address2,
47 'county' => $county,
50 'country' => $country,
51 'daytime' => $daytime,
55 'payinfo' => $payinfo,
56 'paydate' => $paydate,
57 'payname' => $payname,
58 'invoicing_list' => $invoicing_list,
59 'pkgpart' => $pkgpart,
60 'username' => $username,
61 '_password' => $password,
62 'popnum' => $popnum,
67 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
69 This module provides an API for a remote signup server.
72 It needs to be run as the freeside user. Because of this, the program which
73 calls these subroutines should be written very carefully.
77 <H1><A NAME="SUBROUTINES">SUBROUTINES</A></H1>
79 <DT><STRONG><A NAME="item_signup_info">signup_info</A></STRONG><DD>
81 Returns three array references of hash references.
84 The first set of hash references is of allowable locales. Each hash
85 reference has the following keys: taxnum state county country
88 The second set of hash references is of allowable packages. Each hash
89 reference has the following keys: pkgpart pkg
92 The third set of hash references is of allowable POPs (Points Of Presence).
93 Each hash reference has the following keys: popnum city state ac exch
95 <DT><STRONG><A NAME="item_new_customer">new_customer HASHREF</A></STRONG><DD>
97 Adds a customer to the remote Freeside system. Requires a hash reference as
98 a paramater with the following keys: first last ss comapny address1
99 address2 city county state zip country daytime night fax payby payinfo
100 paydate payname invoicing_list pkgpart username _password popnum
103 Returns a scalar error message, or the empty string for success.
108 <H1><A NAME="VERSION">VERSION</A></H1>
110 $Id: SignupClient.html,v 1.1 2001-07-30 07:36:03 ivan Exp $
114 <H1><A NAME="BUGS">BUGS</A></H1>
117 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
119 <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>