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',
35 'customer_recurring' => 'MyAccount/customer_recurring',
37 'contact_passwd' => 'MyAccount/contact/contact_passwd',
38 'list_contacts' => 'MyAccount/contact/list_contacts',
39 'edit_contact' => 'MyAccount/contact/edit_contact',
40 'delete_contact' => 'MyAccount/contact/delete_contact',
41 'new_contact' => 'MyAccount/contact/new_contact',
43 'billing_history' => 'MyAccount/billing_history',
44 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
45 'invoice' => 'MyAccount/invoice',
46 'invoice_pdf' => 'MyAccount/invoice_pdf',
47 'legacy_invoice' => 'MyAccount/legacy_invoice',
48 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
49 'invoice_logo' => 'MyAccount/invoice_logo',
50 'list_invoices' => 'MyAccount/list_invoices', #?
51 'list_payments' => 'MyAccount/list_payments',
52 'payment_receipt' => 'MyAccount/payment_receipt',
53 'cancel' => 'MyAccount/cancel', #add to ss cgi!
54 'payment_info' => 'MyAccount/payment_info',
55 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
56 'process_payment' => 'MyAccount/process_payment',
57 'store_payment' => 'MyAccount/store_payment',
58 'process_stored_payment' => 'MyAccount/process_stored_payment',
59 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
60 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
61 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
62 'process_prepay' => 'MyAccount/process_prepay',
63 'realtime_collect' => 'MyAccount/realtime_collect',
64 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
65 'pkg_info' => 'MyAccount/pkg_info',
66 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
67 'list_svc_usage' => 'MyAccount/list_svc_usage',
68 'svc_status_html' => 'MyAccount/svc_status_html',
69 'svc_status_hash' => 'MyAccount/svc_status_hash',
70 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
71 'set_svc_status_listadd' => 'MyAccount/set_svc_status_listadd',
72 'set_svc_status_listdel' => 'MyAccount/set_svc_status_listdel',
73 'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
74 'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
75 'acct_forward_info' => 'MyAccount/acct_forward_info',
76 'process_acct_forward' => 'MyAccount/process_acct_forward',
77 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
78 'add_dsl_device' => 'MyAccount/add_dsl_device',
79 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
80 'port_graph' => 'MyAccount/port_graph',
81 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
82 'list_support_usage' => 'MyAccount/list_support_usage',
83 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
84 'change_pkg' => 'MyAccount/change_pkg',
85 'order_recharge' => 'MyAccount/order_recharge',
86 'renew_info' => 'MyAccount/renew_info',
87 'order_renew' => 'MyAccount/order_renew',
88 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
89 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
90 'charge' => 'MyAccount/charge', #?
91 'part_svc_info' => 'MyAccount/part_svc_info',
92 'provision_acct' => 'MyAccount/provision_acct',
93 'provision_phone' => 'MyAccount/provision_phone',
94 'provision_pbx' => 'MyAccount/provision_pbx',
95 'provision_external' => 'MyAccount/provision_external',
96 'provision_forward' => 'MyAccount/provision_forward',
97 'unprovision_svc' => 'MyAccount/unprovision_svc',
98 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
99 'reset_passwd' => 'MyAccount/reset_passwd',
100 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
101 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
102 'validate_passwd' => 'MyAccount/validate_passwd',
103 'list_tickets' => 'MyAccount/list_tickets',
104 'create_ticket' => 'MyAccount/create_ticket',
105 'get_ticket' => 'MyAccount/get_ticket',
106 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
107 'did_report' => 'MyAccount/did_report',
108 'signup_info' => 'Signup/signup_info',
109 'skin_info' => 'MyAccount/skin_info',
110 'access_info' => 'MyAccount/access_info',
111 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
112 'new_customer' => 'Signup/new_customer',
113 'new_customer_minimal' => 'Signup/new_customer_minimal',
114 'capture_payment' => 'Signup/capture_payment',
115 'new_prospect' => 'Signup/new_prospect',
116 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
117 'new_agent' => 'Agent/new_agent',
118 'agent_login' => 'Agent/agent_login',
119 'agent_logout' => 'Agent/agent_logout',
120 'agent_info' => 'Agent/agent_info',
121 'agent_list_customers' => 'Agent/agent_list_customers',
122 'check_username' => 'Agent/check_username',
123 'suspend_username' => 'Agent/suspend_username',
124 'unsuspend_username' => 'Agent/unsuspend_username',
125 'mason_comp' => 'MasonComponent/mason_comp',
126 'call_time' => 'PrepaidPhone/call_time',
127 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
128 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
130 'start_thirdparty' => 'MyAccount/start_thirdparty',
131 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
133 'list_quotations' => 'MyAccount/quotation/list_quotations',
134 'quotation_new' => 'MyAccount/quotation/quotation_new',
135 'quotation_delete' => 'MyAccount/quotation/quotation_delete',
136 'quotation_info' => 'MyAccount/quotation/quotation_info',
137 'quotation_print' => 'MyAccount/quotation/quotation_print',
138 'quotation_add_pkg' => 'MyAccount/quotation/quotation_add_pkg',
139 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg',
140 'quotation_order' => 'MyAccount/quotation/quotation_order',
142 'freesideinc_service' => 'Freeside/freesideinc_service',
147 qw( regionselector regionselector_hashref location_form
148 expselect popselector domainselector didselector
152 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
153 $ENV{'SHELL'} = '/bin/sh';
154 $ENV{'IFS'} = " \t\n";
157 $ENV{'BASH_ENV'} = '';
159 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
160 #if you grant appropriate permissions to whatever user
161 my $freeside_uid = scalar(getpwnam('freeside'));
162 die "not running as the freeside user\n"
163 if $> != $freeside_uid && ! $skip_uid_check;
165 -e $dir or die "FATAL: $dir doesn't exist!";
166 -d $dir or die "FATAL: $dir isn't a directory!";
167 -r $dir or die "FATAL: Can't read $dir as freeside user!";
168 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
170 foreach my $autoload ( keys %autoload ) {
173 "sub $autoload { ". '
178 #warn scalar(@_). ": ". join(" / ", @_);
182 $param->{_packet} = \''. $autoload{$autoload}. '\';
184 simple_packet($param);
194 warn "sending ". $packet->{_packet}. " to server"
196 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
197 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
198 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
201 #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
203 #block until there is a message on socket
204 # my $w = new IO::Select;
206 # my @wait = $w->can_read;
208 warn "reading message from server"
211 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
212 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
214 warn "returning message to client"
222 FS::SelfService - Freeside self-service API
226 # password and shell account changes
227 use FS::SelfService qw(passwd chfn chsh);
229 # "my account" functionality
230 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
232 #new-style login with an email address and password
233 # can also be used for svc_acct login, set $emailaddress to username@domain
234 my $rv = login ( { 'email' => $emailaddress,
235 'password' => $password,
238 if ( $rv->{'error'} ) {
239 #handle login error...
242 $session_id = $rv->{'session_id'};
245 #classic svc_acct-based login with separate username and password
246 my $rv = login( { 'username' => $username,
248 'password' => $password,
251 if ( $rv->{'error'} ) {
252 #handle login error...
255 $session_id = $rv->{'session_id'};
258 #svc_phone login with phone number and PIN
259 my $rv = login( { 'username' => $phone_number,
260 'domain' => 'svc_phone',
264 if ( $rv->{'error'} ) {
265 #handle login error...
268 $session_id = $rv->{'session_id'};
271 my $customer_info = customer_info( { 'session_id' => $session_id } );
273 my $payment_info = payment_info( { 'session_id' => $session_id } );
275 #!!! process_payment example
277 #!!! list_pkgs example
279 #!!! order_pkg example
281 #quoting a package, then ordering after confirmation
283 my $rv = quotation_new({ 'session_id' => $session_id });
284 my $qnum = $rv->{quotationnum};
285 # add packages to the quotation
286 $rv = quotation_add_pkg({ 'session_id' => $session_id,
287 'quotationnum' => $qnum,
288 'pkgpart' => $pkgpart,
289 'quantity' => $quantity, # defaults to 1
291 # repeat until all packages are added
292 # view the pricing information
293 $rv = quotation_info({ 'session_id' => $session_id,
294 'quotationnum' => $qnum,
296 print "Total setup charges: ".$rv->{total_setup}."\n".
297 "Total recurring charges: ".$rv->{total_recur}."\n";
298 # quotation_info also provides a detailed breakdown of charges, in
301 # ask customer for confirmation, then:
302 $rv = quotation_order({ 'session_id' => $session_id,
303 'quotationnum' => $qnum,
306 #!!! cancel_pkg example
308 # signup functionality
309 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
311 my $signup_info = signup_info;
313 $rv = new_customer( {
316 'company' => $company,
317 'address1' => $address1,
318 'address2' => $address2,
322 'country' => $country,
323 'daytime' => $daytime,
327 'payinfo' => $payinfo,
329 'paystart_month' => $paystart_month
330 'paystart_year' => $paystart_year,
331 'payissue' => $payissue,
333 'paydate' => $paydate,
334 'payname' => $payname,
335 'invoicing_list' => $invoicing_list,
336 'referral_custnum' => $referral_custnum,
337 'agentnum' => $agentnum,
338 'pkgpart' => $pkgpart,
340 'username' => $username,
341 '_password' => $password,
345 'phonenum' => $phonenum,
350 my $error = $rv->{'error'};
351 if ( $error eq '_decline' ) {
361 Use this API to implement your own client "self-service" module.
363 If you just want to customize the look of the existing "self-service" module,
366 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
372 Changes the password for an existing user in svc_acct. Takes a hash
373 reference with the following keys:
379 Username of the account (required)
383 Domain of the account (required)
387 Old password (required)
391 New password (required)
409 =head1 "MY ACCOUNT" FUNCTIONS
415 Creates a user session. Takes a hash reference as parameter with the
422 Email address (username@domain), instead of username and domain. Required for
423 contact-based self-service login, can also be used for svc_acct-based login.
439 Returns a hash reference with the following keys:
445 Empty on success, or an error message on errors.
449 Session identifier for successful logins
453 =item customer_info HASHREF
455 Returns general customer information.
457 Takes a hash reference as parameter with a single key: B<session_id>
459 Returns a hash reference with the following keys:
473 Array reference of hash references of open inoices. Each hash reference has
474 the following keys: invnum, date, owed
478 An HTML fragment containing shipping and billing addresses.
480 =item The following fields are also returned
482 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
486 =item customer_recurring HASHREF
488 Takes a hash reference as parameter with a single key B<session_id>
489 or keys B<agent_session_id> and B<custnum>.
491 Returns a hash reference with the keys error, custnum and display_recurring.
493 display_recurring is an arrayref of hashrefs with the following keys:
499 frequency of charge, in months unless units are specified
503 frequency of charge, suitable for display
507 amount charged at this frequency
511 =item edit_info HASHREF
513 Takes a hash reference as parameter with any of the following keys:
515 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
517 If a field exists, the customer record is updated with the new value of that
518 field. If a field does not exist, that field is not changed on the customer
521 Returns a hash reference with a single key, B<error>, empty on success, or an
522 error message on errors
524 =item invoice HASHREF
526 Returns an invoice. Takes a hash reference as parameter with two keys:
527 session_id and invnum
529 Returns a hash reference with the following keys:
535 Empty on success, or an error message on errors
547 =item list_invoices HASHREF
549 Returns a list of all customer invoices. Takes a hash reference with a single
552 Returns a hash reference with the following keys:
558 Empty on success, or an error message on errors
562 Reference to array of hash references with the following keys:
572 Invoice date, in UNIX epoch time
580 Cancels this customer.
582 Takes a hash reference as parameter with a single key: B<session_id>
584 Returns a hash reference with a single key, B<error>, which is empty on
585 success or an error message on errors.
587 =item payment_info HASHREF
589 Returns information that may be useful in displaying a payment page.
591 Takes a hash reference as parameter with the following keys:
599 =item omit_cust_main_county
601 Optional, pass a true value to omit cust_main_county data for performance.
605 Returns a hash reference with the following keys:
611 Empty on success, or an error message on errors
619 Exact name on credit card (CARD/DCRD)
643 Customer's current default payment type.
647 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
651 For CARD/DCRD payment types, the card number
655 For CARD/DCRD payment types, expiration month
659 For CARD/DCRD payment types, expiration year
661 =item cust_main_county
663 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.
667 Array reference of all states in the current default country.
671 Hash reference of card types; keys are card types, values are the exact strings
672 passed to the process_payment function
676 #this doesn't actually work yet
680 #Unique transaction identifier (prevents multiple charges), passed to the
681 #process_payment function
685 =item process_payment HASHREF
687 Processes a payment and possible change of address or payment type. Takes a
688 hash reference as parameter with the following keys:
702 If true, address and card information entered will be saved for subsequent
707 If true, future credit card payments will be done automatically (sets payby to
708 CARD). If false, future credit card payments will be done on-demand (sets
709 payby to DCRD). This option only has meaning if B<save> is set true.
737 Two-letter country code
745 Card expiration month
753 #this doesn't actually work yet
757 #Unique transaction identifier, returned from the payment_info function.
758 #Prevents multiple charges.
762 Returns a hash reference with a single key, B<error>, empty on success, or an
763 error message on errors.
765 =item process_payment_order_pkg
767 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
768 payment processes sucessfully, the package is ordered. Takes a hash reference
769 as parameter with the keys of both methods.
771 Returns a hash reference with a single key, B<error>, empty on success, or an
772 error message on errors.
774 =item process_payment_change_pkg
776 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
777 payment processes sucessfully, the package is ordered. Takes a hash reference
778 as parameter with the keys of both methods.
780 Returns a hash reference with a single key, B<error>, empty on success, or an
781 error message on errors.
784 =item process_payment_order_renew
786 Combines the B<process_payment> and B<order_renew> functions in one step. If
787 the payment processes sucessfully, the renewal is processed. Takes a hash
788 reference as parameter with the keys of both methods.
790 Returns a hash reference with a single key, B<error>, empty on success, or an
791 error message on errors.
795 Returns package information for this customer. For more detail on services,
798 Takes a hash reference as parameter with a single key: B<session_id>
800 Returns a hash reference containing customer package information. The hash reference contains the following keys:
810 Empty on success, or an error message on errors.
812 =item cust_pkg HASHREF
814 Array reference of hash references, each of which has the fields of a cust_pkg
815 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
816 the internal FS:: objects, but hash references of columns and values.
820 =item part_pkg fields
822 All fields of part_pkg for this specific cust_pkg (be careful with this
823 information - it may reveal more about your available packages than you would
824 like users to know in aggregate)
828 #XXX pare part_pkg fields down to a more secure subset
832 An array of hash references indicating information on unprovisioned services
833 available for provisioning for this specific cust_pkg. Each has the following
838 =item part_svc fields
840 All fields of part_svc (be careful with this information - it may reveal more
841 about your available packages than you would like users to know in aggregate)
845 #XXX pare part_svc fields down to a more secure subset
851 An array of hash references indicating information on the customer services
852 already provisioned for this specific cust_pkg. Each has the following keys:
858 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.
864 Primary key for this service
868 Service definition (see L<FS::part_svc>)
872 Customer package (see L<FS::cust_pkg>)
876 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
884 Returns package information for package.
886 Takes a hash reference as parameter with the following keys:
900 Returns a hash reference containing customer package information. The hash reference contains the following keys:
908 Part package primary key
916 error message if errror.
924 Returns service information for this customer.
926 Takes a hash reference as parameter with a single key: B<session_id>
928 Returns a hash reference containing customer package information. The hash reference contains the following keys:
938 An array of hash references indicating information on all of this customer's
939 services. Each has the following keys:
945 Primary key for this service
953 Meaningful user-specific identifier for the service (i.e. username, domain, or
958 Account (svc_acct) services also have the following keys:
976 Upload bytes remaining
980 Download bytes remaining
984 Total bytes remaining
986 =item recharge_amount
990 =item recharge_seconds
992 Number of seconds gained by recharge
994 =item recharge_upbytes
996 Number of upload bytes gained by recharge
998 =item recharge_downbytes
1000 Number of download bytes gained by recharge
1002 =item recharge_totalbytes
1004 Number of total bytes gained by recharge
1012 Orders a package for this customer.
1014 If signup_server-realtime is set, bills the new package, attemps to collect
1015 payment and (for auto-payment customers) cancels the package if the payment is
1018 Takes a hash reference as parameter with the following keys:
1028 Package to order (see L<FS::part_pkg>).
1032 Quantity for this package order (default 1).
1034 =item run_bill_events
1036 If true, runs billing events for the customer after ordering and billing the
1037 package (signup_server-realtime must be set).
1041 Optional locationnum for this package order, for existing locations.
1043 Or, for new locations, pass the following fields: address1*, address2, city*,
1044 county, state*, zip*, country. (* = required in this case)
1046 (None of this is required at all if you are just ordering a package
1047 at the customer's existing default service location.)
1065 Service to order (see L<FS::part_svc>).
1067 Normally optional; required only to provision a non-svc_acct service, or if the
1068 package definition does not contain one svc_acct service definition with
1069 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
1070 also be specified to indicate that no initial service should be provisioned.
1074 Fields used when provisioning an svc_acct service:
1088 Optional security phrase
1092 Optional Access number number
1096 Fields used when provisioning an svc_domain service:
1106 Fields used when provisioning an svc_phone service:
1124 Fields used when provisioning an svc_external service:
1130 External numeric ID.
1134 External text title.
1138 Fields used when provisioning an svc_pbx service:
1152 Returns a hash reference with a single key, B<error>, empty on success, or an
1153 error message on errors. The special error '_decline' is returned for
1154 declined transactions.
1158 Changes a package for this customer.
1160 Takes a hash reference as parameter with the following keys:
1170 Existing customer package.
1174 New package to order (see L<FS::part_pkg>).
1178 Quantity for this package order (default 1).
1182 Returns a hash reference with the following keys:
1188 Empty on success, or an error message on errors.
1192 On success, the new pkgnum
1199 Provides useful info for early renewals.
1201 Takes a hash reference as parameter with the following keys:
1211 Returns a hash reference. On errors, it contains a single key, B<error>, with
1212 the error message. Otherwise, contains a single key, B<dates>, pointing to
1213 an array refernce of hash references. Each hash reference contains the
1220 (Future) Bill date. Indicates a future date for which billing could be run.
1221 Specified as an integer UNIX timestamp. Pass this value to the B<order_renew>
1224 =item bill_date_pretty
1226 (Future) Bill date as a human-readable string. (Convenience for display;
1227 subject to change, so best not to parse for the date.)
1231 Base amount which will be charged if renewed early as of this date.
1235 Renewal date; i.e. even-futher future date at which the customer will be paid
1236 through if the early renewal is completed with the given B<bill-date>.
1237 Specified as an integer UNIX timestamp.
1239 =item renew_date_pretty
1241 Renewal date as a human-readable string. (Convenience for display;
1242 subject to change, so best not to parse for the date.)
1246 Package that will be renewed.
1250 Expiration date of the package that will be renewed.
1252 =item expire_date_pretty
1254 Expiration date of the package that will be renewed, as a human-readable
1255 string. (Convenience for display; subject to change, so best not to parse for
1262 Renews this customer early; i.e. runs billing for this customer in advance.
1264 Takes a hash reference as parameter with the following keys:
1274 Integer date as returned by the B<renew_info> function, indicating the advance
1275 date for which to run billing.
1279 Returns a hash reference with a single key, B<error>, empty on success, or an
1280 error message on errors.
1284 Cancels a package for this customer.
1286 Takes a hash reference as parameter with the following keys:
1296 pkgpart of package to cancel
1300 Optional date, for future cancellation (expiration) instead of immediate
1301 cancellation. Specified as an integer UNIX timestamp ("epoch time").
1305 Returns a hash reference with a single key, B<error>, empty on success, or an
1306 error message on errors.
1308 =item provision_acct
1310 Provisions an account (svc_acct).
1312 Takes a hash reference as parameter with the following keys:
1322 pkgnum of package into which this service is provisioned
1326 svcpart or service definition to provision
1336 =item provision_phone
1338 Provisions a phone number (svc_phone).
1340 Takes a hash reference as parameter with the following keys:
1350 pkgnum of package into which this service is provisioned
1354 svcpart or service definition to provision
1374 E911 Address (optional)
1380 Provisions a customer PBX (svc_pbx).
1382 Takes a hash reference as parameter with the following keys:
1392 pkgnum of package into which this service is provisioned
1396 svcpart or service definition to provision
1402 =item max_extensions
1404 =item max_simultaneous
1410 =item provision_external
1412 Provisions an external service (svc_external).
1414 Takes a hash reference as parameter with the following keys:
1424 pkgnum of package into which this service is provisioned
1428 svcpart or service definition to provision
1438 =head2 "MY ACCOUNT" CONTACT FUNCTIONS
1442 =item contact_passwd
1444 Changes the password for the currently-logged in contact.
1446 Takes a hash reference as parameter with the following keys:
1456 Returns a hash reference with a single parameter, B<error>, which contains an
1457 error message, or empty on success.
1461 Takes a hash reference as parameter with a single key, B<session_id>.
1463 Returns a hash reference with two parameters: B<error>, which contains an error
1464 message, or empty on success, and B<contacts>, a list of contacts.
1466 B<contacts> is an array reference of hash references (i.e. an array of structs,
1467 in XML-RPC). Each hash reference (struct) has the following keys:
1475 Contact class name (contact type).
1487 Position ("Director of Silly Walks"), NOT honorific ("Mr." or "Mrs.")
1491 Comma-separated list of email addresses
1495 =item selfservice_access
1503 Updates information for the currently-logged in contact, or (optionally) the
1506 Takes a hash reference as parameter with the following keys:
1514 If already logged in as a contact, this is optional.
1524 Returns a hash reference with a single parameter, B<error>, which contains an
1525 error message, or empty on success.
1529 Creates a new contact.
1531 Takes a hash reference as parameter with the following keys:
1545 Optional contact classnum (TODO: or name)
1549 =item selfservice_access
1551 Y to enable self-service access
1557 Returns a hash reference with a single parameter, B<error>, which contains an
1558 error message, or empty on success.
1560 =item delete_contact
1562 Deletes a contact. (Note: Cannot at this time delete the currently-logged in
1565 Takes a hash reference as parameter with the following keys:
1575 Returns a hash reference with a single parameter, B<error>, which contains an
1576 error message, or empty on success.
1580 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1582 All of these functions require the user to be logged in, and the 'session_id'
1583 key to be included in the argument hashref.`
1587 =item list_quotations HASHREF
1589 Returns a hashref listing this customer's active self-service quotations.
1596 an arrayref containing an element for each quotation.
1604 the date it was started
1608 the number of packages
1612 the sum of setup fees
1616 the sum of recurring charges
1620 =item quotation_new HASHREF
1622 Creates an empty quotation and returns a hashref containing 'quotationnum',
1623 the primary key of the new quotation.
1625 =item quotation_delete HASHREF
1627 Disables (does not really delete) a quotation. Takes the following arguments:
1633 =item quotationnum - the quotation to delete
1637 Returns 'error' => a string, which will be empty on success.
1639 =item quotation_info HASHREF
1641 Returns total and detailed pricing information on a quotation.
1643 Takes the following arguments:
1649 =item quotationnum - the quotation to return
1653 Returns a hashref containing:
1655 - total_setup, the total of setup fees (and their taxes)
1656 - total_recur, the total of all recurring charges (and their taxes)
1657 - sections, an arrayref containing an element for each quotation section.
1658 - description, a line of text describing the group of charges
1659 - subtotal, the total of charges in this group (if appropriate)
1660 - detail_items, an arrayref of line items
1661 - pkgnum, the reference number of the package
1662 - description, the package name (or tax name)
1664 - amount, the amount charged
1665 If the detail item represents a subtotal, it will instead contain:
1666 - total_item: description of the subtotal
1667 - total_amount: the subtotal amount
1670 =item quotation_print HASHREF
1672 Renders the quotation as HTML or PDF. Takes the following arguments:
1678 =item quotationnum - the quotation to return
1680 =item format - 'html' or 'pdf'
1684 Returns a hashref containing 'document', the contents of the file.
1686 =item quotation_add_pkg HASHREF
1688 Adds a package to a quotation. Takes the following arguments:
1694 =item pkgpart - the package to add
1696 =item quotationnum - the quotation to add it to
1698 =item quantity - the package quantity (defaults to 1)
1700 =item address1, address2, city, state, zip, country - address fields to set
1701 the service location
1705 Returns 'error' => a string, which will be empty on success.
1707 =item quotation_remove_pkg HASHREF
1709 Removes a package from a quotation. Takes the following arguments:
1715 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1717 =item quotationnum - the quotation to remove it from
1721 Returns 'error' => a string, which will be empty on success.
1723 =item quotation_order HASHREF
1725 Converts the packages in a quotation into real packages. Takes the following
1728 Takes the following arguments:
1734 =item quotationnum - the quotation to order
1740 =head1 SIGNUP FUNCTIONS
1744 =item signup_info HASHREF
1746 Takes a hash reference as parameter with the following keys:
1750 =item session_id - Optional agent/reseller interface session
1754 Returns a hash reference containing information that may be useful in
1755 displaying a signup page. The hash reference contains the following keys:
1759 =item cust_main_county
1761 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.
1765 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
1766 an agentnum specified explicitly via reseller interface session_id in the
1771 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.
1773 =item agentnum2part_pkg
1775 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.
1779 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.
1781 =item security_phrase
1783 True if the "security_phrase" feature is enabled
1787 Array reference of acceptable payment types for signup
1793 credit card - automatic
1797 credit card - on-demand - version 1.5+ only
1801 electronic check - automatic
1805 electronic check - on-demand - version 1.5+ only
1813 billing, not recommended for signups
1817 free, definitely not recommended for signups
1821 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1827 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1831 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".
1837 =item countrydefault
1843 =item new_customer_minimal HASHREF
1845 Creates a new customer.
1847 Current differences from new_customer: An address is not required. promo_code
1848 and reg_code are not supported. If invoicing_list and _password is passed, a
1849 contact will be created with self-service access (no pkgpart or username is
1850 necessary). No initial billing is run (this may change in a future version).
1852 Takes a hash reference as parameter with the following keys:
1858 first name (required)
1862 last name (required)
1866 (not typically collected; mostly used for ACH transactions)
1898 Daytime phone number
1902 Evening phone number
1910 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1914 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1918 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1922 Expiration date for CARD/DCRD
1926 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1928 =item invoicing_list
1930 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),
1932 =item referral_custnum
1934 referring customer number
1942 pkgpart of initial package
1958 Access number (index, not the literal number)
1962 Country code (to be provisioned as a service)
1966 Phone number (to be provisioned as a service)
1974 Returns a hash reference with the following keys:
1980 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)
1984 =item new_customer HASHREF
1986 Creates a new customer. Takes a hash reference as parameter with the
1993 first name (required)
1997 last name (required)
2001 (not typically collected; mostly used for ACH transactions)
2007 =item address1 (required)
2015 =item city (required)
2023 =item state (required)
2027 =item zip (required)
2043 Optional shipping address fields. If sending an optional shipping address,
2044 ship_address1, ship_city, ship_state and ship_zip are required.
2048 Daytime phone number
2052 Evening phone number
2060 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
2064 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
2068 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
2072 Expiration date for CARD/DCRD
2076 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
2078 =item invoicing_list
2080 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),
2082 =item referral_custnum
2084 referring customer number
2092 pkgpart of initial package
2108 Access number (index, not the literal number)
2112 Country code (to be provisioned as a service)
2116 Phone number (to be provisioned as a service)
2124 Returns a hash reference with the following keys:
2130 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)
2134 =item regionselector HASHREF | LIST
2136 Takes as input a hashref or list of key/value pairs with the following keys:
2140 =item selected_county
2142 Currently selected county
2144 =item selected_state
2146 Currently selected state
2148 =item selected_country
2150 Currently selected country
2154 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2158 Specify a javascript subroutine to call on changes
2164 =item default_country
2170 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>.
2174 Returns a list consisting of three HTML fragments for county selection,
2175 state selection and country selection, respectively.
2179 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
2180 sub regionselector {
2187 $param->{'selected_country'} ||= $param->{'default_country'};
2188 $param->{'selected_state'} ||= $param->{'default_state'};
2190 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2194 my %cust_main_county;
2196 # unless ( @cust_main_county ) { #cache
2197 #@cust_main_county = qsearch('cust_main_county', {} );
2198 #foreach my $c ( @cust_main_county ) {
2199 foreach my $c ( @{ $param->{'locales'} } ) {
2200 #$countyflag=1 if $c->county;
2201 $countyflag=1 if $c->{county};
2202 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
2203 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
2204 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
2207 $countyflag=1 if $param->{selected_county};
2209 my $script_html = <<END;
2211 function opt(what,value,text) {
2212 var optionName = new Option(text, value, false, false);
2213 var length = what.length;
2214 what.options[length] = optionName;
2216 function ${prefix}country_changed(what) {
2217 country = what.options[what.selectedIndex].text;
2218 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
2219 what.form.${prefix}state.options[i] = null;
2221 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
2223 foreach my $country ( sort keys %cust_main_county ) {
2224 $script_html .= "\nif ( country == \"$country\" ) {\n";
2225 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2226 my $text = $state || '(n/a)';
2227 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
2229 $script_html .= "}\n";
2232 $script_html .= <<END;
2234 function ${prefix}state_changed(what) {
2237 if ( $countyflag ) {
2238 $script_html .= <<END;
2239 state = what.options[what.selectedIndex].text;
2240 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
2241 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
2242 what.form.${prefix}county.options[i] = null;
2245 foreach my $country ( sort keys %cust_main_county ) {
2246 $script_html .= "\nif ( country == \"$country\" ) {\n";
2247 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2248 $script_html .= "\nif ( state == \"$state\" ) {\n";
2249 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
2250 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
2251 my $text = $county || '(n/a)';
2253 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
2255 $script_html .= "}\n";
2257 $script_html .= "}\n";
2261 $script_html .= <<END;
2266 my $county_html = $script_html;
2267 if ( $countyflag ) {
2268 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
2269 foreach my $county (
2270 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2272 my $text = $county || '(n/a)';
2273 $county_html .= qq!<OPTION VALUE="$county"!.
2274 ($county eq $param->{'selected_county'} ?
2281 $county_html .= '</SELECT>';
2284 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2287 my $state_html = qq!<SELECT NAME="${prefix}state" !.
2288 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2289 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2290 my $text = $state || '(n/a)';
2291 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2292 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
2294 $state_html .= '</SELECT>';
2296 my $country_html = '';
2297 if ( scalar( keys %cust_main_county ) > 1 ) {
2299 $country_html = qq(<SELECT NAME="${prefix}country" ).
2300 qq(onChange="${prefix}country_changed(this); ).
2301 $param->{'onchange'}.
2304 my $countrydefault = $param->{default_country} || 'US';
2305 foreach my $country (
2306 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2307 keys %cust_main_county
2309 my $selected = $country eq $param->{'selected_country'}
2312 $country_html .= "\n<OPTION$selected>$country</OPTION>"
2314 $country_html .= '</SELECT>';
2317 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2318 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2322 ($county_html, $state_html, $country_html);
2326 sub regionselector_hashref {
2327 my ($county_html, $state_html, $country_html) = regionselector(@_);
2329 'county_html' => $county_html,
2330 'state_html' => $state_html,
2331 'country_html' => $country_html,
2335 =item location_form HASHREF | LIST
2337 Takes as input a hashref or list of key/value pairs with the following keys:
2343 Current customer session_id
2347 Omit red asterisks from required fields.
2349 =item address1_label
2351 Label for first address line.
2355 Returns an HTML fragment for a location form (address, city, state, zip,
2368 my $session_id = delete $param->{'session_id'};
2370 my $rv = mason_comp( 'session_id' => $session_id,
2371 'comp' => '/elements/location.html',
2372 'args' => [ %$param ],
2376 $rv->{'error'} || $rv->{'output'};
2381 #=item expselect HASHREF | LIST
2383 #Takes as input a hashref or list of key/value pairs with the following keys:
2387 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2389 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2393 =item expselect PREFIX [ DATE ]
2395 Takes as input a unique prefix string and the current expiration date, in
2396 yyyy-mm-dd or m-d-yyyy format
2398 Returns an HTML fragments for expiration date selection.
2404 #if ( ref($_[0]) ) {
2408 #my $prefix = $param->{'prefix'};
2409 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2410 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2412 my $date = scalar(@_) ? shift : '';
2414 my( $m, $y ) = ( 0, 0 );
2415 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2416 ( $m, $y ) = ( $2, $1 );
2417 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2418 ( $m, $y ) = ( $1, $3 );
2420 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2422 $return .= qq!<OPTION VALUE="$_"!;
2423 $return .= " SELECTED" if $_ == $m;
2426 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2428 my $thisYear = $t[5] + 1900;
2429 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2430 $return .= qq!<OPTION VALUE="$_"!;
2431 $return .= " SELECTED" if $_ == $y;
2434 $return .= "</SELECT>";
2439 =item popselector HASHREF | LIST
2441 Takes as input a hashref or list of key/value pairs with the following keys:
2447 Access number number
2451 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>.
2455 Returns an HTML fragment for access number selection.
2459 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2467 my $popnum = $param->{'popnum'};
2468 my $pops = $param->{'pops'};
2470 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2471 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2472 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2473 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2474 if scalar(@$pops) == 1;
2477 my %popnum2pop = ();
2479 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2480 $popnum2pop{$_->{popnum}} = $_;
2485 function opt(what,href,text) {
2486 var optionName = new Option(text, href, false, false)
2487 var length = what.length;
2488 what.options[length] = optionName;
2492 my $init_popstate = $param->{'init_popstate'};
2493 if ( $init_popstate ) {
2494 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2495 $init_popstate. '">';
2498 function acstate_changed(what) {
2499 state = what.options[what.selectedIndex].text;
2500 what.form.popac.options.length = 0
2501 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2505 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2506 foreach my $state ( sort { $a cmp $b } @states ) {
2507 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2509 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2510 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2511 if ($ac eq $param->{'popac'}) {
2512 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2515 $text .= "}\n" unless $init_popstate;
2517 $text .= "popac_changed(what.form.popac)}\n";
2520 function popac_changed(what) {
2521 ac = what.options[what.selectedIndex].text;
2522 what.form.popnum.options.length = 0;
2523 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2527 foreach my $state ( @states ) {
2528 foreach my $popac ( keys %{ $pop{$state} } ) {
2529 $text .= "\nif ( ac == \"$popac\" ) {\n";
2531 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2532 my $o_popnum = $pop->{popnum};
2533 my $poptext = $pop->{city}. ', '. $pop->{state}.
2534 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2536 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2537 if ($popnum == $o_popnum) {
2538 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2546 $text .= "}\n</SCRIPT>\n";
2548 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2551 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2552 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2553 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2554 ">$_" foreach sort { $a cmp $b } @states;
2555 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2558 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2559 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2561 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2564 #comment this block to disable initial list polulation
2565 my @initial_select = ();
2566 if ( scalar( @$pops ) > 100 ) {
2567 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2569 @initial_select = @$pops;
2571 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2572 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2573 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2574 $pop->{city}. ', '. $pop->{state}.
2575 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2578 $text .= qq!</SELECT></TD></TR></TABLE>!;
2584 =item domainselector HASHREF | LIST
2586 Takes as input a hashref or list of key/value pairs with the following keys:
2596 Service number of the selected item.
2600 Returns an HTML fragment for domain selection.
2604 sub domainselector {
2611 my $domsvc= $param->{'domsvc'};
2613 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2614 my $domains = $rv->{'domains'};
2615 $domsvc = $rv->{'domsvc'} unless $domsvc;
2617 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2618 unless scalar(keys %$domains);
2620 if (scalar(keys %$domains) == 1) {
2622 foreach(keys %$domains) {
2625 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2626 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2629 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2631 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2633 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2634 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2635 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2636 $domains->{$domain};
2639 $text .= qq!</SELECT></TD></TR>!;
2645 =item didselector HASHREF | LIST
2647 Takes as input a hashref or list of key/value pairs with the following keys:
2653 Field name for the returned HTML fragment.
2657 Service definition (see L<FS::part_svc>)
2661 Returns an HTML fragment for DID selection.
2673 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2674 'args'=>[ %$param ],
2678 $rv->{'error'} || $rv->{'output'};
2684 =head1 RESELLER FUNCTIONS
2686 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2687 with their active session, and the B<customer_info> and B<order_pkg> functions
2688 with their active session and an additional I<custnum> parameter.
2690 For the most part, development of the reseller web interface has been
2691 superceded by agent-virtualized access to the backend.
2703 =item agent_list_customers
2705 List agent's customers.
2713 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>