httemplate/docs/man/FS/SignupClient.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>FS::SignupClient - Freeside signup client API</TITLE>
   4 <LINK REV="made" HREF="mailto:perl@packages.debian.org">
   5 </HEAD>
   6
   7 <BODY>
   8
   9 <A NAME="__index__"></A>
  10 <!-- INDEX BEGIN -->
  11
  12 <UL>
  13
  14         <LI><A HREF="#name">NAME</A></LI>
  15         <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  16         <LI><A HREF="#description">DESCRIPTION</A></LI>
  17         <LI><A HREF="#subroutines">SUBROUTINES</A></LI>
  18         <LI><A HREF="#bugs">BUGS</A></LI>
  19         <LI><A HREF="#see also">SEE ALSO</A></LI>
  20 </UL>
  21 <!-- INDEX END -->
  22
  23 <HR>
  24 <P>
  25 <H1><A NAME="name">NAME</A></H1>
  26 <P>FS::SignupClient - Freeside signup client API</P>
  27 <P>
  28 <HR>
  29 <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  30 <PRE>
  31   use FS::SignupClient qw( signup_info new_customer );</PRE>
  32 <PRE>
  33   ( $locales, $packages, $pops ) = signup_info;</PRE>
  34 <PRE>
  35   $error = new_customer ( {
  36     'first'            =&gt; $first,
  37     'last'             =&gt; $last,
  38     'ss'               =&gt; $ss,
  39     'comapny'          =&gt; $company,
  40     'address1'         =&gt; $address1,
  41     'address2'         =&gt; $address2,
  42     'city'             =&gt; $city,
  43     'county'           =&gt; $county,
  44     'state'            =&gt; $state,
  45     'zip'              =&gt; $zip,
  46     'country'          =&gt; $country,
  47     'daytime'          =&gt; $daytime,
  48     'night'            =&gt; $night,
  49     'fax'              =&gt; $fax,
  50     'payby'            =&gt; $payby,
  51     'payinfo'          =&gt; $payinfo,
  52     'paydate'          =&gt; $paydate,
  53     'payname'          =&gt; $payname,
  54     'invoicing_list'   =&gt; $invoicing_list,
  55     'referral_custnum' =&gt; $referral_custnum,
  56     'pkgpart'          =&gt; $pkgpart,
  57     'username'         =&gt; $username,
  58     '_password'        =&gt; $password,
  59     'popnum'           =&gt; $popnum,
  60   } );</PRE>
  61 <P>
  62 <HR>
  63 <H1><A NAME="description">DESCRIPTION</A></H1>
  64 <P>This module provides an API for a remote signup server.</P>
  65 <P>It needs to be run as the freeside user.  Because of this, the program which
  66 calls these subroutines should be written very carefully.</P>
  67 <P>
  68 <HR>
  69 <H1><A NAME="subroutines">SUBROUTINES</A></H1>
  70 <DL>
  71 <DT><STRONG><A NAME="item_signup_info">signup_info</A></STRONG><BR>
  72 <DD>
  73 Returns three array references of hash references.
  74 <P>The first set of hash references is of allowable locales.  Each hash reference
  75 has the following keys:
  76   taxnum
  77   state
  78   county
  79   country</P>
  80 <P>The second set of hash references is of allowable packages.  Each hash
  81 reference has the following keys:
  82   pkgpart
  83   pkg</P>
  84 <P>The third set of hash references is of allowable POPs (Points Of Presence).
  85 Each hash reference has the following keys:
  86   popnum
  87   city
  88   state
  89   ac
  90   exch</P>
  91 <P></P>
  92 <DT><STRONG><A NAME="item_new_customer_HASHREF">new_customer HASHREF</A></STRONG><BR>
  93 <DD>
  94 Adds a customer to the remote Freeside system.  Requires a hash reference as
  95 a paramater with the following keys:
  96   first
  97   last
  98   ss
  99   comapny
 100   address1
 101   address2
 102   city
 103   county
 104   state
 105   zip
 106   country
 107   daytime
 108   night
 109   fax
 110   payby
 111   payinfo
 112   paydate
 113   payname
 114   invoicing_list
 115   referral_custnum
 116   pkgpart
 117   username
 118   _password
 119   popnum
 120 <P>Returns a scalar error message, or the empty string for success.</P>
 121 <P></P></DL>
 122 <P>
 123 <HR>
 124 <H1><A NAME="bugs">BUGS</A></H1>
 125 <P>
 126 <HR>
 127 <H1><A NAME="see also">SEE ALSO</A></H1>
 128 <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>
 129
 130 </BODY>
 131
 132 </HTML>