htdocs/docs/man/FS/SignupClient.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>FS::SignupClient - Freeside signup client API</TITLE>
   4 <LINK REV="made" HREF="mailto:none">
   5 </HEAD>
   6
   7 <BODY>
   8
   9 <!-- INDEX BEGIN -->
  10
  11 <UL>
  12
  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>
  20 </UL>
  21 <!-- INDEX END -->
  22
  23 <HR>
  24 <P>
  25 <H1><A NAME="NAME">NAME</A></H1>
  26 <P>
  27 FS::SignupClient - Freeside signup client API
  28
  29 <P>
  30 <HR>
  31 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
  32 <P>
  33 <PRE>  use FS::SignupClient qw( signup_info new_customer );
  34 </PRE>
  35 <P>
  36 <PRE>  ( $locales, $packages, $pops ) = signup_info;
  37 </PRE>
  38 <P>
  39 <PRE>  $error = new_customer ( {
  40     'first'          =&gt; $first,
  41     'last'           =&gt; $last,
  42     'ss'             =&gt; $ss,
  43     'comapny'        =&gt; $company,
  44     'address1'       =&gt; $address1,
  45     'address2'       =&gt; $address2,
  46     'city'           =&gt; $city,
  47     'county'         =&gt; $county,
  48     'state'          =&gt; $state,
  49     'zip'            =&gt; $zip,
  50     'country'        =&gt; $country,
  51     'daytime'        =&gt; $daytime,
  52     'night'          =&gt; $night,
  53     'fax'            =&gt; $fax,
  54     'payby'          =&gt; $payby,
  55     'payinfo'        =&gt; $payinfo,
  56     'paydate'        =&gt; $paydate,
  57     'payname'        =&gt; $payname,
  58     'invoicing_list' =&gt; $invoicing_list,
  59     'pkgpart'        =&gt; $pkgpart,
  60     'username'       =&gt; $username,
  61     '_password'       =&gt; $password,
  62     'popnum'         =&gt; $popnum,
  63   } );
  64 </PRE>
  65 <P>
  66 <HR>
  67 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
  68 <P>
  69 This module provides an API for a remote signup server.
  70
  71 <P>
  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.
  74
  75 <P>
  76 <HR>
  77 <H1><A NAME="SUBROUTINES">SUBROUTINES</A></H1>
  78 <DL>
  79 <DT><STRONG><A NAME="item_signup_info">signup_info</A></STRONG><DD>
  80 <P>
  81 Returns three array references of hash references.
  82
  83 <P>
  84 The first set of hash references is of allowable locales. Each hash
  85 reference has the following keys: taxnum state county country
  86
  87 <P>
  88 The second set of hash references is of allowable packages. Each hash
  89 reference has the following keys: pkgpart pkg
  90
  91 <P>
  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
  94
  95 <DT><STRONG><A NAME="item_new_customer">new_customer HASHREF</A></STRONG><DD>
  96 <P>
  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
 101
 102 <P>
 103 Returns a scalar error message, or the empty string for success.
 104
 105 </DL>
 106 <P>
 107 <HR>
 108 <H1><A NAME="VERSION">VERSION</A></H1>
 109 <P>
 110 $Id: SignupClient.html,v 1.1 2001-04-23 12:41:57 ivan Exp $
 111
 112 <P>
 113 <HR>
 114 <H1><A NAME="BUGS">BUGS</A></H1>
 115 <P>
 116 <HR>
 117 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
 118 <P>
 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>
 120
 121
 122
 123 </BODY>
 124
 125 </HTML>