httemplate/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
126
127
128
129
130
131
132

<HTML>
<HEAD>
<TITLE>FS::SignupClient - Freeside signup client API</TITLE>
<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>
	<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</P>
<P>
<HR>
<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'            =&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,
    'referral_custnum' =&gt; $referral_custnum,
    '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>
<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>
<DL>
<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>
<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="bugs">BUGS</A></H1>
<P>
<HR>
<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>

</HTML>