fs_selfservice/FS-SelfService/SelfService.pm

   1 package FS::SelfService;
   2
   3 use strict;
   4 use vars qw( $VERSION @ISA @EXPORT_OK $DEBUG
   5              $skip_uid_check $dir $socket %autoload $tag );
   6 use Exporter;
   7 use Socket;
   8 use FileHandle;
   9 #use IO::Handle;
  10 use IO::Select;
  11 use Storable 2.09 qw(nstore_fd fd_retrieve);
  12
  13 $VERSION = '0.03';
  14
  15 @ISA = qw( Exporter );
  16
  17 $DEBUG = 0;
  18
  19 $dir = "/usr/local/freeside";
  20 $socket =  "$dir/selfservice_socket";
  21 $socket .= '.'.$tag if defined $tag && length($tag);
  22
  23 #maybe should ask ClientAPI for this list
  24 %autoload = (
  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   'switch_cust'               => 'MyAccount/switch_cust',
  34   'customer_info'             => 'MyAccount/customer_info',
  35   'customer_info_short'       => 'MyAccount/customer_info_short',
  36
  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',
  42
  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   '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',
 124
 125   'start_thirdparty'          => 'MyAccount/start_thirdparty',
 126   'finish_thirdparty'         => 'MyAccount/finish_thirdparty',
 127
 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',
 136
 137 );
 138 @EXPORT_OK = (
 139   keys(%autoload),
 140   qw( regionselector regionselector_hashref location_form
 141       expselect popselector domainselector didselector
 142     )
 143 );
 144
 145 $ENV{'PATH'} ='/usr/bin:/usr/ucb:/bin';
 146 $ENV{'SHELL'} = '/bin/sh';
 147 $ENV{'IFS'} = " \t\n";
 148 $ENV{'CDPATH'} = '';
 149 $ENV{'ENV'} = '';
 150 $ENV{'BASH_ENV'} = '';
 151
 152 #you can add BEGIN { $FS::SelfService::skip_uid_check = 1; }
 153 #if you grant appropriate permissions to whatever user
 154 my $freeside_uid = scalar(getpwnam('freeside'));
 155 die "not running as the freeside user\n"
 156   if $> != $freeside_uid && ! $skip_uid_check;
 157
 158 -e $dir or die "FATAL: $dir doesn't exist!";
 159 -d $dir or die "FATAL: $dir isn't a directory!";
 160 -r $dir or die "FATAL: Can't read $dir as freeside user!";
 161 -x $dir or die "FATAL: $dir not searchable (executable) as freeside user!";
 162
 163 foreach my $autoload ( keys %autoload ) {
 164
 165   my $eval =
 166   "sub $autoload { ". '
 167                    my $param;
 168                    if ( ref($_[0]) ) {
 169                      $param = shift;
 170                    } else {
 171                      #warn scalar(@_). ": ". join(" / ", @_);
 172                      $param = { @_ };
 173                    }
 174
 175                    $param->{_packet} = \''. $autoload{$autoload}. '\';
 176
 177                    simple_packet($param);
 178                  }';
 179
 180   eval $eval;
 181   die $@ if $@;
 182
 183 }
 184
 185 sub simple_packet {
 186   my $packet = shift;
 187   warn "sending ". $packet->{_packet}. " to server"
 188     if $DEBUG;
 189   socket(SOCK, PF_UNIX, SOCK_STREAM, 0) or die "socket: $!";
 190   connect(SOCK, sockaddr_un($socket)) or die "connect to $socket: $!";
 191   nstore_fd($packet, \*SOCK) or die "can't send packet: $!";
 192   SOCK->flush;
 193
 194   #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
 195
 196   #block until there is a message on socket
 197 #  my $w = new IO::Select;
 198 #  $w->add(\*SOCK);
 199 #  my @wait = $w->can_read;
 200
 201   warn "reading message from server"
 202     if $DEBUG;
 203
 204   my $return = fd_retrieve(\*SOCK) or die "error reading result: $!";
 205   die $return->{'_error'} if defined $return->{_error} && $return->{_error};
 206
 207   warn "returning message to client"
 208     if $DEBUG;
 209
 210   $return;
 211 }
 212
 213 =head1 NAME
 214
 215 FS::SelfService - Freeside self-service API
 216
 217 =head1 SYNOPSIS
 218
 219   # password and shell account changes
 220   use FS::SelfService qw(passwd chfn chsh);
 221
 222   # "my account" functionality
 223   use FS::SelfService qw( login customer_info invoice cancel payment_info process_payment );
 224
 225   #new-style login with an email address and password
 226   # can also be used for svc_acct login, set $emailaddress to username@domain
 227   my $rv = login ( { 'email'    => $emailaddress,
 228                      'password' => $password,
 229                    },
 230                  );
 231   if ( $rv->{'error'} ) {
 232     #handle login error...
 233   } else {
 234     #successful login
 235     $session_id = $rv->{'session_id'};
 236   }
 237
 238   #classic svc_acct-based login with separate username and password
 239   my $rv = login( { 'username' => $username,
 240                     'domain'   => $domain,
 241                     'password' => $password,
 242                   }
 243                 );
 244   if ( $rv->{'error'} ) {
 245     #handle login error...
 246   } else {
 247     #successful login
 248     $session_id = $rv->{'session_id'};
 249   }
 250
 251   #svc_phone login with phone number and PIN
 252   my $rv = login( { 'username' => $phone_number,
 253                     'domain'   => 'svc_phone',
 254                     'password' => $pin,
 255                   }
 256                 );
 257   if ( $rv->{'error'} ) {
 258     #handle login error...
 259   } else {
 260     #successful login
 261     $session_id = $rv->{'session_id'};
 262   }
 263
 264   my $customer_info = customer_info( { 'session_id' => $session_id } );
 265
 266   #payment_info and process_payment are available in 1.5+ only
 267   my $payment_info = payment_info( { 'session_id' => $session_id } );
 268
 269   #!!! process_payment example
 270
 271   #!!! list_pkgs example
 272
 273   #ordering a package with an svc_acct service
 274   my $rv = order_pkg( { 'session_id' => $session_id,
 275                         'pkgpart'    => $pkgpart,
 276                         'svcpart'    => $svcpart,
 277                         'username'   => $username,
 278                         'domsvc'     => $domsvc, #svcnum of svc_domain
 279                         '_password'  => $password,
 280                       }
 281                     );
 282
 283   #!!! ordering a package with an svc_domain service example
 284
 285   #!!! ordering a package with an svc_phone service example
 286
 287   #!!! ordering a package with an svc_external service example
 288
 289   #!!! ordering a package with an svc_pbx service
 290
 291   #ordering a package with no service
 292   my $rv = order_pkg( { 'session_id' => $session_id,
 293                         'pkgpart'    => $pkgpart,
 294                         'svcpart'    => 'none',
 295                       }
 296                     );
 297
 298   #quoting a package, then ordering after confirmation
 299
 300   my $rv = quotation_new({ 'session_id' => $session_id });
 301   my $qnum = $rv->{quotationnum};
 302   #  add packages to the quotation
 303   $rv = quotation_add_pkg({ 'session_id'   => $session_id,
 304                             'quotationnum' => $qnum,
 305                             'pkgpart'      => $pkgpart,
 306                             'quantity'     => $quantity, # defaults to 1
 307                           });
 308   #  repeat until all packages are added
 309   #  view the pricing information
 310   $rv = quotation_info({ 'session_id'   => $session_id,
 311                          'quotationnum' => $qnum,
 312                       });
 313   print "Total setup charges: ".$rv->{total_setup}."\n".
 314         "Total recurring charges: ".$rv->{total_recur}."\n";
 315   #  quotation_info also provides a detailed breakdown of charges, in
 316   #  $rv->{sections}.
 317
 318   #  ask customer for confirmation, then:
 319   $rv = quotation_order({ 'session_id'   => $session_id,
 320                           'quotationnum' => $qnum,
 321                         });
 322
 323   #!!! cancel_pkg example
 324
 325   # signup functionality
 326   use FS::SelfService qw( signup_info new_customer new_customer_minimal );
 327
 328   my $signup_info = signup_info;
 329
 330   $rv = new_customer( {
 331                         'first'            => $first,
 332                         'last'             => $last,
 333                         'company'          => $company,
 334                         'address1'         => $address1,
 335                         'address2'         => $address2,
 336                         'city'             => $city,
 337                         'state'            => $state,
 338                         'zip'              => $zip,
 339                         'country'          => $country,
 340                         'daytime'          => $daytime,
 341                         'night'            => $night,
 342                         'fax'              => $fax,
 343                         'payby'            => $payby,
 344                         'payinfo'          => $payinfo,
 345                         'paycvv'           => $paycvv,
 346                         'paystart_month'   => $paystart_month
 347                         'paystart_year'    => $paystart_year,
 348                         'payissue'         => $payissue,
 349                         'payip'            => $payip
 350                         'paydate'          => $paydate,
 351                         'payname'          => $payname,
 352                         'invoicing_list'   => $invoicing_list,
 353                         'referral_custnum' => $referral_custnum,
 354                         'agentnum'         => $agentnum,
 355                         'pkgpart'          => $pkgpart,
 356
 357                         'username'         => $username,
 358                         '_password'        => $password,
 359                         'popnum'           => $popnum,
 360                         #OR
 361                         'countrycode'      => 1,
 362                         'phonenum'         => $phonenum,
 363                         'pin'              => $pin,
 364                       }
 365                     );
 366
 367   my $error = $rv->{'error'};
 368   if ( $error eq '_decline' ) {
 369     print_decline();
 370   } elsif ( $error ) {
 371     reprint_signup();
 372   } else {
 373     print_success();
 374   }
 375
 376 =head1 DESCRIPTION
 377
 378 Use this API to implement your own client "self-service" module.
 379
 380 If you just want to customize the look of the existing "self-service" module,
 381 see XXXX instead.
 382
 383 =head1 PASSWORD, GECOS, SHELL CHANGING FUNCTIONS
 384
 385 =over 4
 386
 387 =item passwd
 388
 389 Changes the password for an existing user in svc_acct.  Takes a hash
 390 reference with the following keys:
 391
 392 =over 4
 393
 394 =item username
 395
 396 Username of the account (required)
 397
 398 =item domain
 399
 400 Domain of the account (required)
 401
 402 =item old_password
 403
 404 Old password (required)
 405
 406 =item new_password
 407
 408 New password (required)
 409
 410 =item new_gecos
 411
 412 New gecos
 413
 414 =item new_shell
 415
 416 New Shell
 417
 418 =back
 419
 420 =item chfn
 421
 422 =item chsh
 423
 424 =back
 425
 426 =head1 "MY ACCOUNT" FUNCTIONS
 427
 428 =over 4
 429
 430 =item login HASHREF
 431
 432 Creates a user session.  Takes a hash reference as parameter with the
 433 following keys:
 434
 435 =over 4
 436
 437 =item email
 438
 439 Email address (username@domain), instead of username and domain.  Required for
 440 contact-based self-service login, can also be used for svc_acct-based login.
 441
 442 =item username
 443
 444 Username
 445
 446 =item domain
 447
 448 Domain
 449
 450 =item password
 451
 452 Password
 453
 454 =back
 455
 456 Returns a hash reference with the following keys:
 457
 458 =over 4
 459
 460 =item error
 461
 462 Empty on success, or an error message on errors.
 463
 464 =item session_id
 465
 466 Session identifier for successful logins
 467
 468 =back
 469
 470 =item customer_info HASHREF
 471
 472 Returns general customer information.
 473
 474 Takes a hash reference as parameter with a single key: B<session_id>
 475
 476 Returns a hash reference with the following keys:
 477
 478 =over 4
 479
 480 =item name
 481
 482 Customer name
 483
 484 =item balance
 485
 486 Balance owed
 487
 488 =item open
 489
 490 Array reference of hash references of open inoices.  Each hash reference has
 491 the following keys: invnum, date, owed
 492
 493 =item small_custview
 494
 495 An HTML fragment containing shipping and billing addresses.
 496
 497 =item The following fields are also returned
 498
 499 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
 500
 501 =back
 502
 503 =item edit_info HASHREF
 504
 505 Takes a hash reference as parameter with any of the following keys:
 506
 507 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
 508
 509 If a field exists, the customer record is updated with the new value of that
 510 field.  If a field does not exist, that field is not changed on the customer
 511 record.
 512
 513 Returns a hash reference with a single key, B<error>, empty on success, or an
 514 error message on errors
 515
 516 =item invoice HASHREF
 517
 518 Returns an invoice.  Takes a hash reference as parameter with two keys:
 519 session_id and invnum
 520
 521 Returns a hash reference with the following keys:
 522
 523 =over 4
 524
 525 =item error
 526
 527 Empty on success, or an error message on errors
 528
 529 =item invnum
 530
 531 Invoice number
 532
 533 =item invoice_text
 534
 535 Invoice text
 536
 537 =back
 538
 539 =item list_invoices HASHREF
 540
 541 Returns a list of all customer invoices.  Takes a hash reference with a single
 542 key, session_id.
 543
 544 Returns a hash reference with the following keys:
 545
 546 =over 4
 547
 548 =item error
 549
 550 Empty on success, or an error message on errors
 551
 552 =item invoices
 553
 554 Reference to array of hash references with the following keys:
 555
 556 =over 4
 557
 558 =item invnum
 559
 560 Invoice ID
 561
 562 =item _date
 563
 564 Invoice date, in UNIX epoch time
 565
 566 =back
 567
 568 =back
 569
 570 =item cancel HASHREF
 571
 572 Cancels this customer.
 573
 574 Takes a hash reference as parameter with a single key: B<session_id>
 575
 576 Returns a hash reference with a single key, B<error>, which is empty on
 577 success or an error message on errors.
 578
 579 =item payment_info HASHREF
 580
 581 Returns information that may be useful in displaying a payment page.
 582
 583 Takes a hash reference as parameter with a single key: B<session_id>.
 584
 585 Returns a hash reference with the following keys:
 586
 587 =over 4
 588
 589 =item error
 590
 591 Empty on success, or an error message on errors
 592
 593 =item balance
 594
 595 Balance owed
 596
 597 =item payname
 598
 599 Exact name on credit card (CARD/DCRD)
 600
 601 =item address1
 602
 603 Address line one
 604
 605 =item address2
 606
 607 Address line two
 608
 609 =item city
 610
 611 City
 612
 613 =item state
 614
 615 State
 616
 617 =item zip
 618
 619 Zip or postal code
 620
 621 =item payby
 622
 623 Customer's current default payment type.
 624
 625 =item card_type
 626
 627 For CARD/DCRD payment types, the card type (Visa card, MasterCard, Discover card, American Express card, etc.)
 628
 629 =item payinfo
 630
 631 For CARD/DCRD payment types, the card number
 632
 633 =item month
 634
 635 For CARD/DCRD payment types, expiration month
 636
 637 =item year
 638
 639 For CARD/DCRD payment types, expiration year
 640
 641 =item cust_main_county
 642
 643 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.
 644
 645 =item states
 646
 647 Array reference of all states in the current default country.
 648
 649 =item card_types
 650
 651 Hash reference of card types; keys are card types, values are the exact strings
 652 passed to the process_payment function
 653
 654 =cut
 655
 656 #this doesn't actually work yet
 657 #
 658 #=item paybatch
 659 #
 660 #Unique transaction identifier (prevents multiple charges), passed to the
 661 #process_payment function
 662
 663 =back
 664
 665 =item process_payment HASHREF
 666
 667 Processes a payment and possible change of address or payment type.  Takes a
 668 hash reference as parameter with the following keys:
 669
 670 =over 4
 671
 672 =item session_id
 673
 674 Session identifier
 675
 676 =item amount
 677
 678 Amount
 679
 680 =item save
 681
 682 If true, address and card information entered will be saved for subsequent
 683 transactions.
 684
 685 =item auto
 686
 687 If true, future credit card payments will be done automatically (sets payby to
 688 CARD).  If false, future credit card payments will be done on-demand (sets
 689 payby to DCRD).  This option only has meaning if B<save> is set true.
 690
 691 =item payname
 692
 693 Name on card
 694
 695 =item address1
 696
 697 Address line one
 698
 699 =item address2
 700
 701 Address line two
 702
 703 =item city
 704
 705 City
 706
 707 =item state
 708
 709 State
 710
 711 =item zip
 712
 713 Zip or postal code
 714
 715 =item country
 716
 717 Two-letter country code
 718
 719 =item payinfo
 720
 721 Card number
 722
 723 =item month
 724
 725 Card expiration month
 726
 727 =item year
 728
 729 Card expiration year
 730
 731 =cut
 732
 733 #this doesn't actually work yet
 734 #
 735 #=item paybatch
 736 #
 737 #Unique transaction identifier, returned from the payment_info function.
 738 #Prevents multiple charges.
 739
 740 =back
 741
 742 Returns a hash reference with a single key, B<error>, empty on success, or an
 743 error message on errors.
 744
 745 =item process_payment_order_pkg
 746
 747 Combines the B<process_payment> and B<order_pkg> functions in one step.  If the
 748 payment processes sucessfully, the package is ordered.  Takes a hash reference
 749 as parameter with the keys of both methods.
 750
 751 Returns a hash reference with a single key, B<error>, empty on success, or an
 752 error message on errors.
 753
 754 =item process_payment_change_pkg
 755
 756 Combines the B<process_payment> and B<change_pkg> functions in one step.  If the
 757 payment processes sucessfully, the package is ordered.  Takes a hash reference
 758 as parameter with the keys of both methods.
 759
 760 Returns a hash reference with a single key, B<error>, empty on success, or an
 761 error message on errors.
 762
 763
 764 =item process_payment_order_renew
 765
 766 Combines the B<process_payment> and B<order_renew> functions in one step.  If
 767 the payment processes sucessfully, the renewal is processed.  Takes a hash
 768 reference as parameter with the keys of both methods.
 769
 770 Returns a hash reference with a single key, B<error>, empty on success, or an
 771 error message on errors.
 772
 773 =item list_pkgs
 774
 775 Returns package information for this customer.  For more detail on services,
 776 see L</list_svcs>.
 777
 778 Takes a hash reference as parameter with a single key: B<session_id>
 779
 780 Returns a hash reference containing customer package information.  The hash reference contains the following keys:
 781
 782 =over 4
 783
 784 =item custnum
 785
 786 Customer number
 787
 788 =item error
 789
 790 Empty on success, or an error message on errors.
 791
 792 =item cust_pkg HASHREF
 793
 794 Array reference of hash references, each of which has the fields of a cust_pkg
 795 record (see L<FS::cust_pkg>) as well as the fields below.  Note these are not
 796 the internal FS:: objects, but hash references of columns and values.
 797
 798 =over 4
 799
 800 =item part_pkg fields
 801
 802 All fields of part_pkg for this specific cust_pkg (be careful with this
 803 information - it may reveal more about your available packages than you would
 804 like users to know in aggregate)
 805
 806 =cut
 807
 808 #XXX pare part_pkg fields down to a more secure subset
 809
 810 =item part_svc
 811
 812 An array of hash references indicating information on unprovisioned services
 813 available for provisioning for this specific cust_pkg.  Each has the following
 814 keys:
 815
 816 =over 4
 817
 818 =item part_svc fields
 819
 820 All fields of part_svc (be careful with this information - it may reveal more
 821 about your available packages than you would like users to know in aggregate)
 822
 823 =cut
 824
 825 #XXX pare part_svc fields down to a more secure subset
 826
 827 =back
 828
 829 =item cust_svc
 830
 831 An array of hash references indicating information on the customer services
 832 already provisioned for this specific cust_pkg.  Each has the following keys:
 833
 834 =over 4
 835
 836 =item label
 837
 838 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.
 839
 840 =back
 841
 842 =item svcnum
 843
 844 Primary key for this service
 845
 846 =item svcpart
 847
 848 Service definition (see L<FS::part_svc>)
 849
 850 =item pkgnum
 851
 852 Customer package (see L<FS::cust_pkg>)
 853
 854 =item overlimit
 855
 856 Blank if the service is not over limit, or the date the service exceeded its usage limit (as a UNIX timestamp).
 857
 858 =back
 859
 860 =back
 861
 862 =item list_svcs
 863
 864 Returns service information for this customer.
 865
 866 Takes a hash reference as parameter with a single key: B<session_id>
 867
 868 Returns a hash reference containing customer package information.  The hash reference contains the following keys:
 869
 870 =over 4
 871
 872 =item custnum
 873
 874 Customer number
 875
 876 =item svcs
 877
 878 An array of hash references indicating information on all of this customer's
 879 services.  Each has the following keys:
 880
 881 =over 4
 882
 883 =item svcnum
 884
 885 Primary key for this service
 886
 887 =item label
 888
 889 Name of this service
 890
 891 =item value
 892
 893 Meaningful user-specific identifier for the service (i.e. username, domain, or
 894 mail alias).
 895
 896 =back
 897
 898 Account (svc_acct) services also have the following keys:
 899
 900 =over 4
 901
 902 =item username
 903
 904 Username
 905
 906 =item email
 907
 908 username@domain
 909
 910 =item seconds
 911
 912 Seconds remaining
 913
 914 =item upbytes
 915
 916 Upload bytes remaining
 917
 918 =item downbytes
 919
 920 Download bytes remaining
 921
 922 =item totalbytes
 923
 924 Total bytes remaining
 925
 926 =item recharge_amount
 927
 928 Cost of a recharge
 929
 930 =item recharge_seconds
 931
 932 Number of seconds gained by recharge
 933
 934 =item recharge_upbytes
 935
 936 Number of upload bytes gained by recharge
 937
 938 =item recharge_downbytes
 939
 940 Number of download bytes gained by recharge
 941
 942 =item recharge_totalbytes
 943
 944 Number of total bytes gained by recharge
 945
 946 =back
 947
 948 =back
 949
 950 =item order_pkg
 951
 952 Orders a package for this customer.
 953
 954 Takes a hash reference as parameter with the following keys:
 955
 956 =over 4
 957
 958 =item session_id
 959
 960 Session identifier
 961
 962 =item pkgpart
 963
 964 Package to order (see L<FS::part_pkg>).
 965
 966 =item quantity
 967
 968 Quantity for this package order (default 1).
 969
 970 =item locationnum
 971
 972 Optional locationnum for this package order, for existing locations.
 973
 974 Or, for new locations, pass the following fields: address1*, address2, city*,
 975 county, state*, zip*, country.  (* = required in this case)
 976
 977 =item address1
 978
 979 =item address 2
 980
 981 =item city
 982
 983 =item
 984
 985 =item svcpart
 986
 987 Service to order (see L<FS::part_svc>).
 988
 989 Normally optional; required only to provision a non-svc_acct service, or if the
 990 package definition does not contain one svc_acct service definition with
 991 quantity 1 (it may contain others with quantity >1).  A svcpart of "none" can
 992 also be specified to indicate that no initial service should be provisioned.
 993
 994 =back
 995
 996 Fields used when provisioning an svc_acct service:
 997
 998 =over 4
 999
1000 =item username
1001
1002 Username
1003
1004 =item _password
1005
1006 Password
1007
1008 =item sec_phrase
1009
1010 Optional security phrase
1011
1012 =item popnum
1013
1014 Optional Access number number
1015
1016 =back
1017
1018 Fields used when provisioning an svc_domain service:
1019
1020 =over 4
1021
1022 =item domain
1023
1024 Domain
1025
1026 =back
1027
1028 Fields used when provisioning an svc_phone service:
1029
1030 =over 4
1031
1032 =item phonenum
1033
1034 Phone number
1035
1036 =item pin
1037
1038 Voicemail PIN
1039
1040 =item sip_password
1041
1042 SIP password
1043
1044 =back
1045
1046 Fields used when provisioning an svc_external service:
1047
1048 =over 4
1049
1050 =item id
1051
1052 External numeric ID.
1053
1054 =item title
1055
1056 External text title.
1057
1058 =back
1059
1060 Fields used when provisioning an svc_pbx service:
1061
1062 =over 4
1063
1064 =item id
1065
1066 Numeric ID.
1067
1068 =item name
1069
1070 Text name.
1071
1072 =back
1073
1074 Returns a hash reference with a single key, B<error>, empty on success, or an
1075 error message on errors.  The special error '_decline' is returned for
1076 declined transactions.
1077
1078 =item change_pkg
1079
1080 Changes a package for this customer.
1081
1082 Takes a hash reference as parameter with the following keys:
1083
1084 =over 4
1085
1086 =item session_id
1087
1088 Session identifier
1089
1090 =item pkgnum
1091
1092 Existing customer package.
1093
1094 =item pkgpart
1095
1096 New package to order (see L<FS::part_pkg>).
1097
1098 =item quantity
1099
1100 Quantity for this package order (default 1).
1101
1102 =back
1103
1104 Returns a hash reference with the following keys:
1105
1106 =over 4
1107
1108 =item error
1109
1110 Empty on success, or an error message on errors.
1111
1112 =item pkgnum
1113
1114 On success, the new pkgnum
1115
1116 =back
1117
1118
1119 =item renew_info
1120
1121 Provides useful info for early renewals.
1122
1123 Takes a hash reference as parameter with the following keys:
1124
1125 =over 4
1126
1127 =item session_id
1128
1129 Session identifier
1130
1131 =back
1132
1133 Returns a hash reference.  On errors, it contains a single key, B<error>, with
1134 the error message.  Otherwise, contains a single key, B<dates>, pointing to
1135 an array refernce of hash references.  Each hash reference contains the
1136 following keys:
1137
1138 =over 4
1139
1140 =item bill_date
1141
1142 (Future) Bill date.  Indicates a future date for which billing could be run.
1143 Specified as a integer UNIX timestamp.  Pass this value to the B<order_renew>
1144 function.
1145
1146 =item bill_date_pretty
1147
1148 (Future) Bill date as a human-readable string.  (Convenience for display;
1149 subject to change, so best not to parse for the date.)
1150
1151 =item amount
1152
1153 Base amount which will be charged if renewed early as of this date.
1154
1155 =item renew_date
1156
1157 Renewal date; i.e. even-futher future date at which the customer will be paid
1158 through if the early renewal is completed with the given B<bill-date>.
1159 Specified as a integer UNIX timestamp.
1160
1161 =item renew_date_pretty
1162
1163 Renewal date as a human-readable string.  (Convenience for display;
1164 subject to change, so best not to parse for the date.)
1165
1166 =item pkgnum
1167
1168 Package that will be renewed.
1169
1170 =item expire_date
1171
1172 Expiration date of the package that will be renewed.
1173
1174 =item expire_date_pretty
1175
1176 Expiration date of the package that will be renewed, as a human-readable
1177 string.  (Convenience for display; subject to change, so best not to parse for
1178 the date.)
1179
1180 =back
1181
1182 =item order_renew
1183
1184 Renews this customer early; i.e. runs billing for this customer in advance.
1185
1186 Takes a hash reference as parameter with the following keys:
1187
1188 =over 4
1189
1190 =item session_id
1191
1192 Session identifier
1193
1194 =item date
1195
1196 Integer date as returned by the B<renew_info> function, indicating the advance
1197 date for which to run billing.
1198
1199 =back
1200
1201 Returns a hash reference with a single key, B<error>, empty on success, or an
1202 error message on errors.
1203
1204 =item cancel_pkg
1205
1206 Cancels a package for this customer.
1207
1208 Takes a hash reference as parameter with the following keys:
1209
1210 =over 4
1211
1212 =item session_id
1213
1214 Session identifier
1215
1216 =item pkgpart
1217
1218 pkgpart of package to cancel
1219
1220 =back
1221
1222 Returns a hash reference with a single key, B<error>, empty on success, or an
1223 error message on errors.
1224
1225 =item provision_acct
1226
1227 Provisions an account (svc_acct).
1228
1229 Takes a hash reference as parameter with the following keys:
1230
1231 =over 4
1232
1233 =item session_id
1234
1235 Session identifier
1236
1237 =item pkgnum
1238
1239 pkgnum of package into which this service is provisioned
1240
1241 =item svcpart
1242
1243 svcpart or service definition to provision
1244
1245 =item username
1246
1247 =item domsvc
1248
1249 =item _password
1250
1251 =back
1252
1253 =item provision_phone
1254
1255 Provisions a phone number (svc_phone).
1256
1257 Takes a hash reference as parameter with the following keys:
1258
1259 =over 4
1260
1261 =item session_id
1262
1263 Session identifier
1264
1265 =item pkgnum
1266
1267 pkgnum of package into which this service is provisioned
1268
1269 =item svcpart
1270
1271 svcpart or service definition to provision
1272
1273 =item countrycode
1274
1275 =item phonenum
1276
1277 =item address1
1278
1279 =item address2
1280
1281 =item city
1282
1283 =item county
1284
1285 =item state
1286
1287 =item zip
1288
1289 =item country
1290
1291 E911 Address (optional)
1292
1293 =back
1294
1295 =item provision_pbx
1296
1297 Provisions a customer PBX (svc_pbx).
1298
1299 Takes a hash reference as parameter with the following keys:
1300
1301 =over 4
1302
1303 =item session_id
1304
1305 Session identifier
1306
1307 =item pkgnum
1308
1309 pkgnum of package into which this service is provisioned
1310
1311 =item svcpart
1312
1313 svcpart or service definition to provision
1314
1315 =item id
1316
1317 =item title
1318
1319 =item max_extensions
1320
1321 =item max_simultaneous
1322
1323 =item ip_addr
1324
1325 =back
1326
1327 =item provision_external
1328
1329 Provisions an external service (svc_external).
1330
1331 Takes a hash reference as parameter with the following keys:
1332
1333 =over 4
1334
1335 =item session_id
1336
1337 Session identifier
1338
1339 =item pkgnum
1340
1341 pkgnum of package into which this service is provisioned
1342
1343 =item svcpart
1344
1345 svcpart or service definition to provision
1346
1347 =item id
1348
1349 =item title
1350
1351 =back
1352
1353 =back
1354
1355 =head2 "MY ACCOUNT" CONTACT FUNCTIONS
1356
1357 =over 4
1358
1359 =item contact_passwd
1360
1361 Changes the password for the currently-logged in contact.
1362
1363 Takes a hash reference as parameter with the following keys:
1364
1365 =over 4
1366
1367 =item session_id
1368
1369 =item new_password
1370
1371 =back
1372
1373 Returns a hash reference with a single parameter, B<error>, which contains an
1374 error message, or empty on success.
1375
1376 =item list_contacts
1377
1378 =item edit_contact
1379
1380 Updates information for the currently-logged in contact, or (optionally) the
1381 specified contact.
1382
1383 Takes a hash reference as parameter with the following keys:
1384
1385 =over 4
1386
1387 =item session_id
1388
1389 =item contactnum
1390
1391 If already logged in as a contact, this is optional.
1392
1393 =item first
1394
1395 =item last
1396
1397 =item emailaddress
1398
1399 =back
1400
1401 Returns a hash reference with a single parameter, B<error>, which contains an
1402 error message, or empty on success.
1403
1404 =item new_contact
1405
1406 Creates a new contact.
1407
1408 Takes a hash reference as parameter with the following keys:
1409
1410 =over 4
1411
1412 =item session_id
1413
1414 =item first
1415
1416 =item last
1417
1418 =item emailaddress
1419
1420 =item classnum
1421
1422 Optional contact classnum (TODO: or name)
1423
1424 =item comment
1425
1426 =item selfservice_access
1427
1428 Y to enable self-service access
1429
1430 =item _password
1431
1432 =back
1433
1434 Returns a hash reference with a single parameter, B<error>, which contains an
1435 error message, or empty on success.
1436
1437 =item delete_contact
1438
1439 Deletes a contact.  (Note: Cannot at this time delete the currently-logged in
1440 contact.)
1441
1442 Takes a hash reference as parameter with the following keys:
1443
1444 =over 4
1445
1446 =item session_id
1447
1448 =item contactnum
1449
1450 =back
1451
1452 Returns a hash reference with a single parameter, B<error>, which contains an
1453 error message, or empty on success.
1454
1455 =head2 "MY ACCOUNT" QUOTATION FUNCTIONS
1456
1457 All of these functions require the user to be logged in, and the 'session_id'
1458 key to be included in the argument hashref.`
1459
1460 =over 4
1461
1462 =item list_quotations HASHREF
1463
1464 Returns a hashref listing this customer's active self-service quotations.
1465 Contents are:
1466
1467 =over 4
1468
1469 =item quotations
1470
1471 an arrayref containing an element for each quotation.
1472
1473 =item quotationnum
1474
1475 the primary key
1476
1477 =item _date
1478
1479 the date it was started
1480
1481 =item num_pkgs
1482
1483 the number of packages
1484
1485 =item total_setup
1486
1487 the sum of setup fees
1488
1489 =item total_recur
1490
1491 the sum of recurring charges
1492
1493 =back
1494
1495 =item quotation_new HASHREF
1496
1497 Creates an empty quotation and returns a hashref containing 'quotationnum',
1498 the primary key of the new quotation.
1499
1500 =item quotation_delete HASHREF
1501
1502 Disables (does not really delete) a quotation. Takes the following arguments:
1503
1504 =over 4
1505
1506 =item session_id
1507
1508 =item quotationnum - the quotation to delete
1509
1510 =back
1511
1512 Returns 'error' => a string, which will be empty on success.
1513
1514 =item quotation_info HASHREF
1515
1516 Returns total and detailed pricing information on a quotation.
1517
1518 Takes the following arguments:
1519
1520 =over 4
1521
1522 =item session_id
1523
1524 =item quotationnum - the quotation to return
1525
1526 =back
1527
1528 Returns a hashref containing:
1529
1530 - total_setup, the total of setup fees (and their taxes)
1531 - total_recur, the total of all recurring charges (and their taxes)
1532 - sections, an arrayref containing an element for each quotation section.
1533   - description, a line of text describing the group of charges
1534   - subtotal, the total of charges in this group (if appropriate)
1535   - detail_items, an arrayref of line items
1536     - pkgnum, the reference number of the package
1537     - description, the package name (or tax name)
1538     - quantity
1539     - amount, the amount charged
1540     If the detail item represents a subtotal, it will instead contain:
1541     - total_item: description of the subtotal
1542     - total_amount: the subtotal amount
1543
1544
1545 =item quotation_print HASHREF
1546
1547 Renders the quotation as HTML or PDF. Takes the following arguments:
1548
1549 =over 4
1550
1551 =item session_id
1552
1553 =item quotationnum - the quotation to return
1554
1555 =item format - 'html' or 'pdf'
1556
1557 =back
1558
1559 Returns a hashref containing 'document', the contents of the file.
1560
1561 =item quotation_add_pkg HASHREF
1562
1563 Adds a package to a quotation. Takes the following arguments:
1564
1565 =over 4
1566
1567 =item session_id
1568
1569 =item pkgpart - the package to add
1570
1571 =item quotationnum - the quotation to add it to
1572
1573 =item quantity - the package quantity (defaults to 1)
1574
1575 =item address1, address2, city, state, zip, country - address fields to set
1576 the service location
1577
1578 =back
1579
1580 Returns 'error' => a string, which will be empty on success.
1581
1582 =item quotation_remove_pkg HASHREF
1583
1584 Removes a package from a quotation. Takes the following arguments:
1585
1586 =over 4
1587
1588 =item session_id
1589
1590 =item pkgnum - the primary key (quotationpkgnum) of the package to remove
1591
1592 =item quotationnum - the quotation to remove it from
1593
1594 =back
1595
1596 Returns 'error' => a string, which will be empty on success.
1597
1598 =back
1599
1600 =item quotation_order HASHREF
1601
1602 Converts the packages in a quotation into real packages. Takes the following
1603 arguments:
1604
1605 Takes the following arguments:
1606
1607 =over 4
1608
1609 =item session_id
1610
1611 =item quotationnum - the quotation to order
1612
1613 =back
1614
1615 =back
1616
1617 =head1 SIGNUP FUNCTIONS
1618
1619 =over 4
1620
1621 =item signup_info HASHREF
1622
1623 Takes a hash reference as parameter with the following keys:
1624
1625 =over 4
1626
1627 =item session_id - Optional agent/reseller interface session
1628
1629 =back
1630
1631 Returns a hash reference containing information that may be useful in
1632 displaying a signup page.  The hash reference contains the following keys:
1633
1634 =over 4
1635
1636 =item cust_main_county
1637
1638 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.
1639
1640 =item part_pkg
1641
1642 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
1643 an agentnum specified explicitly via reseller interface session_id in the
1644 options.
1645
1646 =item agent
1647
1648 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.
1649
1650 =item agentnum2part_pkg
1651
1652 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.
1653
1654 =item svc_acct_pop
1655
1656 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.
1657
1658 =item security_phrase
1659
1660 True if the "security_phrase" feature is enabled
1661
1662 =item payby
1663
1664 Array reference of acceptable payment types for signup
1665
1666 =over 4
1667
1668 =item CARD
1669
1670 credit card - automatic
1671
1672 =item DCRD
1673
1674 credit card - on-demand - version 1.5+ only
1675
1676 =item CHEK
1677
1678 electronic check - automatic
1679
1680 =item DCHK
1681
1682 electronic check - on-demand - version 1.5+ only
1683
1684 =item LECB
1685
1686 Phone bill billing
1687
1688 =item BILL
1689
1690 billing, not recommended for signups
1691
1692 =item COMP
1693
1694 free, definitely not recommended for signups
1695
1696 =item PREPAY
1697
1698 special billing type: applies a credit (see FS::prepay_credit) and sets billing type to BILL
1699
1700 =back
1701
1702 =item cvv_enabled
1703
1704 True if CVV features are available (1.5+ or 1.4.2 with CVV schema patch)
1705
1706 =item msgcat
1707
1708 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".
1709
1710 =item statedefault
1711
1712 Default state
1713
1714 =item countrydefault
1715
1716 Default country
1717
1718 =back
1719
1720 =item new_customer_minimal HASHREF
1721
1722 Creates a new customer.
1723
1724 Current differences from new_customer: An address is not required.  promo_code
1725 and reg_code are not supported.  If invoicing_list and _password is passed, a
1726 contact will be created with self-service access (no pkgpart or username is
1727 necessary).  No initial billing is run (this may change in a future version).
1728
1729 Takes a hash reference as parameter with the following keys:
1730
1731 =over 4
1732
1733 =item first
1734
1735 first name (required)
1736
1737 =item last
1738
1739 last name (required)
1740
1741 =item ss
1742
1743 (not typically collected; mostly used for ACH transactions)
1744
1745 =item company
1746
1747 Company name
1748
1749 =item address1
1750
1751 Address line one
1752
1753 =item address2
1754
1755 Address line two
1756
1757 =item city
1758
1759 City
1760
1761 =item county
1762
1763 County
1764
1765 =item state
1766
1767 State
1768
1769 =item zip
1770
1771 Zip or postal code
1772
1773 =item daytime
1774
1775 Daytime phone number
1776
1777 =item night
1778
1779 Evening phone number
1780
1781 =item fax
1782
1783 Fax number
1784
1785 =item payby
1786
1787 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1788
1789 =item payinfo
1790
1791 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1792
1793 =item paycvv
1794
1795 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1796
1797 =item paydate
1798
1799 Expiration date for CARD/DCRD
1800
1801 =item payname
1802
1803 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1804
1805 =item invoicing_list
1806
1807 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),
1808
1809 =item referral_custnum
1810
1811 referring customer number
1812
1813 =item agentnum
1814
1815 Agent number
1816
1817 =item pkgpart
1818
1819 pkgpart of initial package
1820
1821 =item username
1822
1823 Username
1824
1825 =item _password
1826
1827 Password
1828
1829 =item sec_phrase
1830
1831 Security phrase
1832
1833 =item popnum
1834
1835 Access number (index, not the literal number)
1836
1837 =item countrycode
1838
1839 Country code (to be provisioned as a service)
1840
1841 =item phonenum
1842
1843 Phone number (to be provisioned as a service)
1844
1845 =item pin
1846
1847 Voicemail PIN
1848
1849 =back
1850
1851 Returns a hash reference with the following keys:
1852
1853 =over 4
1854
1855 =item error
1856
1857 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)
1858
1859 =back
1860
1861 =item new_customer HASHREF
1862
1863 Creates a new customer.  Takes a hash reference as parameter with the
1864 following keys:
1865
1866 =over 4
1867
1868 =item first
1869
1870 first name (required)
1871
1872 =item last
1873
1874 last name (required)
1875
1876 =item ss
1877
1878 (not typically collected; mostly used for ACH transactions)
1879
1880 =item company
1881
1882 Company name
1883
1884 =item address1 (required)
1885
1886 Address line one
1887
1888 =item address2
1889
1890 Address line two
1891
1892 =item city (required)
1893
1894 City
1895
1896 =item county
1897
1898 County
1899
1900 =item state (required)
1901
1902 State
1903
1904 =item zip (required)
1905
1906 Zip or postal code
1907
1908 =item daytime
1909
1910 Daytime phone number
1911
1912 =item night
1913
1914 Evening phone number
1915
1916 =item fax
1917
1918 Fax number
1919
1920 =item payby
1921
1922 CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY (see L</signup_info> (required)
1923
1924 =item payinfo
1925
1926 Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
1927
1928 =item paycvv
1929
1930 Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
1931
1932 =item paydate
1933
1934 Expiration date for CARD/DCRD
1935
1936 =item payname
1937
1938 Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
1939
1940 =item invoicing_list
1941
1942 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),
1943
1944 =item referral_custnum
1945
1946 referring customer number
1947
1948 =item agentnum
1949
1950 Agent number
1951
1952 =item pkgpart
1953
1954 pkgpart of initial package
1955
1956 =item username
1957
1958 Username
1959
1960 =item _password
1961
1962 Password
1963
1964 =item sec_phrase
1965
1966 Security phrase
1967
1968 =item popnum
1969
1970 Access number (index, not the literal number)
1971
1972 =item countrycode
1973
1974 Country code (to be provisioned as a service)
1975
1976 =item phonenum
1977
1978 Phone number (to be provisioned as a service)
1979
1980 =item pin
1981
1982 Voicemail PIN
1983
1984 =back
1985
1986 Returns a hash reference with the following keys:
1987
1988 =over 4
1989
1990 =item error
1991
1992 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)
1993
1994 =back
1995
1996 =item regionselector HASHREF | LIST
1997
1998 Takes as input a hashref or list of key/value pairs with the following keys:
1999
2000 =over 4
2001
2002 =item selected_county
2003
2004 Currently selected county
2005
2006 =item selected_state
2007
2008 Currently selected state
2009
2010 =item selected_country
2011
2012 Currently selected country
2013
2014 =item prefix
2015
2016 Specify a unique prefix string  if you intend to use the HTML output multiple time son one page.
2017
2018 =item onchange
2019
2020 Specify a javascript subroutine to call on changes
2021
2022 =item default_state
2023
2024 Default state
2025
2026 =item default_country
2027
2028 Default country
2029
2030 =item locales
2031
2032 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>.
2033
2034 =back
2035
2036 Returns a list consisting of three HTML fragments for county selection,
2037 state selection and country selection, respectively.
2038
2039 =cut
2040
2041 #false laziness w/FS::cust_main_county (this is currently the "newest" version)
2042 sub regionselector {
2043   my $param;
2044   if ( ref($_[0]) ) {
2045     $param = shift;
2046   } else {
2047     $param = { @_ };
2048   }
2049   $param->{'selected_country'} ||= $param->{'default_country'};
2050   $param->{'selected_state'} ||= $param->{'default_state'};
2051
2052   my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2053
2054   my $countyflag = 0;
2055
2056   my %cust_main_county;
2057
2058 #  unless ( @cust_main_county ) { #cache
2059     #@cust_main_county = qsearch('cust_main_county', {} );
2060     #foreach my $c ( @cust_main_county ) {
2061     foreach my $c ( @{ $param->{'locales'} } ) {
2062       #$countyflag=1 if $c->county;
2063       $countyflag=1 if $c->{county};
2064       #push @{$cust_main_county{$c->country}{$c->state}}, $c->county;
2065       #$cust_main_county{$c->country}{$c->state}{$c->county} = 1;
2066       $cust_main_county{$c->{country}}{$c->{state}}{$c->{county}} = 1;
2067     }
2068 #  }
2069   $countyflag=1 if $param->{selected_county};
2070
2071   my $script_html = <<END;
2072     <SCRIPT>
2073     function opt(what,value,text) {
2074       var optionName = new Option(text, value, false, false);
2075       var length = what.length;
2076       what.options[length] = optionName;
2077     }
2078     function ${prefix}country_changed(what) {
2079       country = what.options[what.selectedIndex].text;
2080       for ( var i = what.form.${prefix}state.length; i >= 0; i-- )
2081           what.form.${prefix}state.options[i] = null;
2082 END
2083       #what.form.${prefix}state.options[0] = new Option('', '', false, true);
2084
2085   foreach my $country ( sort keys %cust_main_county ) {
2086     $script_html .= "\nif ( country == \"$country\" ) {\n";
2087     foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2088       my $text = $state || '(n/a)';
2089       $script_html .= qq!opt(what.form.${prefix}state, "$state", "$text");\n!;
2090     }
2091     $script_html .= "}\n";
2092   }
2093
2094   $script_html .= <<END;
2095     }
2096     function ${prefix}state_changed(what) {
2097 END
2098
2099   if ( $countyflag ) {
2100     $script_html .= <<END;
2101       state = what.options[what.selectedIndex].text;
2102       country = what.form.${prefix}country.options[what.form.${prefix}country.selectedIndex].text;
2103       for ( var i = what.form.${prefix}county.length; i >= 0; i-- )
2104           what.form.${prefix}county.options[i] = null;
2105 END
2106
2107     foreach my $country ( sort keys %cust_main_county ) {
2108       $script_html .= "\nif ( country == \"$country\" ) {\n";
2109       foreach my $state ( sort keys %{$cust_main_county{$country}} ) {
2110         $script_html .= "\nif ( state == \"$state\" ) {\n";
2111           #foreach my $county ( sort @{$cust_main_county{$country}{$state}} ) {
2112           foreach my $county ( sort keys %{$cust_main_county{$country}{$state}} ) {
2113             my $text = $county || '(n/a)';
2114             $script_html .=
2115               qq!opt(what.form.${prefix}county, "$county", "$text");\n!;
2116           }
2117         $script_html .= "}\n";
2118       }
2119       $script_html .= "}\n";
2120     }
2121   }
2122
2123   $script_html .= <<END;
2124     }
2125     </SCRIPT>
2126 END
2127
2128   my $county_html = $script_html;
2129   if ( $countyflag ) {
2130     $county_html .= qq!<SELECT NAME="${prefix}county" onChange="$param->{'onchange'}">!;
2131     foreach my $county (
2132       sort keys %{ $cust_main_county{$param->{'selected_country'}}{$param->{'selected_state'}} }
2133     ) {
2134       my $text = $county || '(n/a)';
2135       $county_html .= qq!<OPTION VALUE="$county"!.
2136                       ($county eq $param->{'selected_county'} ?
2137                         ' SELECTED>' :
2138                         '>'
2139                       ).
2140                       $text.
2141                       '</OPTION>';
2142     }
2143     $county_html .= '</SELECT>';
2144   } else {
2145     $county_html .=
2146       qq!<INPUT TYPE="hidden" NAME="${prefix}county" VALUE="$param->{'selected_county'}">!;
2147   }
2148
2149   my $state_html = qq!<SELECT NAME="${prefix}state" !.
2150                    qq!onChange="${prefix}state_changed(this); $param->{'onchange'}">!;
2151   foreach my $state ( sort keys %{ $cust_main_county{$param->{'selected_country'}} } ) {
2152     my $text = $state || '(n/a)';
2153     my $selected = $state eq $param->{'selected_state'} ? 'SELECTED' : '';
2154     $state_html .= "\n<OPTION $selected VALUE=\"$state\">$text</OPTION>"
2155   }
2156   $state_html .= '</SELECT>';
2157
2158   my $country_html = '';
2159   if ( scalar( keys %cust_main_county ) > 1 )  {
2160
2161     $country_html = qq(<SELECT NAME="${prefix}country" ).
2162                     qq(onChange="${prefix}country_changed(this); ).
2163                                  $param->{'onchange'}.
2164                                '"'.
2165                       '>';
2166     my $countrydefault = $param->{default_country} || 'US';
2167     foreach my $country (
2168       sort { ($b eq $countrydefault) <=> ($a eq $countrydefault) or $a cmp $b }
2169         keys %cust_main_county
2170     ) {
2171       my $selected = $country eq $param->{'selected_country'}
2172                        ? ' SELECTED'
2173                        : '';
2174       $country_html .= "\n<OPTION $selected>$country</OPTION>"
2175     }
2176     $country_html .= '</SELECT>';
2177   } else {
2178
2179     $country_html = qq(<INPUT TYPE="hidden" NAME="${prefix}country" ).
2180                             ' VALUE="'. (keys %cust_main_county )[0]. '">';
2181
2182   }
2183
2184   ($county_html, $state_html, $country_html);
2185
2186 }
2187
2188 sub regionselector_hashref {
2189   my ($county_html, $state_html, $country_html) = regionselector(@_);
2190   {
2191     'county_html'  => $county_html,
2192     'state_html'   => $state_html,
2193     'country_html' => $country_html,
2194   };
2195 }
2196
2197 =item location_form HASHREF | LIST
2198
2199 Takes as input a hashref or list of key/value pairs with the following keys:
2200
2201 =over 4
2202
2203 =item session_id
2204
2205 Current customer session_id
2206
2207 =item no_asterisks
2208
2209 Omit red asterisks from required fields.
2210
2211 =item address1_label
2212
2213 Label for first address line.
2214
2215 =back
2216
2217 Returns an HTML fragment for a location form (address, city, state, zip,
2218 country)
2219
2220 =cut
2221
2222 sub location_form {
2223   my $param;
2224   if ( ref($_[0]) ) {
2225     $param = shift;
2226   } else {
2227     $param = { @_ };
2228   }
2229
2230   my $session_id = delete $param->{'session_id'};
2231
2232   my $rv = mason_comp( 'session_id' => $session_id,
2233                        'comp'       => '/elements/location.html',
2234                        'args'       => [ %$param ],
2235                      );
2236
2237   #hmm.
2238   $rv->{'error'} || $rv->{'output'};
2239
2240 }
2241
2242
2243 #=item expselect HASHREF | LIST
2244 #
2245 #Takes as input a hashref or list of key/value pairs with the following keys:
2246 #
2247 #=over 4
2248 #
2249 #=item prefix - Specify a unique prefix string  if you intend to use the HTML output multiple time son one page.
2250 #
2251 #=item date - current date, in yyyy-mm-dd or m-d-yyyy format
2252 #
2253 #=back
2254
2255 =item expselect PREFIX [ DATE ]
2256
2257 Takes as input a unique prefix string and the current expiration date, in
2258 yyyy-mm-dd or m-d-yyyy format
2259
2260 Returns an HTML fragments for expiration date selection.
2261
2262 =cut
2263
2264 sub expselect {
2265   #my $param;
2266   #if ( ref($_[0]) ) {
2267   #  $param = shift;
2268   #} else {
2269   #  $param = { @_ };
2270   #my $prefix = $param->{'prefix'};
2271   #my $prefix = exists($param->{'prefix'}) ? $param->{'prefix'} : '';
2272   #my $date =   exists($param->{'date'})   ? $param->{'date'}   : '';
2273   my $prefix = shift;
2274   my $date = scalar(@_) ? shift : '';
2275
2276   my( $m, $y ) = ( 0, 0 );
2277   if ( $date  =~ /^(\d{4})-(\d{2})-\d{2}$/ ) { #PostgreSQL date format
2278     ( $m, $y ) = ( $2, $1 );
2279   } elsif ( $date =~ /^(\d{1,2})-(\d{1,2}-)?(\d{4}$)/ ) {
2280     ( $m, $y ) = ( $1, $3 );
2281   }
2282   my $return = qq!<SELECT NAME="$prefix!. qq!_month" SIZE="1">!;
2283   for ( 1 .. 12 ) {
2284     $return .= qq!<OPTION VALUE="$_"!;
2285     $return .= " SELECTED" if $_ == $m;
2286     $return .= ">$_";
2287   }
2288   $return .= qq!</SELECT>/<SELECT NAME="$prefix!. qq!_year" SIZE="1">!;
2289   my @t = localtime;
2290   my $thisYear = $t[5] + 1900;
2291   for ( ($thisYear > $y && $y > 0 ? $y : $thisYear) .. ($thisYear+10) ) {
2292     $return .= qq!<OPTION VALUE="$_"!;
2293     $return .= " SELECTED" if $_ == $y;
2294     $return .= ">$_";
2295   }
2296   $return .= "</SELECT>";
2297
2298   $return;
2299 }
2300
2301 =item popselector HASHREF | LIST
2302
2303 Takes as input a hashref or list of key/value pairs with the following keys:
2304
2305 =over 4
2306
2307 =item popnum
2308
2309 Access number number
2310
2311 =item pops
2312
2313 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>.
2314
2315 =back
2316
2317 Returns an HTML fragment for access number selection.
2318
2319 =cut
2320
2321 #horrible false laziness with FS/FS/svc_acct_pop.pm::popselector
2322 sub popselector {
2323   my $param;
2324   if ( ref($_[0]) ) {
2325     $param = shift;
2326   } else {
2327     $param = { @_ };
2328   }
2329   my $popnum = $param->{'popnum'};
2330   my $pops = $param->{'pops'};
2331
2332   return '<INPUT TYPE="hidden" NAME="popnum" VALUE="">' unless @$pops;
2333   return $pops->[0]{city}. ', '. $pops->[0]{state}.
2334          ' ('. $pops->[0]{ac}. ')/'. $pops->[0]{exch}. '-'. $pops->[0]{loc}.
2335          '<INPUT TYPE="hidden" NAME="popnum" VALUE="'. $pops->[0]{popnum}. '">'
2336     if scalar(@$pops) == 1;
2337
2338   my %pop = ();
2339   my %popnum2pop = ();
2340   foreach (@$pops) {
2341     push @{ $pop{ $_->{state} }->{ $_->{ac} } }, $_;
2342     $popnum2pop{$_->{popnum}} = $_;
2343   }
2344
2345   my $text = <<END;
2346     <SCRIPT>
2347     function opt(what,href,text) {
2348       var optionName = new Option(text, href, false, false)
2349       var length = what.length;
2350       what.options[length] = optionName;
2351     }
2352 END
2353
2354   my $init_popstate = $param->{'init_popstate'};
2355   if ( $init_popstate ) {
2356     $text .= '<INPUT TYPE="hidden" NAME="init_popstate" VALUE="'.
2357              $init_popstate. '">';
2358   } else {
2359     $text .= <<END;
2360       function acstate_changed(what) {
2361         state = what.options[what.selectedIndex].text;
2362         what.form.popac.options.length = 0
2363         what.form.popac.options[0] = new Option("Area code", "-1", false, true);
2364 END
2365   }
2366
2367   my @states = $init_popstate ? ( $init_popstate ) : keys %pop;
2368   foreach my $state ( sort { $a cmp $b } @states ) {
2369     $text .= "\nif ( state == \"$state\" ) {\n" unless $init_popstate;
2370
2371     foreach my $ac ( sort { $a cmp $b } keys %{ $pop{$state} }) {
2372       $text .= "opt(what.form.popac, \"$ac\", \"$ac\");\n";
2373       if ($ac eq $param->{'popac'}) {
2374         $text .= "what.form.popac.options[what.form.popac.length-1].selected = true;\n";
2375       }
2376     }
2377     $text .= "}\n" unless $init_popstate;
2378   }
2379   $text .= "popac_changed(what.form.popac)}\n";
2380
2381   $text .= <<END;
2382   function popac_changed(what) {
2383     ac = what.options[what.selectedIndex].text;
2384     what.form.popnum.options.length = 0;
2385     what.form.popnum.options[0] = new Option("City", "-1", false, true);
2386
2387 END
2388
2389   foreach my $state ( @states ) {
2390     foreach my $popac ( keys %{ $pop{$state} } ) {
2391       $text .= "\nif ( ac == \"$popac\" ) {\n";
2392
2393       foreach my $pop ( @{$pop{$state}->{$popac}}) {
2394         my $o_popnum = $pop->{popnum};
2395         my $poptext =  $pop->{city}. ', '. $pop->{state}.
2396                        ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2397
2398         $text .= "opt(what.form.popnum, \"$o_popnum\", \"$poptext\");\n";
2399         if ($popnum == $o_popnum) {
2400           $text .= "what.form.popnum.options[what.form.popnum.length-1].selected = true;\n";
2401         }
2402       }
2403       $text .= "}\n";
2404     }
2405   }
2406
2407
2408   $text .= "}\n</SCRIPT>\n";
2409
2410   $param->{'acstate'} = '' unless defined($param->{'acstate'});
2411
2412   $text .=
2413     qq!<TABLE CELLPADDING="0"><TR><TD><SELECT NAME="acstate"! .
2414     qq!SIZE=1 onChange="acstate_changed(this)"><OPTION VALUE=-1>State!;
2415   $text .= "<OPTION" . ($_ eq $param->{'acstate'} ? " SELECTED" : "") .
2416            ">$_" foreach sort { $a cmp $b } @states;
2417   $text .= '</SELECT>'; #callback? return 3 html pieces?  #'</TD>';
2418
2419   $text .=
2420     qq!<SELECT NAME="popac" SIZE=1 onChange="popac_changed(this)">!.
2421     qq!<OPTION>Area code</SELECT></TR><TR VALIGN="top">!;
2422
2423   $text .= qq!<TR><TD><SELECT NAME="popnum" SIZE=1 STYLE="width: 20em"><OPTION>City!;
2424
2425
2426   #comment this block to disable initial list polulation
2427   my @initial_select = ();
2428   if ( scalar( @$pops ) > 100 ) {
2429     push @initial_select, $popnum2pop{$popnum} if $popnum2pop{$popnum};
2430   } else {
2431     @initial_select = @$pops;
2432   }
2433   foreach my $pop ( sort { $a->{state} cmp $b->{state} } @initial_select ) {
2434     $text .= qq!<OPTION VALUE="!. $pop->{popnum}. '"'.
2435              ( ( $popnum && $pop->{popnum} == $popnum ) ? ' SELECTED' : '' ). ">".
2436              $pop->{city}. ', '. $pop->{state}.
2437                ' ('. $pop->{ac}. ')/'. $pop->{exch}. '-'. $pop->{loc};
2438   }
2439
2440   $text .= qq!</SELECT></TD></TR></TABLE>!;
2441
2442   $text;
2443
2444 }
2445
2446 =item domainselector HASHREF | LIST
2447
2448 Takes as input a hashref or list of key/value pairs with the following keys:
2449
2450 =over 4
2451
2452 =item pkgnum
2453
2454 Package number
2455
2456 =item domsvc
2457
2458 Service number of the selected item.
2459
2460 =back
2461
2462 Returns an HTML fragment for domain selection.
2463
2464 =cut
2465
2466 sub domainselector {
2467   my $param;
2468   if ( ref($_[0]) ) {
2469     $param = shift;
2470   } else {
2471     $param = { @_ };
2472   }
2473   my $domsvc= $param->{'domsvc'};
2474   my $rv =
2475       domain_select_hash(map {$_ => $param->{$_}} qw(pkgnum svcpart pkgpart) );
2476   my $domains = $rv->{'domains'};
2477   $domsvc = $rv->{'domsvc'} unless $domsvc;
2478
2479   return '<INPUT TYPE="hidden" NAME="domsvc" VALUE="">'
2480     unless scalar(keys %$domains);
2481
2482   if (scalar(keys %$domains) == 1) {
2483     my $key;
2484     foreach(keys %$domains) {
2485       $key = $_;
2486     }
2487     return '<TR><TD ALIGN="right">Domain</TD><TD>'. $domains->{$key}.
2488            '<INPUT TYPE="hidden" NAME="domsvc" VALUE="'. $key. '"></TD></TR>'
2489   }
2490
2491   my $text .= qq!<TR><TD ALIGN="right">Domain</TD><TD><SELECT NAME="domsvc" SIZE=1 STYLE="width: 20em">!;
2492
2493   $text .= '<OPTION>(Choose Domain)' unless $domsvc;
2494
2495   foreach my $domain ( sort { $domains->{$a} cmp $domains->{$b} } keys %$domains ) {
2496     $text .= qq!<OPTION VALUE="!. $domain. '"'.
2497              ( ( $domsvc && $domain == $domsvc ) ? ' SELECTED' : '' ). ">".
2498              $domains->{$domain};
2499   }
2500
2501   $text .= qq!</SELECT></TD></TR>!;
2502
2503   $text;
2504
2505 }
2506
2507 =item didselector HASHREF | LIST
2508
2509 Takes as input a hashref or list of key/value pairs with the following keys:
2510
2511 =over 4
2512
2513 =item field
2514
2515 Field name for the returned HTML fragment.
2516
2517 =item svcpart
2518
2519 Service definition (see L<FS::part_svc>)
2520
2521 =back
2522
2523 Returns an HTML fragment for DID selection.
2524
2525 =cut
2526
2527 sub didselector {
2528   my $param;
2529   if ( ref($_[0]) ) {
2530     $param = shift;
2531   } else {
2532     $param = { @_ };
2533   }
2534
2535   my $rv = mason_comp( 'comp'=>'/elements/select-did.html',
2536                        'args'=>[ %$param ],
2537                      );
2538
2539   #hmm.
2540   $rv->{'error'} || $rv->{'output'};
2541
2542 }
2543
2544 =back
2545
2546 =head1 RESELLER FUNCTIONS
2547
2548 Note: Resellers can also use the B<signup_info> and B<new_customer> functions
2549 with their active session, and the B<customer_info> and B<order_pkg> functions
2550 with their active session and an additional I<custnum> parameter.
2551
2552 For the most part, development of the reseller web interface has been
2553 superceded by agent-virtualized access to the backend.
2554
2555 =over 4
2556
2557 =item agent_login
2558
2559 Agent login
2560
2561 =item agent_info
2562
2563 Agent info
2564
2565 =item agent_list_customers
2566
2567 List agent's customers.
2568
2569 =back
2570
2571 =head1 BUGS
2572
2573 =head1 SEE ALSO
2574
2575 L<freeside-selfservice-clientd>, L<freeside-selfservice-server>
2576
2577 =cut
2578
2579 1;
2580