htdocs/docs/man/FS/SignupClient.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

<HTML>
<HEAD>
<TITLE>FS::SignupClient - Freeside signup client API</TITLE>
<LINK REV="made" HREF="mailto:none">
</HEAD>

<BODY>

<!-- 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>
</UL>
<!-- INDEX END -->

<HR>
<P>
<H1><A NAME="NAME">NAME</A></H1>
<P>
FS::SignupClient - Freeside signup client API

<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'          =&gt; $first,
    'last'           =&gt; $last,
    'ss'             =&gt; $ss,
    'comapny'        =&gt; $company,
    'address1'       =&gt; $address1,
    'address2'       =&gt; $address2,
    'city'           =&gt; $city,
    'county'         =&gt; $county,
    'state'          =&gt; $state,
    'zip'            =&gt; $zip,
    'country'        =&gt; $country,
    'daytime'        =&gt; $daytime,
    'night'          =&gt; $night,
    'fax'            =&gt; $fax,
    'payby'          =&gt; $payby,
    'payinfo'        =&gt; $payinfo,
    'paydate'        =&gt; $paydate,
    'payname'        =&gt; $payname,
    'invoicing_list' =&gt; $invoicing_list,
    'pkgpart'        =&gt; $pkgpart,
    'username'       =&gt; $username,
    '_password'       =&gt; $password,
    'popnum'         =&gt; $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.

<P>
<HR>
<H1><A NAME="SUBROUTINES">SUBROUTINES</A></H1>
<DL>
<DT><STRONG><A NAME="item_signup_info">signup_info</A></STRONG><DD>
<P>
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>
<HR>
<H1><A NAME="VERSION">VERSION</A></H1>
<P>
$Id: SignupClient.html,v 1.1 2001-04-23 12:41:57 ivan Exp $

<P>
<HR>
<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>


</BODY>

</HTML>