1 package FS::SelfService;
4 use vars qw( $VERSION @ISA @EXPORT_OK $DEBUG
5 $skip_uid_check $dir $socket %autoload $tag );
11 use Storable 2.09 qw(nstore_fd fd_retrieve);
15 @ISA = qw( Exporter );
19 $dir = "/usr/local/freeside";
20 $socket = "$dir/selfservice_socket";
21 $socket .= '.'.$tag if defined $tag && length($tag);
23 #maybe should ask ClientAPI for this list
25 'passwd' => 'passwd/passwd',
26 'chfn' => 'passwd/passwd',
27 'chsh' => 'passwd/passwd',
28 'login_info' => 'MyAccount/login_info',
29 'login_banner_image' => 'MyAccount/login_banner_image',
30 'login' => 'MyAccount/login',
31 'logout' => 'MyAccount/logout',
32 'switch_acct' => 'MyAccount/switch_acct',
33 'customer_info' => 'MyAccount/customer_info',
34 'customer_info_short' => 'MyAccount/customer_info_short',
36 'contact_passwd' => 'MyAccount/contact/contact_passwd',
37 'list_contacts' => 'MyAccount/contact/list_contacts',
38 'edit_contact' => 'MyAccount/contact/edit_contact',
39 'delete_contact' => 'MyAccount/contact/delete_contact',
40 'new_contact' => 'MyAccount/contact/new_contact',
42 'billing_history' => 'MyAccount/billing_history',
43 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
44 'invoice' => 'MyAccount/invoice',
45 'invoice_pdf' => 'MyAccount/invoice_pdf',
46 'legacy_invoice' => 'MyAccount/legacy_invoice',
47 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
48 'invoice_logo' => 'MyAccount/invoice_logo',
49 'list_invoices' => 'MyAccount/list_invoices', #?
50 'cancel' => 'MyAccount/cancel', #add to ss cgi!
51 'payment_info' => 'MyAccount/payment_info',
52 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
53 'process_payment' => 'MyAccount/process_payment',
54 'store_payment' => 'MyAccount/store_payment',
55 'process_stored_payment' => 'MyAccount/process_stored_payment',
56 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
57 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
58 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
59 'process_prepay' => 'MyAccount/process_prepay',
60 'realtime_collect' => 'MyAccount/realtime_collect',
61 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
62 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
63 'list_svc_usage' => 'MyAccount/list_svc_usage',
64 'svc_status_html' => 'MyAccount/svc_status_html',
65 'svc_status_hash' => 'MyAccount/svc_status_hash',
66 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
67 'set_svc_status_listadd' => 'MyAccount/set_svc_status_listadd',
68 'set_svc_status_listdel' => 'MyAccount/set_svc_status_listdel',
69 'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
70 'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
71 'acct_forward_info' => 'MyAccount/acct_forward_info',
72 'process_acct_forward' => 'MyAccount/process_acct_forward',
73 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
74 'add_dsl_device' => 'MyAccount/add_dsl_device',
75 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
76 'port_graph' => 'MyAccount/port_graph',
77 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
78 'list_support_usage' => 'MyAccount/list_support_usage',
79 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
80 'change_pkg' => 'MyAccount/change_pkg',
81 'order_recharge' => 'MyAccount/order_recharge',
82 'renew_info' => 'MyAccount/renew_info',
83 'order_renew' => 'MyAccount/order_renew',
84 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
85 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
86 'charge' => 'MyAccount/charge', #?
87 'part_svc_info' => 'MyAccount/part_svc_info',
88 'provision_acct' => 'MyAccount/provision_acct',
89 'provision_phone' => 'MyAccount/provision_phone',
90 'provision_pbx' => 'MyAccount/provision_pbx',
91 'provision_external' => 'MyAccount/provision_external',
92 'provision_forward' => 'MyAccount/provision_forward',
93 'unprovision_svc' => 'MyAccount/unprovision_svc',
94 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
95 'reset_passwd' => 'MyAccount/reset_passwd',
96 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
97 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
98 'validate_passwd' => 'MyAccount/validate_passwd',
99 'list_tickets' => 'MyAccount/list_tickets',
100 'create_ticket' => 'MyAccount/create_ticket',
101 'get_ticket' => 'MyAccount/get_ticket',
102 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
103 'did_report' => 'MyAccount/did_report',
104 'signup_info' => 'Signup/signup_info',
105 'skin_info' => 'MyAccount/skin_info',
106 'access_info' => 'MyAccount/access_info',
107 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
108 'new_customer' => 'Signup/new_customer',
109 'new_customer_minimal' => 'Signup/new_customer_minimal',
110 'capture_payment' => 'Signup/capture_payment',
111 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
112 'new_agent' => 'Agent/new_agent',
113 'agent_login' => 'Agent/agent_login',
114 'agent_logout' => 'Agent/agent_logout',
115 'agent_info' => 'Agent/agent_info',
116 'agent_list_customers' => 'Agent/agent_list_customers',
117 'check_username' => 'Agent/check_username',
118 'suspend_username' => 'Agent/suspend_username',
119 'unsuspend_username' => 'Agent/unsuspend_username',
120 'mason_comp' => 'MasonComponent/mason_comp',
121 'call_time' => 'PrepaidPhone/call_time',
122 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
123 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
125 'start_thirdparty' => 'MyAccount/start_thirdparty',
126 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
128 'list_quotations' => 'MyAccount/quotation/list_quotations',
129 'quotation_new' => 'MyAccount/quotation/quotation_new',
130 'quotation_delete' => 'MyAccount/quotation/quotation_delete',
131 'quotation_info' => 'MyAccount/quotation/quotation_info',
132 'quotation_print' => 'MyAccount/quotation/quotation_print',
133 'quotation_add_pkg' => 'MyAccount/quotation/quotation_add_pkg',
134 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg',
135 'quotation_order' => 'MyAccount/quotation/quotation_order',
137 'freesideinc_service' => 'Freeside/freesideinc_service',
142 qw( regionselector regionselector_hashref location_form
143 expselect popselector domainselector didselector
147 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
148 $ENV{'SHELL'} = '/bin/sh';
149 $ENV{'IFS'} = " \t\n";
152 $ENV{'BASH_ENV'} = '';
154 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
155 #if you grant appropriate permissions to whatever user
156 my $freeside_uid = scalar(getpwnam('freeside'));
157 die "not running as the freeside user\n"
158 if $> != $freeside_uid && ! $skip_uid_check;
160 -e $dir or die "FATAL: $dir doesn't exist!";
161 -d $dir or die "FATAL: $dir isn't a directory!";
162 -r $dir or die "FATAL: Can't read $dir as freeside user!";
163 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
165 foreach my $autoload ( keys %autoload ) {
168 "sub $autoload { ". '
173 #warn scalar(@_). ": ". join(" / ", @_);
177 $param->{_packet} = \''. $autoload{$autoload}. '\';
179 simple_packet($param);
189 warn "sending ". $packet->{_packet}. " to server"
191 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
192 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
193 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
196 #shoudl trap: Magic number checking on storable file failed at blib/lib/Storable.pm (autosplit into blib/lib/auto/Storable/fd_retrieve.al) line 337, at /usr/local/share/perl/5.6.1/FS/SelfService.pm line 71
198 #block until there is a message on socket
199 # my $w = new IO::Select;
201 # my @wait = $w->can_read;
203 warn "reading message from server"
206 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
207 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
209 warn "returning message to client"
217 FS::SelfService - Freeside self-service API
221 # password and shell account changes
222 use FS::SelfService qw(passwd chfn chsh);
224 # "my account" functionality
225 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
227 #new-style login with an email address and password
228 # can also be used for svc_acct login, set $emailaddress to username@domain
229 my $rv = login ( { 'email' => $emailaddress,
230 'password' => $password,
233 if ( $rv->{'error'} ) {
234 #handle login error...
237 $session_id = $rv->{'session_id'};
240 #classic svc_acct-based login with separate username and password
241 my $rv = login( { 'username' => $username,
243 'password' => $password,
246 if ( $rv->{'error'} ) {
247 #handle login error...
250 $session_id = $rv->{'session_id'};
253 #svc_phone login with phone number and PIN
254 my $rv = login( { 'username' => $phone_number,
255 'domain' => 'svc_phone',
259 if ( $rv->{'error'} ) {
260 #handle login error...
263 $session_id = $rv->{'session_id'};
266 my $customer_info = customer_info( { 'session_id' => $session_id } );
268 #payment_info and process_payment are available in 1.5+ only
269 my $payment_info = payment_info( { 'session_id' => $session_id } );
271 #!!! process_payment example
273 #!!! list_pkgs example
275 #!!! order_pkg example
277 #quoting a package, then ordering after confirmation
279 my $rv = quotation_new({ 'session_id' => $session_id });
280 my $qnum = $rv->{quotationnum};
281 # add packages to the quotation
282 $rv = quotation_add_pkg({ 'session_id' => $session_id,
283 'quotationnum' => $qnum,
284 'pkgpart' => $pkgpart,
285 'quantity' => $quantity, # defaults to 1
287 # repeat until all packages are added
288 # view the pricing information
289 $rv = quotation_info({ 'session_id' => $session_id,
290 'quotationnum' => $qnum,
292 print "Total setup charges: ".$rv->{total_setup}."\n".
293 "Total recurring charges: ".$rv->{total_recur}."\n";
294 # quotation_info also provides a detailed breakdown of charges, in
297 # ask customer for confirmation, then:
298 $rv = quotation_order({ 'session_id' => $session_id,
299 'quotationnum' => $qnum,
302 #!!! cancel_pkg example
304 # signup functionality
305 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
307 my $signup_info = signup_info;
309 $rv = new_customer( {
312 'company' => $company,
313 'address1' => $address1,
314 'address2' => $address2,
318 'country' => $country,
319 'daytime' => $daytime,
323 'payinfo' => $payinfo,
325 'paystart_month' => $paystart_month
326 'paystart_year' => $paystart_year,
327 'payissue' => $payissue,
329 'paydate' => $paydate,
330 'payname' => $payname,
331 'invoicing_list' => $invoicing_list,
332 'referral_custnum' => $referral_custnum,
333 'agentnum' => $agentnum,
334 'pkgpart' => $pkgpart,
336 'username' => $username,
337 '_password' => $password,
341 'phonenum' => $phonenum,
346 my $error = $rv->{'error'};
347 if ( $error eq '_decline' ) {
357 Use this API to implement your own client "self-service" module.
359 If you just want to customize the look of the existing "self-service" module,
362 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
368 Changes the password for an existing user in svc_acct. Takes a hash
369 reference with the following keys:
375 Username of the account (required)
379 Domain of the account (required)
383 Old password (required)
387 New password (required)
405 =head1 "MY ACCOUNT" FUNCTIONS
411 Creates a user session. Takes a hash reference as parameter with the
418 Email address (username@domain), instead of username and domain. Required for
419 contact-based self-service login, can also be used for svc_acct-based login.
435 Returns a hash reference with the following keys:
441 Empty on success, or an error message on errors.
445 Session identifier for successful logins
449 =item customer_info HASHREF
451 Returns general customer information.
453 Takes a hash reference as parameter with a single key: B<session_id>
455 Returns a hash reference with the following keys:
469 Array reference of hash references of open inoices. Each hash reference has
470 the following keys: invnum, date, owed
474 An HTML fragment containing shipping and billing addresses.
476 =item The following fields are also returned
478 first last company address1 address2 city county state zip country daytime night fax ship_first ship_last ship_company ship_address1 ship_address2 ship_city ship_state ship_zip ship_country ship_daytime ship_night ship_fax payby payinfo payname month year invoicing_list postal_invoicing
482 =item edit_info HASHREF
484 Takes a hash reference as parameter with any of the following keys:
486 first last company address1 address2 city county state zip country daytime night fax ship_first ship_last ship_company ship_address1 ship_address2 ship_city ship_state ship_zip ship_country ship_daytime ship_night ship_fax payby payinfo paycvv payname month year invoicing_list postal_invoicing
488 If a field exists, the customer record is updated with the new value of that
489 field. If a field does not exist, that field is not changed on the customer
492 Returns a hash reference with a single key, B<error>, empty on success, or an
493 error message on errors
495 =item invoice HASHREF
497 Returns an invoice. Takes a hash reference as parameter with two keys:
498 session_id and invnum
500 Returns a hash reference with the following keys:
506 Empty on success, or an error message on errors
518 =item list_invoices HASHREF
520 Returns a list of all customer invoices. Takes a hash reference with a single
523 Returns a hash reference with the following keys:
529 Empty on success, or an error message on errors
533 Reference to array of hash references with the following keys:
543 Invoice date, in UNIX epoch time
551 Cancels this customer.
553 Takes a hash reference as parameter with a single key: B<session_id>
555 Returns a hash reference with a single key, B<error>, which is empty on
556 success or an error message on errors.
558 =item payment_info HASHREF
560 Returns information that may be useful in displaying a payment page.
562 Takes a hash reference as parameter with a single key: B<session_id>.
564 Returns a hash reference with the following keys:
570 Empty on success, or an error message on errors
578 Exact name on credit card (CARD/DCRD)
602 Customer's current default payment type.
606 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
610 For CARD/DCRD payment types, the card number
614 For CARD/DCRD payment types, expiration month
618 For CARD/DCRD payment types, expiration year
620 =item cust_main_county
622 County/state/country data - array reference of hash references, each of which has the fields of a cust_main_county record (see L<FS::cust_main_county>). Note these are not FS::cust_main_county objects, but hash references of columns and values.
626 Array reference of all states in the current default country.
630 Hash reference of card types; keys are card types, values are the exact strings
631 passed to the process_payment function
635 #this doesn't actually work yet
639 #Unique transaction identifier (prevents multiple charges), passed to the
640 #process_payment function
644 =item process_payment HASHREF
646 Processes a payment and possible change of address or payment type. Takes a
647 hash reference as parameter with the following keys:
661 If true, address and card information entered will be saved for subsequent
666 If true, future credit card payments will be done automatically (sets payby to
667 CARD). If false, future credit card payments will be done on-demand (sets
668 payby to DCRD). This option only has meaning if B<save> is set true.
696 Two-letter country code
704 Card expiration month
712 #this doesn't actually work yet
716 #Unique transaction identifier, returned from the payment_info function.
717 #Prevents multiple charges.
721 Returns a hash reference with a single key, B<error>, empty on success, or an
722 error message on errors.
724 =item process_payment_order_pkg
726 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
727 payment processes sucessfully, the package is ordered. Takes a hash reference
728 as parameter with the keys of both methods.
730 Returns a hash reference with a single key, B<error>, empty on success, or an
731 error message on errors.
733 =item process_payment_change_pkg
735 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
736 payment processes sucessfully, the package is ordered. Takes a hash reference
737 as parameter with the keys of both methods.
739 Returns a hash reference with a single key, B<error>, empty on success, or an
740 error message on errors.
743 =item process_payment_order_renew
745 Combines the B<process_payment> and B<order_renew> functions in one step. If
746 the payment processes sucessfully, the renewal is processed. Takes a hash
747 reference as parameter with the keys of both methods.
749 Returns a hash reference with a single key, B<error>, empty on success, or an
750 error message on errors.
754 Returns package information for this customer. For more detail on services,
757 Takes a hash reference as parameter with a single key: B<session_id>
759 Returns a hash reference containing customer package information. The hash reference contains the following keys:
769 Empty on success, or an error message on errors.
771 =item cust_pkg HASHREF
773 Array reference of hash references, each of which has the fields of a cust_pkg
774 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
775 the internal FS:: objects, but hash references of columns and values.
779 =item part_pkg fields
781 All fields of part_pkg for this specific cust_pkg (be careful with this
782 information - it may reveal more about your available packages than you would
783 like users to know in aggregate)
787 #XXX pare part_pkg fields down to a more secure subset
791 An array of hash references indicating information on unprovisioned services
792 available for provisioning for this specific cust_pkg. Each has the following
797 =item part_svc fields
799 All fields of part_svc (be careful with this information - it may reveal more
800 about your available packages than you would like users to know in aggregate)
804 #XXX pare part_svc fields down to a more secure subset
810 An array of hash references indicating information on the customer services
811 already provisioned for this specific cust_pkg. Each has the following keys:
817 Array reference with three elements: The first element is the name of this service. The second element is a meaningful user-specific identifier for the service (i.e. username, domain or mail alias). The last element is the table name of this service.
823 Primary key for this service
827 Service definition (see L<FS::part_svc>)
831 Customer package (see L<FS::cust_pkg>)
835 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
843 Returns service information for this customer.
845 Takes a hash reference as parameter with a single key: B<session_id>
847 Returns a hash reference containing customer package information. The hash reference contains the following keys:
857 An array of hash references indicating information on all of this customer's
858 services. Each has the following keys:
864 Primary key for this service
872 Meaningful user-specific identifier for the service (i.e. username, domain, or
877 Account (svc_acct) services also have the following keys:
895 Upload bytes remaining
899 Download bytes remaining
903 Total bytes remaining
905 =item recharge_amount
909 =item recharge_seconds
911 Number of seconds gained by recharge
913 =item recharge_upbytes
915 Number of upload bytes gained by recharge
917 =item recharge_downbytes
919 Number of download bytes gained by recharge
921 =item recharge_totalbytes
923 Number of total bytes gained by recharge
931 Orders a package for this customer.
933 Takes a hash reference as parameter with the following keys:
943 Package to order (see L<FS::part_pkg>).
947 Quantity for this package order (default 1).
951 Optional locationnum for this package order, for existing locations.
953 Or, for new locations, pass the following fields: address1*, address2, city*,
954 county, state*, zip*, country. (* = required in this case)
966 Service to order (see L<FS::part_svc>).
968 Normally optional; required only to provision a non-svc_acct service, or if the
969 package definition does not contain one svc_acct service definition with
970 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
971 also be specified to indicate that no initial service should be provisioned.
975 Fields used when provisioning an svc_acct service:
989 Optional security phrase
993 Optional Access number number
997 Fields used when provisioning an svc_domain service:
1007 Fields used when provisioning an svc_phone service:
1025 Fields used when provisioning an svc_external service:
1031 External numeric ID.
1035 External text title.
1039 Fields used when provisioning an svc_pbx service:
1053 Returns a hash reference with a single key, B<error>, empty on success, or an
1054 error message on errors. The special error '_decline' is returned for
1055 declined transactions.
1059 Changes a package for this customer.
1061 Takes a hash reference as parameter with the following keys:
1071 Existing customer package.
1075 New package to order (see L<FS::part_pkg>).
1079 Quantity for this package order (default 1).
1083 Returns a hash reference with the following keys:
1089 Empty on success, or an error message on errors.
1093 On success, the new pkgnum
1100 Provides useful info for early renewals.
1102 Takes a hash reference as parameter with the following keys:
1112 Returns a hash reference. On errors, it contains a single key, B<error>, with
1113 the error message. Otherwise, contains a single key, B<dates>, pointing to
1114 an array refernce of hash references. Each hash reference contains the
1121 (Future) Bill date. Indicates a future date for which billing could be run.
1122 Specified as a integer UNIX timestamp. Pass this value to the B<order_renew>
1125 =item bill_date_pretty
1127 (Future) Bill date as a human-readable string. (Convenience for display;
1128 subject to change, so best not to parse for the date.)
1132 Base amount which will be charged if renewed early as of this date.
1136 Renewal date; i.e. even-futher future date at which the customer will be paid
1137 through if the early renewal is completed with the given B<bill-date>.
1138 Specified as a integer UNIX timestamp.
1140 =item renew_date_pretty
1142 Renewal date as a human-readable string. (Convenience for display;
1143 subject to change, so best not to parse for the date.)
1147 Package that will be renewed.
1151 Expiration date of the package that will be renewed.
1153 =item expire_date_pretty
1155 Expiration date of the package that will be renewed, as a human-readable
1156 string. (Convenience for display; subject to change, so best not to parse for
1163 Renews this customer early; i.e. runs billing for this customer in advance.
1165 Takes a hash reference as parameter with the following keys:
1175 Integer date as returned by the B<renew_info> function, indicating the advance
1176 date for which to run billing.
1180 Returns a hash reference with a single key, B<error>, empty on success, or an
1181 error message on errors.
1185 Cancels a package for this customer.
1187 Takes a hash reference as parameter with the following keys:
1197 pkgpart of package to cancel
1201 Returns a hash reference with a single key, B<error>, empty on success, or an
1202 error message on errors.
1204 =item provision_acct
1206 Provisions an account (svc_acct).
1208 Takes a hash reference as parameter with the following keys:
1218 pkgnum of package into which this service is provisioned
1222 svcpart or service definition to provision
1232 =item provision_phone
1234 Provisions a phone number (svc_phone).
1236 Takes a hash reference as parameter with the following keys:
1246 pkgnum of package into which this service is provisioned
1250 svcpart or service definition to provision
1270 E911 Address (optional)
1276 Provisions a customer PBX (svc_pbx).
1278 Takes a hash reference as parameter with the following keys:
1288 pkgnum of package into which this service is provisioned
1292 svcpart or service definition to provision
1298 =item max_extensions
1300 =item max_simultaneous
1306 =item provision_external
1308 Provisions an external service (svc_external).
1310 Takes a hash reference as parameter with the following keys:
1320 pkgnum of package into which this service is provisioned
1324 svcpart or service definition to provision
1334 =head2 "MY ACCOUNT" CONTACT FUNCTIONS
1338 =item contact_passwd
1340 Changes the password for the currently-logged in contact.
1342 Takes a hash reference as parameter with the following keys:
1352 Returns a hash reference with a single parameter, B<error>, which contains an
1353 error message, or empty on success.
1357 Takes a hash reference as parameter with a single key, B<session_id>.
1359 Returns a hash reference with two parameters: B<error>, which contains an error
1360 message, or empty on success, and B<contacts>, a list of contacts.
1362 B<contacts> is an array reference of hash references (i.e. an array of structs,
1363 in XML-RPC). Each hash reference (struct) has the following keys:
1371 Contact class name (contact type).
1383 Position ("Director of Silly Walks"), NOT honorific ("Mr." or "Mrs.")
1387 Comma-separated list of email addresses
1391 =item selfservice_access
1399 Updates information for the currently-logged in contact, or (optionally) the
1402 Takes a hash reference as parameter with the following keys:
1410 If already logged in as a contact, this is optional.
1420 Returns a hash reference with a single parameter, B<error>, which contains an
1421 error message, or empty on success.
1425 Creates a new contact.
1427 Takes a hash reference as parameter with the following keys:
1441 Optional contact classnum (TODO: or name)
1445 =item selfservice_access
1447 Y to enable self-service access
1453 Returns a hash reference with a single parameter, B<error>, which contains an
1454 error message, or empty on success.
1456 =item delete_contact
1458 Deletes a contact. (Note: Cannot at this time delete the currently-logged in
1461 Takes a hash reference as parameter with the following keys:
1471 Returns a hash reference with a single parameter, B<error>, which contains an
1472 error message, or empty on success.
1474 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1476 All of these functions require the user to be logged in, and the 'session_id'
1477 key to be included in the argument hashref.`
1481 =item list_quotations HASHREF
1483 Returns a hashref listing this customer's active self-service quotations.
1490 an arrayref containing an element for each quotation.
1498 the date it was started
1502 the number of packages
1506 the sum of setup fees
1510 the sum of recurring charges
1514 =item quotation_new HASHREF
1516 Creates an empty quotation and returns a hashref containing 'quotationnum',
1517 the primary key of the new quotation.
1519 =item quotation_delete HASHREF
1521 Disables (does not really delete) a quotation. Takes the following arguments:
1527 =item quotationnum - the quotation to delete
1531 Returns 'error' => a string, which will be empty on success.
1533 =item quotation_info HASHREF
1535 Returns total and detailed pricing information on a quotation.
1537 Takes the following arguments:
1543 =item quotationnum - the quotation to return
1547 Returns a hashref containing:
1549 - total_setup, the total of setup fees (and their taxes)
1550 - total_recur, the total of all recurring charges (and their taxes)
1551 - sections, an arrayref containing an element for each quotation section.
1552 - description, a line of text describing the group of charges
1553 - subtotal, the total of charges in this group (if appropriate)
1554 - detail_items, an arrayref of line items
1555 - pkgnum, the reference number of the package
1556 - description, the package name (or tax name)
1558 - amount, the amount charged
1559 If the detail item represents a subtotal, it will instead contain:
1560 - total_item: description of the subtotal
1561 - total_amount: the subtotal amount
1564 =item quotation_print HASHREF
1566 Renders the quotation as HTML or PDF. Takes the following arguments:
1572 =item quotationnum - the quotation to return
1574 =item format - 'html' or 'pdf'
1578 Returns a hashref containing 'document', the contents of the file.
1580 =item quotation_add_pkg HASHREF
1582 Adds a package to a quotation. Takes the following arguments:
1588 =item pkgpart - the package to add
1590 =item quotationnum - the quotation to add it to
1592 =item quantity - the package quantity (defaults to 1)
1594 =item address1, address2, city, state, zip, country - address fields to set
1595 the service location
1599 Returns 'error' => a string, which will be empty on success.
1601 =item quotation_remove_pkg HASHREF
1603 Removes a package from a quotation. Takes the following arguments:
1609 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1611 =item quotationnum - the quotation to remove it from
1615 Returns 'error' => a string, which will be empty on success.
1619 =item quotation_order HASHREF
1621 Converts the packages in a quotation into real packages. Takes the following
1624 Takes the following arguments:
1630 =item quotationnum - the quotation to order
1636 =head1 SIGNUP FUNCTIONS
1640 =item signup_info HASHREF
1642 Takes a hash reference as parameter with the following keys:
1646 =item session_id - Optional agent/reseller interface session
1650 Returns a hash reference containing information that may be useful in
1651 displaying a signup page. The hash reference contains the following keys:
1655 =item cust_main_county
1657 County/state/country data - array reference of hash references, each of which has the fields of a cust_main_county record (see L<FS::cust_main_county>). Note these are not FS::cust_main_county objects, but hash references of columns and values.
1661 Available packages - array reference of hash references, each of which has the fields of a part_pkg record (see L<FS::part_pkg>). Each hash reference also has an additional 'payby' field containing an array reference of acceptable payment types specific to this package (see below and L<FS::part_pkg/payby>). Note these are not FS::part_pkg objects, but hash references of columns and values. Requires the 'signup_server-default_agentnum' configuration value to be set, or
1662 an agentnum specified explicitly via reseller interface session_id in the
1667 Array reference of hash references, each of which has the fields of an agent record (see L<FS::agent>). Note these are not FS::agent objects, but hash references of columns and values.
1669 =item agentnum2part_pkg
1671 Hash reference; keys are agentnums, values are array references of available packages for that agent, in the same format as the part_pkg arrayref above.
1675 Access numbers - array reference of hash references, each of which has the fields of an svc_acct_pop record (see L<FS::svc_acct_pop>). Note these are not FS::svc_acct_pop objects, but hash references of columns and values.
1677 =item security_phrase
1679 True if the "security_phrase" feature is enabled
1683 Array reference of acceptable payment types for signup
1689 credit card - automatic
1693 credit card - on-demand - version 1.5+ only
1697 electronic check - automatic
1701 electronic check - on-demand - version 1.5+ only
1709 billing, not recommended for signups
1713 free, definitely not recommended for signups
1717 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1723 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1727 Hash reference of message catalog values, to support error message customization. Currently available keys are: passwords_dont_match, invalid_card, unknown_card_type, and not_a (as in "Not a Discover card"). Values are configured in the web interface under "View/Edit message catalog".
1733 =item countrydefault
1739 =item new_customer_minimal HASHREF
1741 Creates a new customer.
1743 Current differences from new_customer: An address is not required. promo_code
1744 and reg_code are not supported. If invoicing_list and _password is passed, a
1745 contact will be created with self-service access (no pkgpart or username is
1746 necessary). No initial billing is run (this may change in a future version).
1748 Takes a hash reference as parameter with the following keys:
1754 first name (required)
1758 last name (required)
1762 (not typically collected; mostly used for ACH transactions)
1794 Daytime phone number
1798 Evening phone number
1806 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1810 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1814 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1818 Expiration date for CARD/DCRD
1822 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1824 =item invoicing_list
1826 comma-separated list of email addresses for email invoices. The special value 'POST' is used to designate postal invoicing (it may be specified alone or in addition to email addresses),
1828 =item referral_custnum
1830 referring customer number
1838 pkgpart of initial package
1854 Access number (index, not the literal number)
1858 Country code (to be provisioned as a service)
1862 Phone number (to be provisioned as a service)
1870 Returns a hash reference with the following keys:
1876 Empty on success, or an error message on errors. The special error '_decline' is returned for declined transactions; other error messages should be suitable for display to the user (and are customizable in under Configuration | View/Edit message catalog)
1880 =item new_customer HASHREF
1882 Creates a new customer. Takes a hash reference as parameter with the
1889 first name (required)
1893 last name (required)
1897 (not typically collected; mostly used for ACH transactions)
1903 =item address1 (required)
1911 =item city (required)
1919 =item state (required)
1923 =item zip (required)
1929 Daytime phone number
1933 Evening phone number
1941 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1945 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1949 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1953 Expiration date for CARD/DCRD
1957 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1959 =item invoicing_list
1961 comma-separated list of email addresses for email invoices. The special value 'POST' is used to designate postal invoicing (it may be specified alone or in addition to email addresses),
1963 =item referral_custnum
1965 referring customer number
1973 pkgpart of initial package
1989 Access number (index, not the literal number)
1993 Country code (to be provisioned as a service)
1997 Phone number (to be provisioned as a service)
2005 Returns a hash reference with the following keys:
2011 Empty on success, or an error message on errors. The special error '_decline' is returned for declined transactions; other error messages should be suitable for display to the user (and are customizable in under Configuration | View/Edit message catalog)
2015 =item regionselector HASHREF | LIST
2017 Takes as input a hashref or list of key/value pairs with the following keys:
2021 =item selected_county
2023 Currently selected county
2025 =item selected_state
2027 Currently selected state
2029 =item selected_country
2031 Currently selected country
2035 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2039 Specify a javascript subroutine to call on changes
2045 =item default_country
2051 An arrayref of hash references specifying regions. Normally you can just pass the value of the I<cust_main_county> field returned by B<signup_info>.
2055 Returns a list consisting of three HTML fragments for county selection,
2056 state selection and country selection, respectively.
2060 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
2061 sub regionselector {
2068 $param->{'selected_country'} ||= $param->{'default_country'};
2069 $param->{'selected_state'} ||= $param->{'default_state'};
2071 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2075 my %cust_main_county;
2077 # unless ( @cust_main_county ) { #cache
2078 #@cust_main_county = qsearch('cust_main_county', {} );
2079 #foreach my $c ( @cust_main_county ) {
2080 foreach my $c ( @{ $param->{'locales'} } ) {
2081 #$countyflag=1 if $c->county;
2082 $countyflag=1 if $c->{county};
2083 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
2084 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
2085 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
2088 $countyflag=1 if $param->{selected_county};
2090 my $script_html = <<END;
2092 function opt(what,value,text) {
2093 var optionName = new Option(text, value, false, false);
2094 var length = what.length;
2095 what.options[length] = optionName;
2097 function ${prefix}country_changed(what) {
2098 country = what.options[what.selectedIndex].text;
2099 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
2100 what.form.${prefix}state.options[i] = null;
2102 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
2104 foreach my $country ( sort keys %cust_main_county ) {
2105 $script_html .= "\nif ( country == \"$country\" ) {\n";
2106 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2107 my $text = $state || '(n/a)';
2108 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
2110 $script_html .= "}\n";
2113 $script_html .= <<END;
2115 function ${prefix}state_changed(what) {
2118 if ( $countyflag ) {
2119 $script_html .= <<END;
2120 state = what.options[what.selectedIndex].text;
2121 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
2122 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
2123 what.form.${prefix}county.options[i] = null;
2126 foreach my $country ( sort keys %cust_main_county ) {
2127 $script_html .= "\nif ( country == \"$country\" ) {\n";
2128 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2129 $script_html .= "\nif ( state == \"$state\" ) {\n";
2130 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
2131 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
2132 my $text = $county || '(n/a)';
2134 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
2136 $script_html .= "}\n";
2138 $script_html .= "}\n";
2142 $script_html .= <<END;
2147 my $county_html = $script_html;
2148 if ( $countyflag ) {
2149 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
2150 foreach my $county (
2151 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2153 my $text = $county || '(n/a)';
2154 $county_html .= qq!<OPTION VALUE="$county"!.
2155 ($county eq $param->{'selected_county'} ?
2162 $county_html .= '</SELECT>';
2165 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2168 my $state_html = qq!<SELECT NAME="${prefix}state" !.
2169 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2170 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2171 my $text = $state || '(n/a)';
2172 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2173 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
2175 $state_html .= '</SELECT>';
2177 my $country_html = '';
2178 if ( scalar( keys %cust_main_county ) > 1 ) {
2180 $country_html = qq(<SELECT NAME="${prefix}country" ).
2181 qq(onChange="${prefix}country_changed(this); ).
2182 $param->{'onchange'}.
2185 my $countrydefault = $param->{default_country} || 'US';
2186 foreach my $country (
2187 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2188 keys %cust_main_county
2190 my $selected = $country eq $param->{'selected_country'}
2193 $country_html .= "\n<OPTION$selected>$country</OPTION>"
2195 $country_html .= '</SELECT>';
2198 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2199 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2203 ($county_html, $state_html, $country_html);
2207 sub regionselector_hashref {
2208 my ($county_html, $state_html, $country_html) = regionselector(@_);
2210 'county_html' => $county_html,
2211 'state_html' => $state_html,
2212 'country_html' => $country_html,
2216 =item location_form HASHREF | LIST
2218 Takes as input a hashref or list of key/value pairs with the following keys:
2224 Current customer session_id
2228 Omit red asterisks from required fields.
2230 =item address1_label
2232 Label for first address line.
2236 Returns an HTML fragment for a location form (address, city, state, zip,
2249 my $session_id = delete $param->{'session_id'};
2251 my $rv = mason_comp( 'session_id' => $session_id,
2252 'comp' => '/elements/location.html',
2253 'args' => [ %$param ],
2257 $rv->{'error'} || $rv->{'output'};
2262 #=item expselect HASHREF | LIST
2264 #Takes as input a hashref or list of key/value pairs with the following keys:
2268 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2270 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2274 =item expselect PREFIX [ DATE ]
2276 Takes as input a unique prefix string and the current expiration date, in
2277 yyyy-mm-dd or m-d-yyyy format
2279 Returns an HTML fragments for expiration date selection.
2285 #if ( ref($_[0]) ) {
2289 #my $prefix = $param->{'prefix'};
2290 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2291 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2293 my $date = scalar(@_) ? shift : '';
2295 my( $m, $y ) = ( 0, 0 );
2296 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2297 ( $m, $y ) = ( $2, $1 );
2298 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2299 ( $m, $y ) = ( $1, $3 );
2301 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2303 $return .= qq!<OPTION VALUE="$_"!;
2304 $return .= " SELECTED" if $_ == $m;
2307 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2309 my $thisYear = $t[5] + 1900;
2310 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2311 $return .= qq!<OPTION VALUE="$_"!;
2312 $return .= " SELECTED" if $_ == $y;
2315 $return .= "</SELECT>";
2320 =item popselector HASHREF | LIST
2322 Takes as input a hashref or list of key/value pairs with the following keys:
2328 Access number number
2332 An arrayref of hash references specifying access numbers. Normally you can just pass the value of the I<svc_acct_pop> field returned by B<signup_info>.
2336 Returns an HTML fragment for access number selection.
2340 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2348 my $popnum = $param->{'popnum'};
2349 my $pops = $param->{'pops'};
2351 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2352 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2353 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2354 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2355 if scalar(@$pops) == 1;
2358 my %popnum2pop = ();
2360 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2361 $popnum2pop{$_->{popnum}} = $_;
2366 function opt(what,href,text) {
2367 var optionName = new Option(text, href, false, false)
2368 var length = what.length;
2369 what.options[length] = optionName;
2373 my $init_popstate = $param->{'init_popstate'};
2374 if ( $init_popstate ) {
2375 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2376 $init_popstate. '">';
2379 function acstate_changed(what) {
2380 state = what.options[what.selectedIndex].text;
2381 what.form.popac.options.length = 0
2382 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2386 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2387 foreach my $state ( sort { $a cmp $b } @states ) {
2388 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2390 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2391 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2392 if ($ac eq $param->{'popac'}) {
2393 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2396 $text .= "}\n" unless $init_popstate;
2398 $text .= "popac_changed(what.form.popac)}\n";
2401 function popac_changed(what) {
2402 ac = what.options[what.selectedIndex].text;
2403 what.form.popnum.options.length = 0;
2404 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2408 foreach my $state ( @states ) {
2409 foreach my $popac ( keys %{ $pop{$state} } ) {
2410 $text .= "\nif ( ac == \"$popac\" ) {\n";
2412 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2413 my $o_popnum = $pop->{popnum};
2414 my $poptext = $pop->{city}. ', '. $pop->{state}.
2415 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2417 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2418 if ($popnum == $o_popnum) {
2419 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2427 $text .= "}\n</SCRIPT>\n";
2429 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2432 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2433 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2434 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2435 ">$_" foreach sort { $a cmp $b } @states;
2436 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2439 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2440 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2442 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2445 #comment this block to disable initial list polulation
2446 my @initial_select = ();
2447 if ( scalar( @$pops ) > 100 ) {
2448 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2450 @initial_select = @$pops;
2452 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2453 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2454 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2455 $pop->{city}. ', '. $pop->{state}.
2456 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2459 $text .= qq!</SELECT></TD></TR></TABLE>!;
2465 =item domainselector HASHREF | LIST
2467 Takes as input a hashref or list of key/value pairs with the following keys:
2477 Service number of the selected item.
2481 Returns an HTML fragment for domain selection.
2485 sub domainselector {
2492 my $domsvc= $param->{'domsvc'};
2494 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2495 my $domains = $rv->{'domains'};
2496 $domsvc = $rv->{'domsvc'} unless $domsvc;
2498 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2499 unless scalar(keys %$domains);
2501 if (scalar(keys %$domains) == 1) {
2503 foreach(keys %$domains) {
2506 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2507 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2510 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2512 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2514 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2515 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2516 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2517 $domains->{$domain};
2520 $text .= qq!</SELECT></TD></TR>!;
2526 =item didselector HASHREF | LIST
2528 Takes as input a hashref or list of key/value pairs with the following keys:
2534 Field name for the returned HTML fragment.
2538 Service definition (see L<FS::part_svc>)
2542 Returns an HTML fragment for DID selection.
2554 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2555 'args'=>[ %$param ],
2559 $rv->{'error'} || $rv->{'output'};
2565 =head1 RESELLER FUNCTIONS
2567 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2568 with their active session, and the B<customer_info> and B<order_pkg> functions
2569 with their active session and an additional I<custnum> parameter.
2571 For the most part, development of the reseller web interface has been
2572 superceded by agent-virtualized access to the backend.
2584 =item agent_list_customers
2586 List agent's customers.
2594 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>