1 package FS::SelfService;
4 use vars qw( $VERSION @ISA @EXPORT_OK $DEBUG
5 $skip_uid_check $dir $socket %autoload $tag );
11 use Storable 2.09 qw(nstore_fd fd_retrieve);
15 @ISA = qw( Exporter );
19 $dir = "/usr/local/freeside";
20 $socket = "$dir/selfservice_socket";
21 $socket .= '.'.$tag if defined $tag && length($tag);
23 #maybe should ask ClientAPI for this list
25 'passwd' => 'passwd/passwd',
26 'chfn' => 'passwd/passwd',
27 'chsh' => 'passwd/passwd',
28 'login_info' => 'MyAccount/login_info',
29 'login_banner_image' => 'MyAccount/login_banner_image',
30 'login' => 'MyAccount/login',
31 'logout' => 'MyAccount/logout',
32 'switch_acct' => 'MyAccount/switch_acct',
33 'customer_info' => 'MyAccount/customer_info',
34 'customer_info_short' => 'MyAccount/customer_info_short',
36 'contact_passwd' => 'MyAccount/contact/contact_passwd',
37 'list_contacts' => 'MyAccount/contact/list_contacts',
38 'edit_contact' => 'MyAccount/contact/edit_contact',
39 'delete_contact' => 'MyAccount/contact/delete_contact',
40 'new_contact' => 'MyAccount/contact/new_contact',
42 'billing_history' => 'MyAccount/billing_history',
43 'edit_info' => 'MyAccount/edit_info', #add to ss cgi!
44 'invoice' => 'MyAccount/invoice',
45 'invoice_pdf' => 'MyAccount/invoice_pdf',
46 'legacy_invoice' => 'MyAccount/legacy_invoice',
47 'legacy_invoice_pdf' => 'MyAccount/legacy_invoice_pdf',
48 'invoice_logo' => 'MyAccount/invoice_logo',
49 'list_invoices' => 'MyAccount/list_invoices', #?
50 'cancel' => 'MyAccount/cancel', #add to ss cgi!
51 'payment_info' => 'MyAccount/payment_info',
52 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info',
53 'process_payment' => 'MyAccount/process_payment',
54 'store_payment' => 'MyAccount/store_payment',
55 'process_stored_payment' => 'MyAccount/process_stored_payment',
56 'process_payment_order_pkg' => 'MyAccount/process_payment_order_pkg',
57 'process_payment_change_pkg' => 'MyAccount/process_payment_change_pkg',
58 'process_payment_order_renew' => 'MyAccount/process_payment_order_renew',
59 'process_prepay' => 'MyAccount/process_prepay',
60 'realtime_collect' => 'MyAccount/realtime_collect',
61 'list_pkgs' => 'MyAccount/list_pkgs', #add to ss (added?)
62 'list_svcs' => 'MyAccount/list_svcs', #add to ss (added?)
63 'list_svc_usage' => 'MyAccount/list_svc_usage',
64 'svc_status_html' => 'MyAccount/svc_status_html',
65 'svc_status_hash' => 'MyAccount/svc_status_hash',
66 'set_svc_status_hash' => 'MyAccount/set_svc_status_hash',
67 'set_svc_status_listadd' => 'MyAccount/set_svc_status_listadd',
68 'set_svc_status_listdel' => 'MyAccount/set_svc_status_listdel',
69 'set_svc_status_vacationadd'=> 'MyAccount/set_svc_status_vacationadd',
70 'set_svc_status_vacationdel'=> 'MyAccount/set_svc_status_vacationdel',
71 'acct_forward_info' => 'MyAccount/acct_forward_info',
72 'process_acct_forward' => 'MyAccount/process_acct_forward',
73 'list_dsl_devices' => 'MyAccount/list_dsl_devices',
74 'add_dsl_device' => 'MyAccount/add_dsl_device',
75 'delete_dsl_device' => 'MyAccount/delete_dsl_device',
76 'port_graph' => 'MyAccount/port_graph',
77 'list_cdr_usage' => 'MyAccount/list_cdr_usage',
78 'list_support_usage' => 'MyAccount/list_support_usage',
79 'order_pkg' => 'MyAccount/order_pkg', #add to ss cgi!
80 'change_pkg' => 'MyAccount/change_pkg',
81 'order_recharge' => 'MyAccount/order_recharge',
82 'renew_info' => 'MyAccount/renew_info',
83 'order_renew' => 'MyAccount/order_renew',
84 'cancel_pkg' => 'MyAccount/cancel_pkg', #add to ss cgi!
85 'suspend_pkg' => 'MyAccount/suspend_pkg', #add to ss cgi!
86 'charge' => 'MyAccount/charge', #?
87 'part_svc_info' => 'MyAccount/part_svc_info',
88 'provision_acct' => 'MyAccount/provision_acct',
89 'provision_phone' => 'MyAccount/provision_phone',
90 'provision_pbx' => 'MyAccount/provision_pbx',
91 'provision_external' => 'MyAccount/provision_external',
92 'provision_forward' => 'MyAccount/provision_forward',
93 'unprovision_svc' => 'MyAccount/unprovision_svc',
94 'myaccount_passwd' => 'MyAccount/myaccount_passwd',
95 'reset_passwd' => 'MyAccount/reset_passwd',
96 'check_reset_passwd' => 'MyAccount/check_reset_passwd',
97 'process_reset_passwd' => 'MyAccount/process_reset_passwd',
98 'validate_passwd' => 'MyAccount/validate_passwd',
99 'list_tickets' => 'MyAccount/list_tickets',
100 'create_ticket' => 'MyAccount/create_ticket',
101 'get_ticket' => 'MyAccount/get_ticket',
102 'adjust_ticket_priority' => 'MyAccount/adjust_ticket_priority',
103 'did_report' => 'MyAccount/did_report',
104 'signup_info' => 'Signup/signup_info',
105 'skin_info' => 'MyAccount/skin_info',
106 'access_info' => 'MyAccount/access_info',
107 'domain_select_hash' => 'Signup/domain_select_hash', # expose?
108 'new_customer' => 'Signup/new_customer',
109 'new_customer_minimal' => 'Signup/new_customer_minimal',
110 'capture_payment' => 'Signup/capture_payment',
111 #N/A 'clear_signup_cache' => 'Signup/clear_cache',
112 'new_agent' => 'Agent/new_agent',
113 'agent_login' => 'Agent/agent_login',
114 'agent_logout' => 'Agent/agent_logout',
115 'agent_info' => 'Agent/agent_info',
116 'agent_list_customers' => 'Agent/agent_list_customers',
117 'check_username' => 'Agent/check_username',
118 'suspend_username' => 'Agent/suspend_username',
119 'unsuspend_username' => 'Agent/unsuspend_username',
120 'mason_comp' => 'MasonComponent/mason_comp',
121 'call_time' => 'PrepaidPhone/call_time',
122 'call_time_nanpa' => 'PrepaidPhone/call_time_nanpa',
123 'phonenum_balance' => 'PrepaidPhone/phonenum_balance',
125 'start_thirdparty' => 'MyAccount/start_thirdparty',
126 'finish_thirdparty' => 'MyAccount/finish_thirdparty',
128 'list_quotations' => 'MyAccount/quotation/list_quotations',
129 'quotation_new' => 'MyAccount/quotation/quotation_new',
130 'quotation_delete' => 'MyAccount/quotation/quotation_delete',
131 'quotation_info' => 'MyAccount/quotation/quotation_info',
132 'quotation_print' => 'MyAccount/quotation/quotation_print',
133 'quotation_add_pkg' => 'MyAccount/quotation/quotation_add_pkg',
134 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg',
135 'quotation_order' => 'MyAccount/quotation/quotation_order',
137 'freesideinc_service' => 'Freeside/freesideinc_service',
142 qw( regionselector regionselector_hashref location_form
143 expselect popselector domainselector didselector
147 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
148 $ENV{'SHELL'} = '/bin/sh';
149 $ENV{'IFS'} = " \t\n";
152 $ENV{'BASH_ENV'} = '';
154 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
155 #if you grant appropriate permissions to whatever user
156 my $freeside_uid = scalar(getpwnam('freeside'));
157 die "not running as the freeside user\n"
158 if $> != $freeside_uid && ! $skip_uid_check;
160 -e $dir or die "FATAL: $dir doesn't exist!";
161 -d $dir or die "FATAL: $dir isn't a directory!";
162 -r $dir or die "FATAL: Can't read $dir as freeside user!";
163 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
165 foreach my $autoload ( keys %autoload ) {
168 "sub $autoload { ". '
173 #warn scalar(@_). ": ". join(" / ", @_);
177 $param->{_packet} = \''. $autoload{$autoload}. '\';
179 simple_packet($param);
189 warn "sending ". $packet->{_packet}. " to server"
191 socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
192 connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
193 nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
196 #shoudl trap: Magic number checking on storable file failed at blib/lib/Storable.pm (autosplit into blib/lib/auto/Storable/fd_retrieve.al) line 337, at /usr/local/share/perl/5.6.1/FS/SelfService.pm line 71
198 #block until there is a message on socket
199 # my $w = new IO::Select;
201 # my @wait = $w->can_read;
203 warn "reading message from server"
206 my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
207 die $return->{'_error'} if defined $return->{_error} && $return->{_error};
209 warn "returning message to client"
217 FS::SelfService - Freeside self-service API
221 # password and shell account changes
222 use FS::SelfService qw(passwd chfn chsh);
224 # "my account" functionality
225 use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
227 #new-style login with an email address and password
228 # can also be used for svc_acct login, set $emailaddress to username@domain
229 my $rv = login ( { 'email' => $emailaddress,
230 'password' => $password,
233 if ( $rv->{'error'} ) {
234 #handle login error...
237 $session_id = $rv->{'session_id'};
240 #classic svc_acct-based login with separate username and password
241 my $rv = login( { 'username' => $username,
243 'password' => $password,
246 if ( $rv->{'error'} ) {
247 #handle login error...
250 $session_id = $rv->{'session_id'};
253 #svc_phone login with phone number and PIN
254 my $rv = login( { 'username' => $phone_number,
255 'domain' => 'svc_phone',
259 if ( $rv->{'error'} ) {
260 #handle login error...
263 $session_id = $rv->{'session_id'};
266 my $customer_info = customer_info( { 'session_id' => $session_id } );
268 #payment_info and process_payment are available in 1.5+ only
269 my $payment_info = payment_info( { 'session_id' => $session_id } );
271 #!!! process_payment example
273 #!!! list_pkgs example
275 #!!! order_pkg example
277 #quoting a package, then ordering after confirmation
279 my $rv = quotation_new({ 'session_id' => $session_id });
280 my $qnum = $rv->{quotationnum};
281 # add packages to the quotation
282 $rv = quotation_add_pkg({ 'session_id' => $session_id,
283 'quotationnum' => $qnum,
284 'pkgpart' => $pkgpart,
285 'quantity' => $quantity, # defaults to 1
287 # repeat until all packages are added
288 # view the pricing information
289 $rv = quotation_info({ 'session_id' => $session_id,
290 'quotationnum' => $qnum,
292 print "Total setup charges: ".$rv->{total_setup}."\n".
293 "Total recurring charges: ".$rv->{total_recur}."\n";
294 # quotation_info also provides a detailed breakdown of charges, in
297 # ask customer for confirmation, then:
298 $rv = quotation_order({ 'session_id' => $session_id,
299 'quotationnum' => $qnum,
302 #!!! cancel_pkg example
304 # signup functionality
305 use FS::SelfService qw( signup_info new_customer new_customer_minimal );
307 my $signup_info = signup_info;
309 $rv = new_customer( {
312 'company' => $company,
313 'address1' => $address1,
314 'address2' => $address2,
318 'country' => $country,
319 'daytime' => $daytime,
323 'payinfo' => $payinfo,
325 'paystart_month' => $paystart_month
326 'paystart_year' => $paystart_year,
327 'payissue' => $payissue,
329 'paydate' => $paydate,
330 'payname' => $payname,
331 'invoicing_list' => $invoicing_list,
332 'referral_custnum' => $referral_custnum,
333 'agentnum' => $agentnum,
334 'pkgpart' => $pkgpart,
336 'username' => $username,
337 '_password' => $password,
341 'phonenum' => $phonenum,
346 my $error = $rv->{'error'};
347 if ( $error eq '_decline' ) {
357 Use this API to implement your own client "self-service" module.
359 If you just want to customize the look of the existing "self-service" module,
362 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
368 Changes the password for an existing user in svc_acct. Takes a hash
369 reference with the following keys:
375 Username of the account (required)
379 Domain of the account (required)
383 Old password (required)
387 New password (required)
405 =head1 "MY ACCOUNT" FUNCTIONS
411 Creates a user session. Takes a hash reference as parameter with the
418 Email address (username@domain), instead of username and domain. Required for
419 contact-based self-service login, can also be used for svc_acct-based login.
435 Returns a hash reference with the following keys:
441 Empty on success, or an error message on errors.
445 Session identifier for successful logins
449 =item customer_info HASHREF
451 Returns general customer information.
453 Takes a hash reference as parameter with a single key: B<session_id>
455 Returns a hash reference with the following keys:
469 Array reference of hash references of open inoices. Each hash reference has
470 the following keys: invnum, date, owed
474 An HTML fragment containing shipping and billing addresses.
476 =item The following fields are also returned
478 first last company address1 address2 city county state zip country daytime night fax ship_first ship_last ship_company ship_address1 ship_address2 ship_city ship_state ship_zip ship_country ship_daytime ship_night ship_fax payby payinfo payname month year invoicing_list postal_invoicing
482 =item edit_info HASHREF
484 Takes a hash reference as parameter with any of the following keys:
486 first last company address1 address2 city county state zip country daytime night fax ship_first ship_last ship_company ship_address1 ship_address2 ship_city ship_state ship_zip ship_country ship_daytime ship_night ship_fax payby payinfo paycvv payname month year invoicing_list postal_invoicing
488 If a field exists, the customer record is updated with the new value of that
489 field. If a field does not exist, that field is not changed on the customer
492 Returns a hash reference with a single key, B<error>, empty on success, or an
493 error message on errors
495 =item invoice HASHREF
497 Returns an invoice. Takes a hash reference as parameter with two keys:
498 session_id and invnum
500 Returns a hash reference with the following keys:
506 Empty on success, or an error message on errors
518 =item list_invoices HASHREF
520 Returns a list of all customer invoices. Takes a hash reference with a single
523 Returns a hash reference with the following keys:
529 Empty on success, or an error message on errors
533 Reference to array of hash references with the following keys:
543 Invoice date, in UNIX epoch time
551 Cancels this customer.
553 Takes a hash reference as parameter with a single key: B<session_id>
555 Returns a hash reference with a single key, B<error>, which is empty on
556 success or an error message on errors.
558 =item payment_info HASHREF
560 Returns information that may be useful in displaying a payment page.
562 Takes a hash reference as parameter with a single key: B<session_id>.
564 Returns a hash reference with the following keys:
570 Empty on success, or an error message on errors
578 Exact name on credit card (CARD/DCRD)
602 Customer's current default payment type.
606 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
610 For CARD/DCRD payment types, the card number
614 For CARD/DCRD payment types, expiration month
618 For CARD/DCRD payment types, expiration year
620 =item cust_main_county
622 County/state/country data - array reference of hash references, each of which has the fields of a cust_main_county record (see L<FS::cust_main_county>). Note these are not FS::cust_main_county objects, but hash references of columns and values.
626 Array reference of all states in the current default country.
630 Hash reference of card types; keys are card types, values are the exact strings
631 passed to the process_payment function
635 #this doesn't actually work yet
639 #Unique transaction identifier (prevents multiple charges), passed to the
640 #process_payment function
644 =item process_payment HASHREF
646 Processes a payment and possible change of address or payment type. Takes a
647 hash reference as parameter with the following keys:
661 If true, address and card information entered will be saved for subsequent
666 If true, future credit card payments will be done automatically (sets payby to
667 CARD). If false, future credit card payments will be done on-demand (sets
668 payby to DCRD). This option only has meaning if B<save> is set true.
696 Two-letter country code
704 Card expiration month
712 #this doesn't actually work yet
716 #Unique transaction identifier, returned from the payment_info function.
717 #Prevents multiple charges.
721 Returns a hash reference with a single key, B<error>, empty on success, or an
722 error message on errors.
724 =item process_payment_order_pkg
726 Combines the B<process_payment> and B<order_pkg> functions in one step. If the
727 payment processes sucessfully, the package is ordered. Takes a hash reference
728 as parameter with the keys of both methods.
730 Returns a hash reference with a single key, B<error>, empty on success, or an
731 error message on errors.
733 =item process_payment_change_pkg
735 Combines the B<process_payment> and B<change_pkg> functions in one step. If the
736 payment processes sucessfully, the package is ordered. Takes a hash reference
737 as parameter with the keys of both methods.
739 Returns a hash reference with a single key, B<error>, empty on success, or an
740 error message on errors.
743 =item process_payment_order_renew
745 Combines the B<process_payment> and B<order_renew> functions in one step. If
746 the payment processes sucessfully, the renewal is processed. Takes a hash
747 reference as parameter with the keys of both methods.
749 Returns a hash reference with a single key, B<error>, empty on success, or an
750 error message on errors.
754 Returns package information for this customer. For more detail on services,
757 Takes a hash reference as parameter with a single key: B<session_id>
759 Returns a hash reference containing customer package information. The hash reference contains the following keys:
769 Empty on success, or an error message on errors.
771 =item cust_pkg HASHREF
773 Array reference of hash references, each of which has the fields of a cust_pkg
774 record (see L<FS::cust_pkg>) as well as the fields below. Note these are not
775 the internal FS:: objects, but hash references of columns and values.
779 =item part_pkg fields
781 All fields of part_pkg for this specific cust_pkg (be careful with this
782 information - it may reveal more about your available packages than you would
783 like users to know in aggregate)
787 #XXX pare part_pkg fields down to a more secure subset
791 An array of hash references indicating information on unprovisioned services
792 available for provisioning for this specific cust_pkg. Each has the following
797 =item part_svc fields
799 All fields of part_svc (be careful with this information - it may reveal more
800 about your available packages than you would like users to know in aggregate)
804 #XXX pare part_svc fields down to a more secure subset
810 An array of hash references indicating information on the customer services
811 already provisioned for this specific cust_pkg. Each has the following keys:
817 Array reference with three elements: The first element is the name of this service. The second element is a meaningful user-specific identifier for the service (i.e. username, domain or mail alias). The last element is the table name of this service.
823 Primary key for this service
827 Service definition (see L<FS::part_svc>)
831 Customer package (see L<FS::cust_pkg>)
835 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
843 Returns service information for this customer.
845 Takes a hash reference as parameter with a single key: B<session_id>
847 Returns a hash reference containing customer package information. The hash reference contains the following keys:
857 An array of hash references indicating information on all of this customer's
858 services. Each has the following keys:
864 Primary key for this service
872 Meaningful user-specific identifier for the service (i.e. username, domain, or
877 Account (svc_acct) services also have the following keys:
895 Upload bytes remaining
899 Download bytes remaining
903 Total bytes remaining
905 =item recharge_amount
909 =item recharge_seconds
911 Number of seconds gained by recharge
913 =item recharge_upbytes
915 Number of upload bytes gained by recharge
917 =item recharge_downbytes
919 Number of download bytes gained by recharge
921 =item recharge_totalbytes
923 Number of total bytes gained by recharge
931 Orders a package for this customer.
933 If signup_server-realtime is set, bills the new package, attemps to collect
934 payment and (for auto-payment customers) cancels the package if the payment is
937 Takes a hash reference as parameter with the following keys:
947 Package to order (see L<FS::part_pkg>).
951 Quantity for this package order (default 1).
953 =item run_bill_events
955 If true, runs billing events for the customer after ordering and billing the
956 package (signup_server-realtime must be set).
960 Optional locationnum for this package order, for existing locations.
962 Or, for new locations, pass the following fields: address1*, address2, city*,
963 county, state*, zip*, country. (* = required in this case)
965 (None of this is required at all if you are just ordering a package
966 at the customer's existing default service location.)
984 Service to order (see L<FS::part_svc>).
986 Normally optional; required only to provision a non-svc_acct service, or if the
987 package definition does not contain one svc_acct service definition with
988 quantity 1 (it may contain others with quantity >1). A svcpart of "none" can
989 also be specified to indicate that no initial service should be provisioned.
993 Fields used when provisioning an svc_acct service:
1007 Optional security phrase
1011 Optional Access number number
1015 Fields used when provisioning an svc_domain service:
1025 Fields used when provisioning an svc_phone service:
1043 Fields used when provisioning an svc_external service:
1049 External numeric ID.
1053 External text title.
1057 Fields used when provisioning an svc_pbx service:
1071 Returns a hash reference with a single key, B<error>, empty on success, or an
1072 error message on errors. The special error '_decline' is returned for
1073 declined transactions.
1077 Changes a package for this customer.
1079 Takes a hash reference as parameter with the following keys:
1089 Existing customer package.
1093 New package to order (see L<FS::part_pkg>).
1097 Quantity for this package order (default 1).
1101 Returns a hash reference with the following keys:
1107 Empty on success, or an error message on errors.
1111 On success, the new pkgnum
1118 Provides useful info for early renewals.
1120 Takes a hash reference as parameter with the following keys:
1130 Returns a hash reference. On errors, it contains a single key, B<error>, with
1131 the error message. Otherwise, contains a single key, B<dates>, pointing to
1132 an array refernce of hash references. Each hash reference contains the
1139 (Future) Bill date. Indicates a future date for which billing could be run.
1140 Specified as an integer UNIX timestamp. Pass this value to the B<order_renew>
1143 =item bill_date_pretty
1145 (Future) Bill date as a human-readable string. (Convenience for display;
1146 subject to change, so best not to parse for the date.)
1150 Base amount which will be charged if renewed early as of this date.
1154 Renewal date; i.e. even-futher future date at which the customer will be paid
1155 through if the early renewal is completed with the given B<bill-date>.
1156 Specified as an integer UNIX timestamp.
1158 =item renew_date_pretty
1160 Renewal date as a human-readable string. (Convenience for display;
1161 subject to change, so best not to parse for the date.)
1165 Package that will be renewed.
1169 Expiration date of the package that will be renewed.
1171 =item expire_date_pretty
1173 Expiration date of the package that will be renewed, as a human-readable
1174 string. (Convenience for display; subject to change, so best not to parse for
1181 Renews this customer early; i.e. runs billing for this customer in advance.
1183 Takes a hash reference as parameter with the following keys:
1193 Integer date as returned by the B<renew_info> function, indicating the advance
1194 date for which to run billing.
1198 Returns a hash reference with a single key, B<error>, empty on success, or an
1199 error message on errors.
1203 Cancels a package for this customer.
1205 Takes a hash reference as parameter with the following keys:
1215 pkgpart of package to cancel
1219 Optional date, for future cancellation (expiration) instead of immediate
1220 cancellation. Specified as an integer UNIX timestamp ("epoch time").
1224 Returns a hash reference with a single key, B<error>, empty on success, or an
1225 error message on errors.
1227 =item provision_acct
1229 Provisions an account (svc_acct).
1231 Takes a hash reference as parameter with the following keys:
1241 pkgnum of package into which this service is provisioned
1245 svcpart or service definition to provision
1255 =item provision_phone
1257 Provisions a phone number (svc_phone).
1259 Takes a hash reference as parameter with the following keys:
1269 pkgnum of package into which this service is provisioned
1273 svcpart or service definition to provision
1293 E911 Address (optional)
1299 Provisions a customer PBX (svc_pbx).
1301 Takes a hash reference as parameter with the following keys:
1311 pkgnum of package into which this service is provisioned
1315 svcpart or service definition to provision
1321 =item max_extensions
1323 =item max_simultaneous
1329 =item provision_external
1331 Provisions an external service (svc_external).
1333 Takes a hash reference as parameter with the following keys:
1343 pkgnum of package into which this service is provisioned
1347 svcpart or service definition to provision
1357 =head2 "MY ACCOUNT" CONTACT FUNCTIONS
1361 =item contact_passwd
1363 Changes the password for the currently-logged in contact.
1365 Takes a hash reference as parameter with the following keys:
1375 Returns a hash reference with a single parameter, B<error>, which contains an
1376 error message, or empty on success.
1380 Takes a hash reference as parameter with a single key, B<session_id>.
1382 Returns a hash reference with two parameters: B<error>, which contains an error
1383 message, or empty on success, and B<contacts>, a list of contacts.
1385 B<contacts> is an array reference of hash references (i.e. an array of structs,
1386 in XML-RPC). Each hash reference (struct) has the following keys:
1394 Contact class name (contact type).
1406 Position ("Director of Silly Walks"), NOT honorific ("Mr." or "Mrs.")
1410 Comma-separated list of email addresses
1414 =item selfservice_access
1422 Updates information for the currently-logged in contact, or (optionally) the
1425 Takes a hash reference as parameter with the following keys:
1433 If already logged in as a contact, this is optional.
1443 Returns a hash reference with a single parameter, B<error>, which contains an
1444 error message, or empty on success.
1448 Creates a new contact.
1450 Takes a hash reference as parameter with the following keys:
1464 Optional contact classnum (TODO: or name)
1468 =item selfservice_access
1470 Y to enable self-service access
1476 Returns a hash reference with a single parameter, B<error>, which contains an
1477 error message, or empty on success.
1479 =item delete_contact
1481 Deletes a contact. (Note: Cannot at this time delete the currently-logged in
1484 Takes a hash reference as parameter with the following keys:
1494 Returns a hash reference with a single parameter, B<error>, which contains an
1495 error message, or empty on success.
1499 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1501 All of these functions require the user to be logged in, and the 'session_id'
1502 key to be included in the argument hashref.`
1506 =item list_quotations HASHREF
1508 Returns a hashref listing this customer's active self-service quotations.
1515 an arrayref containing an element for each quotation.
1523 the date it was started
1527 the number of packages
1531 the sum of setup fees
1535 the sum of recurring charges
1539 =item quotation_new HASHREF
1541 Creates an empty quotation and returns a hashref containing 'quotationnum',
1542 the primary key of the new quotation.
1544 =item quotation_delete HASHREF
1546 Disables (does not really delete) a quotation. Takes the following arguments:
1552 =item quotationnum - the quotation to delete
1556 Returns 'error' => a string, which will be empty on success.
1558 =item quotation_info HASHREF
1560 Returns total and detailed pricing information on a quotation.
1562 Takes the following arguments:
1568 =item quotationnum - the quotation to return
1572 Returns a hashref containing:
1574 - total_setup, the total of setup fees (and their taxes)
1575 - total_recur, the total of all recurring charges (and their taxes)
1576 - sections, an arrayref containing an element for each quotation section.
1577 - description, a line of text describing the group of charges
1578 - subtotal, the total of charges in this group (if appropriate)
1579 - detail_items, an arrayref of line items
1580 - pkgnum, the reference number of the package
1581 - description, the package name (or tax name)
1583 - amount, the amount charged
1584 If the detail item represents a subtotal, it will instead contain:
1585 - total_item: description of the subtotal
1586 - total_amount: the subtotal amount
1589 =item quotation_print HASHREF
1591 Renders the quotation as HTML or PDF. Takes the following arguments:
1597 =item quotationnum - the quotation to return
1599 =item format - 'html' or 'pdf'
1603 Returns a hashref containing 'document', the contents of the file.
1605 =item quotation_add_pkg HASHREF
1607 Adds a package to a quotation. Takes the following arguments:
1613 =item pkgpart - the package to add
1615 =item quotationnum - the quotation to add it to
1617 =item quantity - the package quantity (defaults to 1)
1619 =item address1, address2, city, state, zip, country - address fields to set
1620 the service location
1624 Returns 'error' => a string, which will be empty on success.
1626 =item quotation_remove_pkg HASHREF
1628 Removes a package from a quotation. Takes the following arguments:
1634 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1636 =item quotationnum - the quotation to remove it from
1640 Returns 'error' => a string, which will be empty on success.
1642 =item quotation_order HASHREF
1644 Converts the packages in a quotation into real packages. Takes the following
1647 Takes the following arguments:
1653 =item quotationnum - the quotation to order
1659 =head1 SIGNUP FUNCTIONS
1663 =item signup_info HASHREF
1665 Takes a hash reference as parameter with the following keys:
1669 =item session_id - Optional agent/reseller interface session
1673 Returns a hash reference containing information that may be useful in
1674 displaying a signup page. The hash reference contains the following keys:
1678 =item cust_main_county
1680 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.
1684 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
1685 an agentnum specified explicitly via reseller interface session_id in the
1690 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.
1692 =item agentnum2part_pkg
1694 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.
1698 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.
1700 =item security_phrase
1702 True if the "security_phrase" feature is enabled
1706 Array reference of acceptable payment types for signup
1712 credit card - automatic
1716 credit card - on-demand - version 1.5+ only
1720 electronic check - automatic
1724 electronic check - on-demand - version 1.5+ only
1732 billing, not recommended for signups
1736 free, definitely not recommended for signups
1740 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1746 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1750 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".
1756 =item countrydefault
1762 =item new_customer_minimal HASHREF
1764 Creates a new customer.
1766 Current differences from new_customer: An address is not required. promo_code
1767 and reg_code are not supported. If invoicing_list and _password is passed, a
1768 contact will be created with self-service access (no pkgpart or username is
1769 necessary). No initial billing is run (this may change in a future version).
1771 Takes a hash reference as parameter with the following keys:
1777 first name (required)
1781 last name (required)
1785 (not typically collected; mostly used for ACH transactions)
1817 Daytime phone number
1821 Evening phone number
1829 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1833 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1837 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1841 Expiration date for CARD/DCRD
1845 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1847 =item invoicing_list
1849 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),
1851 =item referral_custnum
1853 referring customer number
1861 pkgpart of initial package
1877 Access number (index, not the literal number)
1881 Country code (to be provisioned as a service)
1885 Phone number (to be provisioned as a service)
1893 Returns a hash reference with the following keys:
1899 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)
1903 =item new_customer HASHREF
1905 Creates a new customer. Takes a hash reference as parameter with the
1912 first name (required)
1916 last name (required)
1920 (not typically collected; mostly used for ACH transactions)
1926 =item address1 (required)
1934 =item city (required)
1942 =item state (required)
1946 =item zip (required)
1952 Daytime phone number
1956 Evening phone number
1964 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1968 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1972 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1976 Expiration date for CARD/DCRD
1980 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1982 =item invoicing_list
1984 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),
1986 =item referral_custnum
1988 referring customer number
1996 pkgpart of initial package
2012 Access number (index, not the literal number)
2016 Country code (to be provisioned as a service)
2020 Phone number (to be provisioned as a service)
2028 Returns a hash reference with the following keys:
2034 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)
2038 =item regionselector HASHREF | LIST
2040 Takes as input a hashref or list of key/value pairs with the following keys:
2044 =item selected_county
2046 Currently selected county
2048 =item selected_state
2050 Currently selected state
2052 =item selected_country
2054 Currently selected country
2058 Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2062 Specify a javascript subroutine to call on changes
2068 =item default_country
2074 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>.
2078 Returns a list consisting of three HTML fragments for county selection,
2079 state selection and country selection, respectively.
2083 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
2084 sub regionselector {
2091 $param->{'selected_country'} ||= $param->{'default_country'};
2092 $param->{'selected_state'} ||= $param->{'default_state'};
2094 my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2098 my %cust_main_county;
2100 # unless ( @cust_main_county ) { #cache
2101 #@cust_main_county = qsearch('cust_main_county', {} );
2102 #foreach my $c ( @cust_main_county ) {
2103 foreach my $c ( @{ $param->{'locales'} } ) {
2104 #$countyflag=1 if $c->county;
2105 $countyflag=1 if $c->{county};
2106 #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
2107 #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
2108 $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
2111 $countyflag=1 if $param->{selected_county};
2113 my $script_html = <<END;
2115 function opt(what,value,text) {
2116 var optionName = new Option(text, value, false, false);
2117 var length = what.length;
2118 what.options[length] = optionName;
2120 function ${prefix}country_changed(what) {
2121 country = what.options[what.selectedIndex].text;
2122 for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
2123 what.form.${prefix}state.options[i] = null;
2125 #what.form.${prefix}state.options[0] = new Option('', '', false, true);
2127 foreach my $country ( sort keys %cust_main_county ) {
2128 $script_html .= "\nif ( country == \"$country\" ) {\n";
2129 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2130 my $text = $state || '(n/a)';
2131 $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
2133 $script_html .= "}\n";
2136 $script_html .= <<END;
2138 function ${prefix}state_changed(what) {
2141 if ( $countyflag ) {
2142 $script_html .= <<END;
2143 state = what.options[what.selectedIndex].text;
2144 country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
2145 for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
2146 what.form.${prefix}county.options[i] = null;
2149 foreach my $country ( sort keys %cust_main_county ) {
2150 $script_html .= "\nif ( country == \"$country\" ) {\n";
2151 foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2152 $script_html .= "\nif ( state == \"$state\" ) {\n";
2153 #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
2154 foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
2155 my $text = $county || '(n/a)';
2157 qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
2159 $script_html .= "}\n";
2161 $script_html .= "}\n";
2165 $script_html .= <<END;
2170 my $county_html = $script_html;
2171 if ( $countyflag ) {
2172 $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
2173 foreach my $county (
2174 sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2176 my $text = $county || '(n/a)';
2177 $county_html .= qq!<OPTION VALUE="$county"!.
2178 ($county eq $param->{'selected_county'} ?
2185 $county_html .= '</SELECT>';
2188 qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2191 my $state_html = qq!<SELECT NAME="${prefix}state" !.
2192 qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2193 foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2194 my $text = $state || '(n/a)';
2195 my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2196 $state_html .= "\n<OPTION $selected VALUE=$state>$text</OPTION>"
2198 $state_html .= '</SELECT>';
2200 my $country_html = '';
2201 if ( scalar( keys %cust_main_county ) > 1 ) {
2203 $country_html = qq(<SELECT NAME="${prefix}country" ).
2204 qq(onChange="${prefix}country_changed(this); ).
2205 $param->{'onchange'}.
2208 my $countrydefault = $param->{default_country} || 'US';
2209 foreach my $country (
2210 sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2211 keys %cust_main_county
2213 my $selected = $country eq $param->{'selected_country'}
2216 $country_html .= "\n<OPTION$selected>$country</OPTION>"
2218 $country_html .= '</SELECT>';
2221 $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2222 ' VALUE="'. (keys %cust_main_county )[0]. '">';
2226 ($county_html, $state_html, $country_html);
2230 sub regionselector_hashref {
2231 my ($county_html, $state_html, $country_html) = regionselector(@_);
2233 'county_html' => $county_html,
2234 'state_html' => $state_html,
2235 'country_html' => $country_html,
2239 =item location_form HASHREF | LIST
2241 Takes as input a hashref or list of key/value pairs with the following keys:
2247 Current customer session_id
2251 Omit red asterisks from required fields.
2253 =item address1_label
2255 Label for first address line.
2259 Returns an HTML fragment for a location form (address, city, state, zip,
2272 my $session_id = delete $param->{'session_id'};
2274 my $rv = mason_comp( 'session_id' => $session_id,
2275 'comp' => '/elements/location.html',
2276 'args' => [ %$param ],
2280 $rv->{'error'} || $rv->{'output'};
2285 #=item expselect HASHREF | LIST
2287 #Takes as input a hashref or list of key/value pairs with the following keys:
2291 #=item prefix - Specify a unique prefix string if you intend to use the HTML output multiple time son one page.
2293 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2297 =item expselect PREFIX [ DATE ]
2299 Takes as input a unique prefix string and the current expiration date, in
2300 yyyy-mm-dd or m-d-yyyy format
2302 Returns an HTML fragments for expiration date selection.
2308 #if ( ref($_[0]) ) {
2312 #my $prefix = $param->{'prefix'};
2313 #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2314 #my $date = exists($param->{'date'}) ? $param->{'date'} : '';
2316 my $date = scalar(@_) ? shift : '';
2318 my( $m, $y ) = ( 0, 0 );
2319 if ( $date =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2320 ( $m, $y ) = ( $2, $1 );
2321 } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2322 ( $m, $y ) = ( $1, $3 );
2324 my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2326 $return .= qq!<OPTION VALUE="$_"!;
2327 $return .= " SELECTED" if $_ == $m;
2330 $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2332 my $thisYear = $t[5] + 1900;
2333 for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2334 $return .= qq!<OPTION VALUE="$_"!;
2335 $return .= " SELECTED" if $_ == $y;
2338 $return .= "</SELECT>";
2343 =item popselector HASHREF | LIST
2345 Takes as input a hashref or list of key/value pairs with the following keys:
2351 Access number number
2355 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>.
2359 Returns an HTML fragment for access number selection.
2363 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2371 my $popnum = $param->{'popnum'};
2372 my $pops = $param->{'pops'};
2374 return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2375 return $pops->[0]{city}. ', '. $pops->[0]{state}.
2376 ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2377 '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2378 if scalar(@$pops) == 1;
2381 my %popnum2pop = ();
2383 push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2384 $popnum2pop{$_->{popnum}} = $_;
2389 function opt(what,href,text) {
2390 var optionName = new Option(text, href, false, false)
2391 var length = what.length;
2392 what.options[length] = optionName;
2396 my $init_popstate = $param->{'init_popstate'};
2397 if ( $init_popstate ) {
2398 $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2399 $init_popstate. '">';
2402 function acstate_changed(what) {
2403 state = what.options[what.selectedIndex].text;
2404 what.form.popac.options.length = 0
2405 what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2409 my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2410 foreach my $state ( sort { $a cmp $b } @states ) {
2411 $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2413 foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2414 $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2415 if ($ac eq $param->{'popac'}) {
2416 $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2419 $text .= "}\n" unless $init_popstate;
2421 $text .= "popac_changed(what.form.popac)}\n";
2424 function popac_changed(what) {
2425 ac = what.options[what.selectedIndex].text;
2426 what.form.popnum.options.length = 0;
2427 what.form.popnum.options[0] = new Option("City", "-1", false, true);
2431 foreach my $state ( @states ) {
2432 foreach my $popac ( keys %{ $pop{$state} } ) {
2433 $text .= "\nif ( ac == \"$popac\" ) {\n";
2435 foreach my $pop ( @{$pop{$state}->{$popac}}) {
2436 my $o_popnum = $pop->{popnum};
2437 my $poptext = $pop->{city}. ', '. $pop->{state}.
2438 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2440 $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2441 if ($popnum == $o_popnum) {
2442 $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2450 $text .= "}\n</SCRIPT>\n";
2452 $param->{'acstate'} = '' unless defined($param->{'acstate'});
2455 qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2456 qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2457 $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2458 ">$_" foreach sort { $a cmp $b } @states;
2459 $text .= '</SELECT>'; #callback? return 3 html pieces? #'</TD>';
2462 qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2463 qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2465 $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2468 #comment this block to disable initial list polulation
2469 my @initial_select = ();
2470 if ( scalar( @$pops ) > 100 ) {
2471 push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2473 @initial_select = @$pops;
2475 foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2476 $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2477 ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2478 $pop->{city}. ', '. $pop->{state}.
2479 ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2482 $text .= qq!</SELECT></TD></TR></TABLE>!;
2488 =item domainselector HASHREF | LIST
2490 Takes as input a hashref or list of key/value pairs with the following keys:
2500 Service number of the selected item.
2504 Returns an HTML fragment for domain selection.
2508 sub domainselector {
2515 my $domsvc= $param->{'domsvc'};
2517 domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2518 my $domains = $rv->{'domains'};
2519 $domsvc = $rv->{'domsvc'} unless $domsvc;
2521 return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2522 unless scalar(keys %$domains);
2524 if (scalar(keys %$domains) == 1) {
2526 foreach(keys %$domains) {
2529 return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2530 '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2533 my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2535 $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2537 foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2538 $text .= qq!<OPTION VALUE="!. $domain. '"'.
2539 ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2540 $domains->{$domain};
2543 $text .= qq!</SELECT></TD></TR>!;
2549 =item didselector HASHREF | LIST
2551 Takes as input a hashref or list of key/value pairs with the following keys:
2557 Field name for the returned HTML fragment.
2561 Service definition (see L<FS::part_svc>)
2565 Returns an HTML fragment for DID selection.
2577 my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2578 'args'=>[ %$param ],
2582 $rv->{'error'} || $rv->{'output'};
2588 =head1 RESELLER FUNCTIONS
2590 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2591 with their active session, and the B<customer_info> and B<order_pkg> functions
2592 with their active session and an additional I<custnum> parameter.
2594 For the most part, development of the reseller web interface has been
2595 superceded by agent-virtualized access to the backend.
2607 =item agent_list_customers
2609 List agent's customers.
2617 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>