X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2FAPI.pm;h=629463c37619c7be8d45676bf86c5e9aeb55cea2;hb=fc937dac3920ddbf5d009bb28c75ff1eb529c625;hp=98c1a938d5e5b42c29946bdf863b9f3d4d723f22;hpb=f3853d3ed85d993f6bc058747d338fcbf344cb61;p=freeside.git

diff --git a/FS/FS/API.pm b/FS/FS/API.pm
index 98c1a938d..629463c37 100644
--- a/FS/FS/API.pm
+++ b/FS/FS/API.pm
@@ -1,8 +1,10 @@
 package FS::API;
 
+use strict;
 use FS::Conf;
-use FS::Record qw( qsearchs );
+use FS::Record qw( qsearch qsearchs );
 use FS::cust_main;
+use FS::cust_location;
 use FS::cust_pay;
 use FS::cust_credit;
 use FS::cust_refund;
@@ -27,7 +29,7 @@ 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
@@ -36,6 +38,31 @@ in plaintext.
 
 =item insert_payment
 
+Adds a new payment to a customers account. Takes a hash reference as parameter with the following keys:
+
+=over 5
+
+=item secret
+
+API Secret
+
+=item custnum
+
+Customer number
+
+=item payby
+
+Payment type
+
+=item paid
+
+Amount paid
+
+=item _date
+
+
+Option date for payment
+
 Example:
 
   my $result = FS::API->insert_payment(
@@ -55,6 +82,8 @@ Example:
     print "paynum ". $result->{'paynum'};
   }
 
+=back
+
 =cut
 
 #enter cash payment
@@ -106,6 +135,26 @@ sub _by_phonenum {
 
 =item insert_credit
 
+Adds a a credit to a customers account. Takes a hash reference as parameter with the following keys
+
+=over 
+
+=item secret
+
+API Secret
+
+=item custnum
+
+customer number
+
+=item amount
+
+Amount of the credit
+
+=item _date
+
+The date the credit will be posted
+
 Example:
 
   my $result = FS::API->insert_credit(
@@ -124,6 +173,8 @@ Example:
     print "crednum ". $result->{'crednum'};
   }
 
+=back
+
 =cut
 
 #Enter credit
@@ -157,6 +208,8 @@ sub insert_credit_phonenum {
 
 =item insert_refund
 
+Adds a a credit to a customers account. Takes a hash reference as parameter with the following keys: custnum,payby,refund
+
 Example:
 
   my $result = FS::API->insert_refund(
@@ -212,50 +265,286 @@ sub insert_refund_phonenum {
 
 #---
 
-#Customer data
-# pull customer info 
-# The fields needed are:
-#
-# cust_main.custnum
-# cust_main.first
-# cust_main.last
-# cust_main.company
-# cust_main.address1
-# cust_main.address2
-# cust_main.city
-# cust_main.state
-# cust_main.zip
-# cust_main.daytime
-# cust_main.night
-# cust_main_invoice.dest
-#
-# at minimum
-
-#Customer balances
-
-#Advertising sources?
-
 # "2 way syncing" ?  start with non-sync pulling info here, then if necessary
 # figure out how to trigger something when those things change
 
 # long-term: package changes?
 
-=item customer_info
+=item new_customer
+
+Creates a new customer. Takes a hash reference as parameter with the following keys:
+
+=over 4
+
+=item secret
+
+API Secret
+
+=item first
+
+first name (required)
+
+=item last
+
+last name (required)
+
+=item ss
+
+(not typically collected; mostly used for ACH transactions)
+
+=item company
+
+Company name
+
+=item address1 (required)
+
+Address line one
+
+=item city (required)
+
+City
+
+=item county
+
+County
+
+=item state (required)
+
+State
+
+=item zip (required)
+
+Zip or postal code
+
+=item country
+
+2 Digit Country Code
+
+=item latitude
+
+latitude
+
+=item Longitude
+
+longitude
+
+=item geocode
+
+Currently used for third party tax vendor lookups
+
+=item censustract
+
+Used for determining FCC 477 reporting
+
+=item censusyear
+
+Used for determining FCC 477 reporting
+
+=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 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
+
+Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
+
+=item referral_custnum
+
+Referring customer number
+
+=item salesnum
+
+Sales person number
+
+=item agentnum
+
+Agent number
+
+=item agent_custid
+
+Agent specific customer number
+
+=item referral_custnum
+
+Referring customer number
+
+
+=cut
+
+#certainly false laziness w/ClientAPI::Signup new_customer/new_customer_minimal
+# but approaching this from a clean start / back-office perspective
+#  i.e. no package/service, no immediate credit card run, etc.
+
+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');
+
+  $class->API_insert( %opt );
+}
+
+=back 
+
+=item update_customer
+
+Updates an existing customer. Takes a hash reference as parameter with the foll$
+
+=over 4
+
+=item secret
+
+API Secret
+
+=item first
+
+first name (required)
+
+=item last
+
+last name (required)
+
+=item company
+
+Company name
+
+=item address1 (required)
+
+Address line one
+
+=item city (required)
+
+City
+
+=item county
+
+County
+
+=item state (required)
+
+State
+
+=item zip (required)
+
+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 '$
+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 "pi$
+
+=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
+
+Exact name on credit card for CARD/DCRD, bank name for CHEK/DCHK
+
+=item referral_custnum
+
+Referring customer number
+
+=item salesnum
+Sales person number
+
+=item agentnum
+
+Agent number
 
 =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');
+
+  FS::cust_main->API_update( %opt );
+}
+
+=back
 
-#some false laziness w/ClientAPI::Myaccount customer_info/customer_info_short
 
-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
-);
+=item customer_info
+
+Returns general customer information. Takes a hash reference as parameter with the following keys: custnum and API secret 
+
+=cut
 
 sub customer_info {
   my( $class, %opt ) = @_;
@@ -266,19 +555,38 @@ sub customer_info {
   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
+
+=cut
+
+#I also monitor for changes to the additional locations that are applied to
+# packages, and would like for those to be exportable as well.  basically the
+# location data passed with the custnum.
+
+sub location_info {
+  my( $class, %opt ) = @_;
+  my $conf = new FS::Conf;
+  return { 'error' => 'Incorrect shared secret' }
+    unless $opt{secret} eq $conf->config('api_shared_secret');
+
+  my @cust_location = qsearch('cust_location', { 'custnum' => $opt{custnum} });
+
   my %return = (
     'error'           => '',
-    'display_custnum' => $cust_main->display_custnum,
-    'name'            => $cust_main->first. ' '. $cust_main->get('last'),
+    'locations'       => [ map $_->hashref, @cust_location ],
   );
 
-  $return{$_} = $cust_main->get($_)
-    foreach @cust_main_editable_fields;
-
   return \%return;
-
 }
 
-=back
+#Advertising sources?
+
 
 1;