X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2FAPI.pm;h=f848361acee4936ad6fcef76d79d3758a0d05d36;hb=0870a4c1fb02be43ea5524f58650d99c81477681;hp=77dbf877ad0033bc655e601eeaa1afefa38d4d91;hpb=979ba4700e25da1e209f8e1034efb85d5155e6ab;p=freeside.git

diff --git a/FS/FS/API.pm b/FS/FS/API.pm
index 77dbf877a..f848361ac 100644
--- a/FS/FS/API.pm
+++ b/FS/FS/API.pm
@@ -1,5 +1,6 @@
 package FS::API;
 
+use strict;
 use FS::Conf;
 use FS::Record qw( qsearch qsearchs );
 use FS::cust_main;
@@ -28,16 +29,17 @@ integration with other back-office systems.
 If accessing this API remotely with XML-RPC or JSON-RPC, be careful to block
 the port by default, only allow access from back-office servers with the same
 security precations as the Freeside server, and encrypt the communication
-channel (for exampple, with an SSH tunnel or VPN) rather than accessing it
+channel (for example, with an SSH tunnel or VPN) rather than accessing it
 in plaintext.
 
 =head1 METHODS
 
 =over 4
 
-=item insert_payment
+=item insert_payment OPTION => VALUE, ...
 
-Adds a new payment to a customers account. Takes a hash reference as parameter with the following keys:
+Adds a new payment to a customers account. Takes a list of keys and values as
+paramters with the following keys:
 
 =over 5
 
@@ -59,9 +61,10 @@ Amount paid
 
 =item _date
 
-
 Option date for payment
 
+=back
+
 Example:
 
   my $result = FS::API->insert_payment(
@@ -81,8 +84,6 @@ Example:
     print "paynum ". $result->{'paynum'};
   }
 
-=back
-
 =cut
 
 #enter cash payment
@@ -132,9 +133,10 @@ sub _by_phonenum {
 
 }
 
-=item insert_credit
+=item insert_credit OPTION => VALUE, ...
 
-Adds a a credit to a customers account. Takes a hash reference as parameter with the following keys
+Adds a a credit to a customers account.  Takes a list of keys and values as
+parameters with the following keys
 
 =over 
 
@@ -154,6 +156,8 @@ Amount of the credit
 
 The date the credit will be posted
 
+=back
+
 Example:
 
   my $result = FS::API->insert_credit(
@@ -172,8 +176,6 @@ Example:
     print "crednum ". $result->{'crednum'};
   }
 
-=back
-
 =cut
 
 #Enter credit
@@ -205,9 +207,10 @@ sub insert_credit_phonenum {
 
 }
 
-=item insert_refund
+=item insert_refund OPTION => VALUE, ...
 
-Adds a a credit to a customers account. Takes a hash reference as parameter with the following keys: custnum,payby,refund
+Adds a a credit to a customers account.  Takes a list of keys and values as
+parmeters with the following keys: custnum, payby, refund
 
 Example:
 
@@ -269,9 +272,10 @@ sub insert_refund_phonenum {
 
 # long-term: package changes?
 
-=item new_customer
+=item new_customer OPTION => VALUE, ...
 
-Creates a new customer. Takes a hash reference as parameter with the following keys:
+Creates a new customer. Takes a list of keys and values as parameters with the
+following keys:
 
 =over 4
 
@@ -361,29 +365,13 @@ comma-separated list of email addresses for email invoices. The special value 'P
 postal_invoicing
 Set to 1 to enable postal invoicing
 
-=item payby
-
-CARD, DCRD, CHEK, DCHK, LECB, BILL, COMP or PREPAY
-
-=item payinfo
-
-Card number for CARD/DCRD, account_number@aba_number for CHEK/DCHK, prepaid "pin" for PREPAY, purchase order number for BILL
-
-=item paycvv
-
-Credit card CVV2 number (1.5+ or 1.4.2 with CVV schema patch)
-
-=item paydate
-
-Expiration date for CARD/DCRD
-
-=item payname
+=item referral_custnum
 
-Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
+Referring customer number
 
-=item referral_custnum
+=item salesnum
 
-referring customer number
+Sales person number
 
 =item agentnum
 
@@ -397,6 +385,7 @@ Agent specific customer number
 
 Referring customer number
 
+=back
 
 =cut
 
@@ -406,136 +395,145 @@ Referring customer number
 
 sub new_customer {
   my( $class, %opt ) = @_;
+
   my $conf = new FS::Conf;
   return { 'error' => 'Incorrect shared secret' }
     unless $opt{secret} eq $conf->config('api_shared_secret');
 
   #default agentnum like signup_server-default_agentnum?
+  #$opt{agentnum} ||= $conf->config('signup_server-default_agentnum');
  
   #same for refnum like signup_server-default_refnum
+  $opt{refnum} ||= $conf->config('signup_server-default_refnum');
 
-  my $cust_main = new FS::cust_main ( {
-      'agentnum'      => $agentnum,
-      'refnum'        => $opt{refnum}
-                         || $conf->config('signup_server-default_refnum'),
-      'payby'         => 'BILL',
-
-      map { $_ => $opt{$_} } qw(
-        agentnum refnum agent_custid referral_custnum
-        last first company 
-        daytime night fax mobile
-        payby payinfo paydate paycvv payname
-      ),
-
-  } );
-
-  my @invoicing_list = $opt{'invoicing_list'}
-                         ? split( /\s*\,\s*/, $opt{'invoicing_list'} )
-                         : ();
-  push @invoicing_list, 'POST' if $opt{'postal_invoicing'};
-
-  my ($bill_hash, $ship_hash);
-  foreach my $f (FS::cust_main->location_fields) {
-    # avoid having to change this in front-end code
-    $bill_hash->{$f} = $opt{"bill_$f"} || $opt{$f};
-    $ship_hash->{$f} = $opt{"ship_$f"};
-  }
+  $class->API_insert( %opt );
+}
 
-  my $bill_location = FS::cust_location->new($bill_hash);
-  my $ship_location;
-  # we don't have an equivalent of the "same" checkbox in selfservice^Wthis API
-  # so is there a ship address, and if so, is it different from the billing 
-  # address?
-  if ( length($ship_hash->{address1}) > 0 and
-          grep { $bill_hash->{$_} ne $ship_hash->{$_} } keys(%$ship_hash)
-         ) {
-
-    $ship_location = FS::cust_location->new( $ship_hash );
-  
-  } else {
-    $ship_location = $bill_location;
-  }
+=item update_customer
 
-  $cust_main->set('bill_location' => $bill_location);
-  $cust_main->set('ship_location' => $ship_location);
+Updates an existing customer. Passing an empty value clears that field, while
+NOT passing that key/value at all leaves it alone. Takes a list of keys and
+values as parameters with the following keys:
 
-  $error = $cust_main->insert( {}, \@invoicing_list );
-  return { 'error'   => $error } if $error;
-  
-  return { 'error'   => '',
-           'custnum' => $cust_main->custnum,
-         };
+=over 4
 
-}
+=item secret
 
-=back 
+API Secret (required)
 
-=item customer_info
+=item custnum
 
-Returns general customer information. Takes a hash reference as parameter with the following keys: custnum and API secret 
+Customer number (required)
 
-=cut
+=item first
+
+first name 
 
-#some false laziness w/ClientAPI::Myaccount customer_info/customer_info_short
+=item last
 
-use vars qw( @cust_main_editable_fields @location_editable_fields );
-@cust_main_editable_fields = qw(
-  first last company daytime night fax mobile
-);
-#  locale
-#  payby payinfo payname paystart_month paystart_year payissue payip
-#  ss paytype paystate stateid stateid_state
-@location_editable_fields = qw(
-  address1 address2 city county state zip country
-);
+last name 
 
-sub customer_info {
+=item company
+
+Company name
+
+=item address1 
+
+Address line one
+
+=item city 
+
+City
+
+=item county
+
+County
+
+=item state 
+
+State
+
+=item zip 
+
+Zip or postal code
+
+=item country
+
+2 Digit Country Code
+
+=item daytime
+
+Daytime phone number
+
+=item night
+
+Evening phone number
+
+=item fax
+
+Fax number
+
+=item mobile
+
+Mobile number
+
+=item invoicing_list
+
+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),
+postal_invoicing
+Set to 1 to enable postal invoicing
+
+=item referral_custnum
+
+Referring customer number
+
+=item salesnum
+
+Sales person number
+
+=item agentnum
+
+Agent number
+
+=back
+
+=cut
+
+sub update_customer {
   my( $class, %opt ) = @_;
+
   my $conf = new FS::Conf;
   return { 'error' => 'Incorrect shared secret' }
     unless $opt{secret} eq $conf->config('api_shared_secret');
 
-  my $cust_main = qsearchs('cust_main', { 'custnum' => $opt{custnum} })
-    or return { 'error' => 'Unknown custnum' };
-
-  my %return = (
-    'error'           => '',
-    'display_custnum' => $cust_main->display_custnum,
-    'name'            => $cust_main->first. ' '. $cust_main->get('last'),
-    'balance'         => $cust_main->balance,
-    'status'          => $cust_main->status,
-    'statuscolor'     => $cust_main->statuscolor,
-  );
+  FS::cust_main->API_update( %opt );
+}
 
-  $return{$_} = $cust_main->get($_)
-    foreach @cust_main_editable_fields;
+=item customer_info OPTION => VALUE, ...
 
-  for (@location_editable_fields) {
-    $return{$_} = $cust_main->bill_location->get($_)
-      if $cust_main->bill_locationnum;
-    $return{'ship_'.$_} = $cust_main->ship_location->get($_)
-      if $cust_main->ship_locationnum;
-  }
+Returns general customer information. Takes a list of keys and values as
+parameters with the following keys: custnum, secret 
 
-  my @invoicing_list = $cust_main->invoicing_list;
-  $return{'invoicing_list'} =
-    join(', ', grep { $_ !~ /^(POST|FAX)$/ } @invoicing_list );
-  $return{'postal_invoicing'} =
-    0 < ( grep { $_ eq 'POST' } @invoicing_list );
+=cut
 
-  #generally, the more useful data from the cust_main record the better.
-  # well, tell me what you want
+sub customer_info {
+  my( $class, %opt ) = @_;
+  my $conf = new FS::Conf;
+  return { 'error' => 'Incorrect shared secret' }
+    unless $opt{secret} eq $conf->config('api_shared_secret');
 
-  return \%return;
+  my $cust_main = qsearchs('cust_main', { 'custnum' => $opt{custnum} })
+    or return { 'error' => 'Unknown custnum' };
 
+  $cust_main->API_getinfo;
 }
 
-
 =item location_info
 
-Returns location specific information for the customer. Takes a hash reference as parameter with the following keys: custnum,secret
-
-=back
+Returns location specific information for the customer. Takes a list of keys
+and values as paramters with the following keys: custnum, secret
 
 =cut
 
@@ -559,6 +557,49 @@ sub location_info {
   return \%return;
 }
 
+=item bill_now OPTION => VALUE, ...
+
+Bills a single customer now, in the same fashion as the "Bill now" link in the
+UI.
+
+Returns a hash reference with a single key, 'error'.  If there is an error,   
+the value contains the error, otherwise it is empty. Takes a list of keys and
+values as parameters with the following keys:
+
+=over 4
+
+=item secret
+
+API Secret (required)
+
+=item custnum
+
+Customer number (required)
+
+=back
+
+=cut
+
+sub bill_now {
+  my( $class, %opt ) = @_;
+  my $conf = new FS::Conf;
+  return { 'error' => 'Incorrect shared secret' }
+    unless $opt{secret} eq $conf->config('api_shared_secret');
+
+  my $cust_main = qsearchs('cust_main', { 'custnum' => $opt{custnum} })
+    or return { 'error' => 'Unknown custnum' };
+
+  my $error = $cust_main->bill_and_collect( 'fatal'      => 'return',
+                                            'retry'      => 1,
+                                            'check_freq' =>'1d',
+                                          );
+
+   return { 'error' => $error,
+          };
+
+}
+
+
 #Advertising sources?