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 'cancel' => 'MyAccount/cancel', #add to ss cgi!
52 'payment_info' => 'MyAccount/payment_info',
53 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
54 'process_payment' => 'MyAccount/process_payment',
55 'store_payment' => 'MyAccount/store_payment',
56 'process_stored_payment' => 'MyAccount/process_stored_payment',
57 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
58 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
59 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
60 'process_prepay' => 'MyAccount/process_prepay',
61 'realtime_collect' => 'MyAccount/realtime_collect',
62 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
63 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
64 'list_svc_usage' => 'MyAccount/list_svc_usage',
65 'svc_status_html' => 'MyAccount/svc_status_html',
66 'svc_status_hash' => 'MyAccount/svc_status_hash',
67 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
68 'set_svc_status_listadd' => 'MyAccount/set_svc_status_listadd',
69 'set_svc_status_listdel' => 'MyAccount/set_svc_status_listdel',
70 'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
71 'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
72 'acct_forward_info' => 'MyAccount/acct_forward_info',
73 'process_acct_forward' => 'MyAccount/process_acct_forward',
74 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
75 'add_dsl_device' => 'MyAccount/add_dsl_device',
76 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
77 'port_graph' => 'MyAccount/port_graph',
78 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
79 'list_support_usage' => 'MyAccount/list_support_usage',
80 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
81 'change_pkg' => 'MyAccount/change_pkg',
82 'order_recharge' => 'MyAccount/order_recharge',
83 'renew_info' => 'MyAccount/renew_info',
84 'order_renew' => 'MyAccount/order_renew',
85 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
86 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
87 'charge' => 'MyAccount/charge', #?
88 'part_svc_info' => 'MyAccount/part_svc_info',
89 'provision_acct' => 'MyAccount/provision_acct',
90 'provision_phone' => 'MyAccount/provision_phone',
91 'provision_pbx' => 'MyAccount/provision_pbx',
92 'provision_external' => 'MyAccount/provision_external',
93 'provision_forward' => 'MyAccount/provision_forward',
94 'unprovision_svc' => 'MyAccount/unprovision_svc',
95 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
96 'reset_passwd' => 'MyAccount/reset_passwd',
97 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
98 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
99 'validate_passwd' => 'MyAccount/validate_passwd',
100 'list_tickets' => 'MyAccount/list_tickets',
101 'create_ticket' => 'MyAccount/create_ticket',
102 'get_ticket' => 'MyAccount/get_ticket',
103 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
104 'did_report' => 'MyAccount/did_report',
105 'signup_info' => 'Signup/signup_info',
106 'skin_info' => 'MyAccount/skin_info',
107 'access_info' => 'MyAccount/access_info',
108 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
109 'new_customer' => 'Signup/new_customer',
110 'new_customer_minimal' => 'Signup/new_customer_minimal',
111 'capture_payment' => 'Signup/capture_payment',
112 'new_prospect' => 'Signup/new_prospect',
113 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
114 'new_agent' => 'Agent/new_agent',
115 'agent_login' => 'Agent/agent_login',
116 'agent_logout' => 'Agent/agent_logout',
117 'agent_info' => 'Agent/agent_info',
118 'agent_list_customers' => 'Agent/agent_list_customers',
119 'check_username' => 'Agent/check_username',
120 'suspend_username' => 'Agent/suspend_username',
121 'unsuspend_username' => 'Agent/unsuspend_username',
122 'mason_comp' => 'MasonComponent/mason_comp',
123 'call_time' => 'PrepaidPhone/call_time',
124 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
125 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
127 'start_thirdparty' => 'MyAccount/start_thirdparty',
128 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
130 'list_quotations' => 'MyAccount/quotation/list_quotations',
131 'quotation_new' => 'MyAccount/quotation/quotation_new',
132 'quotation_delete' => 'MyAccount/quotation/quotation_delete',
133 'quotation_info' => 'MyAccount/quotation/quotation_info',
134 'quotation_print' => 'MyAccount/quotation/quotation_print',
135 'quotation_add_pkg' => 'MyAccount/quotation/quotation_add_pkg',
136 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg',
137 'quotation_order' => 'MyAccount/quotation/quotation_order',
139 'freesideinc_service' => 'Freeside/freesideinc_service',
144 qw( regionselector regionselector_hashref location_form
145 expselect popselector domainselector didselector
149 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
150 $ENV{'SHELL'} = '/bin/sh';
151 $ENV{'IFS'} = " \t\n";
154 $ENV{'BASH_ENV'} = '';
156 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
157 #if you grant appropriate permissions to whatever user
158 my $freeside_uid = scalar(getpwnam('freeside'));
159 die "not running as the freeside user\n"
160 if $> != $freeside_uid && ! $skip_uid_check;
162 -e $dir or die "FATAL: $dir doesn't exist!";
163 -d $dir or die "FATAL: $dir isn't a directory!";
164 -r $dir or die "FATAL: Can't read $dir as freeside user!";
165 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
167 foreach my $autoload ( keys %autoload ) {
170 "sub $autoload { ". '
175 #warn scalar(@_). ": ". join(" / ", @_);
179 $param->{_packet} = \''. $autoload{$autoload}. '\';
181 simple_packet($param);
191 warn "sending ". $packet->{_packet}. " to server"
193 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
194 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
195 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
198 #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
200 #block until there is a message on socket
201 # my $w = new IO::Select;
203 # my @wait = $w->can_read;
205 warn "reading message from server"
208 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
209 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
211 warn "returning message to client"
219 FS::SelfService - Freeside self-service API
223 # password and shell account changes
224 use FS::SelfService qw(passwd chfn chsh);
226 # "my account" functionality
227 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
229 #new-style login with an email address and password
230 # can also be used for svc_acct login, set $emailaddress to username@domain
231 my $rv = login ( { 'email' => $emailaddress,
232 'password' => $password,
235 if ( $rv->{'error'} ) {
236 #handle login error...
239 $session_id = $rv->{'session_id'};
242 #classic svc_acct-based login with separate username and password
243 my $rv = login( { 'username' => $username,
245 'password' => $password,
248 if ( $rv->{'error'} ) {
249 #handle login error...
252 $session_id = $rv->{'session_id'};
255 #svc_phone login with phone number and PIN
256 my $rv = login( { 'username' => $phone_number,
257 'domain' => 'svc_phone',
261 if ( $rv->{'error'} ) {
262 #handle login error...
265 $session_id = $rv->{'session_id'};
268 my $customer_info = customer_info( { 'session_id' => $session_id } );
270 my $payment_info = payment_info( { 'session_id' => $session_id } );
272 #!!! process_payment example
274 #!!! list_pkgs example
276 #!!! order_pkg example
278 #quoting a package, then ordering after confirmation
280 my $rv = quotation_new({ 'session_id' => $session_id });
281 my $qnum = $rv->{quotationnum};
282 # add packages to the quotation
283 $rv = quotation_add_pkg({ 'session_id' => $session_id,
284 'quotationnum' => $qnum,
285 'pkgpart' => $pkgpart,
286 'quantity' => $quantity, # defaults to 1
288 # repeat until all packages are added
289 # view the pricing information
290 $rv = quotation_info({ 'session_id' => $session_id,
291 'quotationnum' => $qnum,
293 print "Total setup charges: ".$rv->{total_setup}."\n".
294 "Total recurring charges: ".$rv->{total_recur}."\n";
295 # quotation_info also provides a detailed breakdown of charges, in
298 # ask customer for confirmation, then:
299 $rv = quotation_order({ 'session_id' => $session_id,
300 'quotationnum' => $qnum,
303 #!!! cancel_pkg example
305 # signup functionality
306 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
308 my $signup_info = signup_info;
310 $rv = new_customer( {
313 'company' => $company,
314 'address1' => $address1,
315 'address2' => $address2,
319 'country' => $country,
320 'daytime' => $daytime,
324 'payinfo' => $payinfo,
326 'paystart_month' => $paystart_month
327 'paystart_year' => $paystart_year,
328 'payissue' => $payissue,
330 'paydate' => $paydate,
331 'payname' => $payname,
332 'invoicing_list' => $invoicing_list,
333 'referral_custnum' => $referral_custnum,
334 'agentnum' => $agentnum,
335 'pkgpart' => $pkgpart,
337 'username' => $username,
338 '_password' => $password,
342 'phonenum' => $phonenum,
347 my $error = $rv->{'error'};
348 if ( $error eq '_decline' ) {
358 Use this API to implement your own client "self-service" module.
360 If you just want to customize the look of the existing "self-service" module,
363 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
369 Changes the password for an existing user in svc_acct. Takes a hash
370 reference with the following keys:
376 Username of the account (required)
380 Domain of the account (required)
384 Old password (required)
388 New password (required)
406 =head1 "MY ACCOUNT" FUNCTIONS
412 Creates a user session. Takes a hash reference as parameter with the
419 Email address (username@domain), instead of username and domain. Required for
420 contact-based self-service login, can also be used for svc_acct-based login.
436 Returns a hash reference with the following keys:
442 Empty on success, or an error message on errors.
446 Session identifier for successful logins
450 =item customer_info HASHREF
452 Returns general customer information.
454 Takes a hash reference as parameter with a single key: B<session_id>
456 Returns a hash reference with the following keys:
470 Array reference of hash references of open inoices. Each hash reference has
471 the following keys: invnum, date, owed
475 An HTML fragment containing shipping and billing addresses.
477 =item The following fields are also returned
479 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
483 =item customer_recurring HASHREF
485 Takes a hash reference as parameter with a single key B<session_id>
486 or keys B<agent_session_id> and B<custnum>.
488 Returns a hash reference with the keys error, custnum and display_recurring.
490 display_recurring is an arrayref of hashrefs with the following keys:
496 frequency of charge, in months unless units are specified
500 frequency of charge, suitable for display
504 amount charged at this frequency
508 =item edit_info HASHREF
510 Takes a hash reference as parameter with any of the following keys:
512 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
514 If a field exists, the customer record is updated with the new value of that
515 field. If a field does not exist, that field is not changed on the customer
518 Returns a hash reference with a single key, B<error>, empty on success, or an
519 error message on errors
521 =item invoice HASHREF
523 Returns an invoice. Takes a hash reference as parameter with two keys:
524 session_id and invnum
526 Returns a hash reference with the following keys:
532 Empty on success, or an error message on errors
544 =item list_invoices HASHREF
546 Returns a list of all customer invoices. Takes a hash reference with a single
549 Returns a hash reference with the following keys:
555 Empty on success, or an error message on errors
559 Reference to array of hash references with the following keys:
569 Invoice date, in UNIX epoch time
577 Cancels this customer.
579 Takes a hash reference as parameter with a single key: B<session_id>
581 Returns a hash reference with a single key, B<error>, which is empty on
582 success or an error message on errors.
584 =item payment_info HASHREF
586 Returns information that may be useful in displaying a payment page.
588 Takes a hash reference as parameter with the following keys:
596 =item omit_cust_main_county
598 Optional, pass a true value to omit cust_main_county data for performance.
602 Returns a hash reference with the following keys:
608 Empty on success, or an error message on errors
616 Exact name on credit card (CARD/DCRD)
640 Customer's current default payment type.
644 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
648 For CARD/DCRD payment types, the card number
652 For CARD/DCRD payment types, expiration month
656 For CARD/DCRD payment types, expiration year
658 =item cust_main_county
660 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.
664 Array reference of all states in the current default country.
668 Hash reference of card types; keys are card types, values are the exact strings
669 passed to the process_payment function
673 #this doesn't actually work yet
677 #Unique transaction identifier (prevents multiple charges), passed to the
678 #process_payment function
682 =item process_payment HASHREF
684 Processes a payment and possible change of address or payment type. Takes a
685 hash reference as parameter with the following keys:
699 If true, address and card information entered will be saved for subsequent
704 If true, future credit card payments will be done automatically (sets payby to
705 CARD). If false, future credit card payments will be done on-demand (sets
706 payby to DCRD). This option only has meaning if B<save> is set true.
734 Two-letter country code
742 Card expiration month
750 #this doesn't actually work yet
754 #Unique transaction identifier, returned from the payment_info function.
755 #Prevents multiple charges.
759 Returns a hash reference with a single key, B<error>, empty on success, or an
760 error message on errors.
762 =item process_payment_order_pkg
764 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
765 payment processes sucessfully, the package is ordered. Takes a hash reference
766 as parameter with the keys of both methods.
768 Returns a hash reference with a single key, B<error>, empty on success, or an
769 error message on errors.
771 =item process_payment_change_pkg
773 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
774 payment processes sucessfully, the package is ordered. Takes a hash reference
775 as parameter with the keys of both methods.
777 Returns a hash reference with a single key, B<error>, empty on success, or an
778 error message on errors.
781 =item process_payment_order_renew
783 Combines the B<process_payment> and B<order_renew> functions in one step. If
784 the payment processes sucessfully, the renewal is processed. Takes a hash
785 reference as parameter with the keys of both methods.
787 Returns a hash reference with a single key, B<error>, empty on success, or an
788 error message on errors.
792 Returns package information for this customer. For more detail on services,
795 Takes a hash reference as parameter with a single key: B<session_id>
797 Returns a hash reference containing customer package information. The hash reference contains the following keys:
807 Empty on success, or an error message on errors.
809 =item cust_pkg HASHREF
811 Array reference of hash references, each of which has the fields of a cust_pkg
812 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
813 the internal FS:: objects, but hash references of columns and values.
817 =item part_pkg fields
819 All fields of part_pkg for this specific cust_pkg (be careful with this
820 information - it may reveal more about your available packages than you would
821 like users to know in aggregate)
825 #XXX pare part_pkg fields down to a more secure subset
829 An array of hash references indicating information on unprovisioned services
830 available for provisioning for this specific cust_pkg. Each has the following
835 =item part_svc fields
837 All fields of part_svc (be careful with this information - it may reveal more
838 about your available packages than you would like users to know in aggregate)
842 #XXX pare part_svc fields down to a more secure subset
848 An array of hash references indicating information on the customer services
849 already provisioned for this specific cust_pkg. Each has the following keys:
855 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.
861 Primary key for this service
865 Service definition (see L<FS::part_svc>)
869 Customer package (see L<FS::cust_pkg>)
873 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
881 Returns service information for this customer.
883 Takes a hash reference as parameter with a single key: B<session_id>
885 Returns a hash reference containing customer package information. The hash reference contains the following keys:
895 An array of hash references indicating information on all of this customer's
896 services. Each has the following keys:
902 Primary key for this service
910 Meaningful user-specific identifier for the service (i.e. username, domain, or
915 Account (svc_acct) services also have the following keys:
933 Upload bytes remaining
937 Download bytes remaining
941 Total bytes remaining
943 =item recharge_amount
947 =item recharge_seconds
949 Number of seconds gained by recharge
951 =item recharge_upbytes
953 Number of upload bytes gained by recharge
955 =item recharge_downbytes
957 Number of download bytes gained by recharge
959 =item recharge_totalbytes
961 Number of total bytes gained by recharge
969 Orders a package for this customer.
971 If signup_server-realtime is set, bills the new package, attemps to collect
972 payment and (for auto-payment customers) cancels the package if the payment is
975 Takes a hash reference as parameter with the following keys:
985 Package to order (see L<FS::part_pkg>).
989 Quantity for this package order (default 1).
991 =item run_bill_events
993 If true, runs billing events for the customer after ordering and billing the
994 package (signup_server-realtime must be set).
998 Optional locationnum for this package order, for existing locations.
1000 Or, for new locations, pass the following fields: address1*, address2, city*,
1001 county, state*, zip*, country. (* = required in this case)
1003 (None of this is required at all if you are just ordering a package
1004 at the customer's existing default service location.)
1022 Service to order (see L<FS::part_svc>).
1024 Normally optional; required only to provision a non-svc_acct service, or if the
1025 package definition does not contain one svc_acct service definition with
1026 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
1027 also be specified to indicate that no initial service should be provisioned.
1031 Fields used when provisioning an svc_acct service:
1045 Optional security phrase
1049 Optional Access number number
1053 Fields used when provisioning an svc_domain service:
1063 Fields used when provisioning an svc_phone service:
1081 Fields used when provisioning an svc_external service:
1087 External numeric ID.
1091 External text title.
1095 Fields used when provisioning an svc_pbx service:
1109 Returns a hash reference with a single key, B<error>, empty on success, or an
1110 error message on errors. The special error '_decline' is returned for
1111 declined transactions.
1115 Changes a package for this customer.
1117 Takes a hash reference as parameter with the following keys:
1127 Existing customer package.
1131 New package to order (see L<FS::part_pkg>).
1135 Quantity for this package order (default 1).
1139 Returns a hash reference with the following keys:
1145 Empty on success, or an error message on errors.
1149 On success, the new pkgnum
1156 Provides useful info for early renewals.
1158 Takes a hash reference as parameter with the following keys:
1168 Returns a hash reference. On errors, it contains a single key, B<error>, with
1169 the error message. Otherwise, contains a single key, B<dates>, pointing to
1170 an array refernce of hash references. Each hash reference contains the
1177 (Future) Bill date. Indicates a future date for which billing could be run.
1178 Specified as an integer UNIX timestamp. Pass this value to the B<order_renew>
1181 =item bill_date_pretty
1183 (Future) Bill date as a human-readable string. (Convenience for display;
1184 subject to change, so best not to parse for the date.)
1188 Base amount which will be charged if renewed early as of this date.
1192 Renewal date; i.e. even-futher future date at which the customer will be paid
1193 through if the early renewal is completed with the given B<bill-date>.
1194 Specified as an integer UNIX timestamp.
1196 =item renew_date_pretty
1198 Renewal date as a human-readable string. (Convenience for display;
1199 subject to change, so best not to parse for the date.)
1203 Package that will be renewed.
1207 Expiration date of the package that will be renewed.
1209 =item expire_date_pretty
1211 Expiration date of the package that will be renewed, as a human-readable
1212 string. (Convenience for display; subject to change, so best not to parse for
1219 Renews this customer early; i.e. runs billing for this customer in advance.
1221 Takes a hash reference as parameter with the following keys:
1231 Integer date as returned by the B<renew_info> function, indicating the advance
1232 date for which to run billing.
1236 Returns a hash reference with a single key, B<error>, empty on success, or an
1237 error message on errors.
1241 Cancels a package for this customer.
1243 Takes a hash reference as parameter with the following keys:
1253 pkgpart of package to cancel
1257 Optional date, for future cancellation (expiration) instead of immediate
1258 cancellation. Specified as an integer UNIX timestamp ("epoch time").
1262 Returns a hash reference with a single key, B<error>, empty on success, or an
1263 error message on errors.
1265 =item provision_acct
1267 Provisions an account (svc_acct).
1269 Takes a hash reference as parameter with the following keys:
1279 pkgnum of package into which this service is provisioned
1283 svcpart or service definition to provision
1293 =item provision_phone
1295 Provisions a phone number (svc_phone).
1297 Takes a hash reference as parameter with the following keys:
1307 pkgnum of package into which this service is provisioned
1311 svcpart or service definition to provision
1331 E911 Address (optional)
1337 Provisions a customer PBX (svc_pbx).
1339 Takes a hash reference as parameter with the following keys:
1349 pkgnum of package into which this service is provisioned
1353 svcpart or service definition to provision
1359 =item max_extensions
1361 =item max_simultaneous
1367 =item provision_external
1369 Provisions an external service (svc_external).
1371 Takes a hash reference as parameter with the following keys:
1381 pkgnum of package into which this service is provisioned
1385 svcpart or service definition to provision
1395 =head2 "MY ACCOUNT" CONTACT FUNCTIONS
1399 =item contact_passwd
1401 Changes the password for the currently-logged in contact.
1403 Takes a hash reference as parameter with the following keys:
1413 Returns a hash reference with a single parameter, B<error>, which contains an
1414 error message, or empty on success.
1418 Takes a hash reference as parameter with a single key, B<session_id>.
1420 Returns a hash reference with two parameters: B<error>, which contains an error
1421 message, or empty on success, and B<contacts>, a list of contacts.
1423 B<contacts> is an array reference of hash references (i.e. an array of structs,
1424 in XML-RPC). Each hash reference (struct) has the following keys:
1432 Contact class name (contact type).
1444 Position ("Director of Silly Walks"), NOT honorific ("Mr." or "Mrs.")
1448 Comma-separated list of email addresses
1452 =item selfservice_access
1460 Updates information for the currently-logged in contact, or (optionally) the
1463 Takes a hash reference as parameter with the following keys:
1471 If already logged in as a contact, this is optional.
1481 Returns a hash reference with a single parameter, B<error>, which contains an
1482 error message, or empty on success.
1486 Creates a new contact.
1488 Takes a hash reference as parameter with the following keys:
1502 Optional contact classnum (TODO: or name)
1506 =item selfservice_access
1508 Y to enable self-service access
1514 Returns a hash reference with a single parameter, B<error>, which contains an
1515 error message, or empty on success.
1517 =item delete_contact
1519 Deletes a contact. (Note: Cannot at this time delete the currently-logged in
1522 Takes a hash reference as parameter with the following keys:
1532 Returns a hash reference with a single parameter, B<error>, which contains an
1533 error message, or empty on success.
1537 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1539 All of these functions require the user to be logged in, and the 'session_id'
1540 key to be included in the argument hashref.`
1544 =item list_quotations HASHREF
1546 Returns a hashref listing this customer's active self-service quotations.
1553 an arrayref containing an element for each quotation.
1561 the date it was started
1565 the number of packages
1569 the sum of setup fees
1573 the sum of recurring charges
1577 =item quotation_new HASHREF
1579 Creates an empty quotation and returns a hashref containing 'quotationnum',
1580 the primary key of the new quotation.
1582 =item quotation_delete HASHREF
1584 Disables (does not really delete) a quotation. Takes the following arguments:
1590 =item quotationnum - the quotation to delete
1594 Returns 'error' => a string, which will be empty on success.
1596 =item quotation_info HASHREF
1598 Returns total and detailed pricing information on a quotation.
1600 Takes the following arguments:
1606 =item quotationnum - the quotation to return
1610 Returns a hashref containing:
1612 - total_setup, the total of setup fees (and their taxes)
1613 - total_recur, the total of all recurring charges (and their taxes)
1614 - sections, an arrayref containing an element for each quotation section.
1615 - description, a line of text describing the group of charges
1616 - subtotal, the total of charges in this group (if appropriate)
1617 - detail_items, an arrayref of line items
1618 - pkgnum, the reference number of the package
1619 - description, the package name (or tax name)
1621 - amount, the amount charged
1622 If the detail item represents a subtotal, it will instead contain:
1623 - total_item: description of the subtotal
1624 - total_amount: the subtotal amount
1627 =item quotation_print HASHREF
1629 Renders the quotation as HTML or PDF. Takes the following arguments:
1635 =item quotationnum - the quotation to return
1637 =item format - 'html' or 'pdf'
1641 Returns a hashref containing 'document', the contents of the file.
1643 =item quotation_add_pkg HASHREF
1645 Adds a package to a quotation. Takes the following arguments:
1651 =item pkgpart - the package to add
1653 =item quotationnum - the quotation to add it to
1655 =item quantity - the package quantity (defaults to 1)
1657 =item address1, address2, city, state, zip, country - address fields to set
1658 the service location
1662 Returns 'error' => a string, which will be empty on success.
1664 =item quotation_remove_pkg HASHREF
1666 Removes a package from a quotation. Takes the following arguments:
1672 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1674 =item quotationnum - the quotation to remove it from
1678 Returns 'error' => a string, which will be empty on success.
1680 =item quotation_order HASHREF
1682 Converts the packages in a quotation into real packages. Takes the following
1685 Takes the following arguments:
1691 =item quotationnum - the quotation to order
1697 =head1 SIGNUP FUNCTIONS
1701 =item signup_info HASHREF
1703 Takes a hash reference as parameter with the following keys:
1707 =item session_id - Optional agent/reseller interface session
1711 Returns a hash reference containing information that may be useful in
1712 displaying a signup page. The hash reference contains the following keys:
1716 =item cust_main_county
1718 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.
1722 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
1723 an agentnum specified explicitly via reseller interface session_id in the
1728 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.
1730 =item agentnum2part_pkg
1732 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.
1736 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.
1738 =item security_phrase
1740 True if the "security_phrase" feature is enabled
1744 Array reference of acceptable payment types for signup
1750 credit card - automatic
1754 credit card - on-demand - version 1.5+ only
1758 electronic check - automatic
1762 electronic check - on-demand - version 1.5+ only
1770 billing, not recommended for signups
1774 free, definitely not recommended for signups
1778 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1784 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1788 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".
1794 =item countrydefault
1800 =item new_customer_minimal HASHREF
1802 Creates a new customer.
1804 Current differences from new_customer: An address is not required. promo_code
1805 and reg_code are not supported. If invoicing_list and _password is passed, a
1806 contact will be created with self-service access (no pkgpart or username is
1807 necessary). No initial billing is run (this may change in a future version).
1809 Takes a hash reference as parameter with the following keys:
1815 first name (required)
1819 last name (required)
1823 (not typically collected; mostly used for ACH transactions)
1855 Daytime phone number
1859 Evening phone number
1867 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1871 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1875 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1879 Expiration date for CARD/DCRD
1883 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1885 =item invoicing_list
1887 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),
1889 =item referral_custnum
1891 referring customer number
1899 pkgpart of initial package
1915 Access number (index, not the literal number)
1919 Country code (to be provisioned as a service)
1923 Phone number (to be provisioned as a service)
1931 Returns a hash reference with the following keys:
1937 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)
1941 =item new_customer HASHREF
1943 Creates a new customer. Takes a hash reference as parameter with the
1950 first name (required)
1954 last name (required)
1958 (not typically collected; mostly used for ACH transactions)
1964 =item address1 (required)
1972 =item city (required)
1980 =item state (required)
1984 =item zip (required)
1990 Daytime phone number
1994 Evening phone number
2002 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
2006 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
2010 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
2014 Expiration date for CARD/DCRD
2018 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
2020 =item invoicing_list
2022 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),
2024 =item referral_custnum
2026 referring customer number
2034 pkgpart of initial package
2050 Access number (index, not the literal number)
2054 Country code (to be provisioned as a service)
2058 Phone number (to be provisioned as a service)
2066 Returns a hash reference with the following keys:
2072 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)
2076 =item regionselector HASHREF | LIST
2078 Takes as input a hashref or list of key/value pairs with the following keys:
2082 =item selected_county
2084 Currently selected county
2086 =item selected_state
2088 Currently selected state
2090 =item selected_country
2092 Currently selected country
2096 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2100 Specify a javascript subroutine to call on changes
2106 =item default_country
2112 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>.
2116 Returns a list consisting of three HTML fragments for county selection,
2117 state selection and country selection, respectively.
2121 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
2122 sub regionselector {
2129 $param->{'selected_country'} ||= $param->{'default_country'};
2130 $param->{'selected_state'} ||= $param->{'default_state'};
2132 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2136 my %cust_main_county;
2138 # unless ( @cust_main_county ) { #cache
2139 #@cust_main_county = qsearch('cust_main_county', {} );
2140 #foreach my $c ( @cust_main_county ) {
2141 foreach my $c ( @{ $param->{'locales'} } ) {
2142 #$countyflag=1 if $c->county;
2143 $countyflag=1 if $c->{county};
2144 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
2145 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
2146 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
2149 $countyflag=1 if $param->{selected_county};
2151 my $script_html = <<END;
2153 function opt(what,value,text) {
2154 var optionName = new Option(text, value, false, false);
2155 var length = what.length;
2156 what.options[length] = optionName;
2158 function ${prefix}country_changed(what) {
2159 country = what.options[what.selectedIndex].text;
2160 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
2161 what.form.${prefix}state.options[i] = null;
2163 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
2165 foreach my $country ( sort keys %cust_main_county ) {
2166 $script_html .= "\nif ( country == \"$country\" ) {\n";
2167 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2168 my $text = $state || '(n/a)';
2169 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
2171 $script_html .= "}\n";
2174 $script_html .= <<END;
2176 function ${prefix}state_changed(what) {
2179 if ( $countyflag ) {
2180 $script_html .= <<END;
2181 state = what.options[what.selectedIndex].text;
2182 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
2183 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
2184 what.form.${prefix}county.options[i] = null;
2187 foreach my $country ( sort keys %cust_main_county ) {
2188 $script_html .= "\nif ( country == \"$country\" ) {\n";
2189 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2190 $script_html .= "\nif ( state == \"$state\" ) {\n";
2191 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
2192 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
2193 my $text = $county || '(n/a)';
2195 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
2197 $script_html .= "}\n";
2199 $script_html .= "}\n";
2203 $script_html .= <<END;
2208 my $county_html = $script_html;
2209 if ( $countyflag ) {
2210 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
2211 foreach my $county (
2212 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2214 my $text = $county || '(n/a)';
2215 $county_html .= qq!<OPTION VALUE="$county"!.
2216 ($county eq $param->{'selected_county'} ?
2223 $county_html .= '</SELECT>';
2226 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2229 my $state_html = qq!<SELECT NAME="${prefix}state" !.
2230 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2231 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2232 my $text = $state || '(n/a)';
2233 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2234 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
2236 $state_html .= '</SELECT>';
2238 my $country_html = '';
2239 if ( scalar( keys %cust_main_county ) > 1 ) {
2241 $country_html = qq(<SELECT NAME="${prefix}country" ).
2242 qq(onChange="${prefix}country_changed(this); ).
2243 $param->{'onchange'}.
2246 my $countrydefault = $param->{default_country} || 'US';
2247 foreach my $country (
2248 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2249 keys %cust_main_county
2251 my $selected = $country eq $param->{'selected_country'}
2254 $country_html .= "\n<OPTION$selected>$country</OPTION>"
2256 $country_html .= '</SELECT>';
2259 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2260 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2264 ($county_html, $state_html, $country_html);
2268 sub regionselector_hashref {
2269 my ($county_html, $state_html, $country_html) = regionselector(@_);
2271 'county_html' => $county_html,
2272 'state_html' => $state_html,
2273 'country_html' => $country_html,
2277 =item location_form HASHREF | LIST
2279 Takes as input a hashref or list of key/value pairs with the following keys:
2285 Current customer session_id
2289 Omit red asterisks from required fields.
2291 =item address1_label
2293 Label for first address line.
2297 Returns an HTML fragment for a location form (address, city, state, zip,
2310 my $session_id = delete $param->{'session_id'};
2312 my $rv = mason_comp( 'session_id' => $session_id,
2313 'comp' => '/elements/location.html',
2314 'args' => [ %$param ],
2318 $rv->{'error'} || $rv->{'output'};
2323 #=item expselect HASHREF | LIST
2325 #Takes as input a hashref or list of key/value pairs with the following keys:
2329 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2331 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2335 =item expselect PREFIX [ DATE ]
2337 Takes as input a unique prefix string and the current expiration date, in
2338 yyyy-mm-dd or m-d-yyyy format
2340 Returns an HTML fragments for expiration date selection.
2346 #if ( ref($_[0]) ) {
2350 #my $prefix = $param->{'prefix'};
2351 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2352 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2354 my $date = scalar(@_) ? shift : '';
2356 my( $m, $y ) = ( 0, 0 );
2357 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2358 ( $m, $y ) = ( $2, $1 );
2359 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2360 ( $m, $y ) = ( $1, $3 );
2362 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2364 $return .= qq!<OPTION VALUE="$_"!;
2365 $return .= " SELECTED" if $_ == $m;
2368 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2370 my $thisYear = $t[5] + 1900;
2371 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2372 $return .= qq!<OPTION VALUE="$_"!;
2373 $return .= " SELECTED" if $_ == $y;
2376 $return .= "</SELECT>";
2381 =item popselector HASHREF | LIST
2383 Takes as input a hashref or list of key/value pairs with the following keys:
2389 Access number number
2393 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>.
2397 Returns an HTML fragment for access number selection.
2401 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2409 my $popnum = $param->{'popnum'};
2410 my $pops = $param->{'pops'};
2412 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2413 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2414 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2415 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2416 if scalar(@$pops) == 1;
2419 my %popnum2pop = ();
2421 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2422 $popnum2pop{$_->{popnum}} = $_;
2427 function opt(what,href,text) {
2428 var optionName = new Option(text, href, false, false)
2429 var length = what.length;
2430 what.options[length] = optionName;
2434 my $init_popstate = $param->{'init_popstate'};
2435 if ( $init_popstate ) {
2436 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2437 $init_popstate. '">';
2440 function acstate_changed(what) {
2441 state = what.options[what.selectedIndex].text;
2442 what.form.popac.options.length = 0
2443 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2447 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2448 foreach my $state ( sort { $a cmp $b } @states ) {
2449 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2451 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2452 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2453 if ($ac eq $param->{'popac'}) {
2454 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2457 $text .= "}\n" unless $init_popstate;
2459 $text .= "popac_changed(what.form.popac)}\n";
2462 function popac_changed(what) {
2463 ac = what.options[what.selectedIndex].text;
2464 what.form.popnum.options.length = 0;
2465 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2469 foreach my $state ( @states ) {
2470 foreach my $popac ( keys %{ $pop{$state} } ) {
2471 $text .= "\nif ( ac == \"$popac\" ) {\n";
2473 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2474 my $o_popnum = $pop->{popnum};
2475 my $poptext = $pop->{city}. ', '. $pop->{state}.
2476 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2478 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2479 if ($popnum == $o_popnum) {
2480 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2488 $text .= "}\n</SCRIPT>\n";
2490 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2493 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2494 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2495 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2496 ">$_" foreach sort { $a cmp $b } @states;
2497 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2500 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2501 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2503 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2506 #comment this block to disable initial list polulation
2507 my @initial_select = ();
2508 if ( scalar( @$pops ) > 100 ) {
2509 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2511 @initial_select = @$pops;
2513 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2514 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2515 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2516 $pop->{city}. ', '. $pop->{state}.
2517 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2520 $text .= qq!</SELECT></TD></TR></TABLE>!;
2526 =item domainselector HASHREF | LIST
2528 Takes as input a hashref or list of key/value pairs with the following keys:
2538 Service number of the selected item.
2542 Returns an HTML fragment for domain selection.
2546 sub domainselector {
2553 my $domsvc= $param->{'domsvc'};
2555 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2556 my $domains = $rv->{'domains'};
2557 $domsvc = $rv->{'domsvc'} unless $domsvc;
2559 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2560 unless scalar(keys %$domains);
2562 if (scalar(keys %$domains) == 1) {
2564 foreach(keys %$domains) {
2567 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2568 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2571 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2573 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2575 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2576 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2577 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2578 $domains->{$domain};
2581 $text .= qq!</SELECT></TD></TR>!;
2587 =item didselector HASHREF | LIST
2589 Takes as input a hashref or list of key/value pairs with the following keys:
2595 Field name for the returned HTML fragment.
2599 Service definition (see L<FS::part_svc>)
2603 Returns an HTML fragment for DID selection.
2615 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2616 'args'=>[ %$param ],
2620 $rv->{'error'} || $rv->{'output'};
2626 =head1 RESELLER FUNCTIONS
2628 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2629 with their active session, and the B<customer_info> and B<order_pkg> functions
2630 with their active session and an additional I<custnum> parameter.
2632 For the most part, development of the reseller web interface has been
2633 superceded by agent-virtualized access to the backend.
2645 =item agent_list_customers
2647 List agent's customers.
2655 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>