document shipping address fields in new_customer self-service API, RT#74008

[freeside.git] / fs_selfservice / FS-SelfService / SelfService.pm

diff --git a/fs_selfservice/FS-SelfService/SelfService.pm b/fs_selfservice/FS-SelfService/SelfService.pm
index 32b2ded..f1b2081 100644 (file)
--- a/fs_selfservice/FS-SelfService/SelfService.pm
+++ b/fs_selfservice/FS-SelfService/SelfService.pm
@@ -48,6 +48,8 @@ $socket .= '.'.$tag if defined $tag && length($tag);
   'legacy_invoice_pdf'        => 'MyAccount/legacy_invoice_pdf',
   'invoice_logo'              => 'MyAccount/invoice_logo',
   'list_invoices'             => 'MyAccount/list_invoices', #?
+  'list_payments'             => 'MyAccount/list_payments',
+  'payment_receipt'           => 'MyAccount/payment_receipt',
   'cancel'                    => 'MyAccount/cancel',        #add to ss cgi!
   'payment_info'              => 'MyAccount/payment_info',
   'payment_info_renew_info'   => 'MyAccount/payment_info_renew_info',
@@ -109,6 +111,7 @@ $socket .= '.'.$tag if defined $tag && length($tag);
   'new_customer'              => 'Signup/new_customer',
   'new_customer_minimal'      => 'Signup/new_customer_minimal',
   'capture_payment'           => 'Signup/capture_payment',
+  'new_prospect'              => 'Signup/new_prospect',
   #N/A 'clear_signup_cache'        => 'Signup/clear_cache',
   'new_agent'                 => 'Agent/new_agent',
   'agent_login'               => 'Agent/agent_login',
@@ -266,7 +269,6 @@ FS::SelfService - Freeside self-service API
 
   my $customer_info = customer_info( { 'session_id' => $session_id } );
 
-  #payment_info and process_payment are available in 1.5+ only
   my $payment_info = payment_info( { 'session_id' => $session_id } );
 
   #!!! process_payment example
@@ -585,7 +587,19 @@ success or an error message on errors.
 
 Returns information that may be useful in displaying a payment page.
 
-Takes a hash reference as parameter with a single key: B<session_id>.
+Takes a hash reference as parameter with the following keys:
+
+=over 4
+
+=item session_id
+
+Required session ID
+
+=item omit_cust_main_county
+
+Optional, pass a true value to omit cust_main_county data for performance.
+
+=back
 
 Returns a hash reference with the following keys:
 
@@ -1973,6 +1987,21 @@ State
 
 Zip or postal code
 
+=item ship_address1
+
+=item ship_address2
+
+=item ship_city
+
+=item ship_county
+
+=item ship_state
+
+=item ship_zip
+
+Optional shipping address fields.  If sending an optional shipping address,
+ship_address1, ship_city, ship_state and ship_zip are required.
+
 =item daytime
 
 Daytime phone number