X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=fs_selfservice%2FFS-SelfService%2FSelfService.pm;h=bc54b1ef3660082152f9c2789cf2b92c74f1149c;hp=e01d17b6a04d3181b7627601758b07914fa81977;hb=8b4fe72cbd3b29445e336cc3e8cc5dbf5ff02185;hpb=c39d6e73a98427d653e3d019aaa90f16bc1b6380 diff --git a/fs_selfservice/FS-SelfService/SelfService.pm b/fs_selfservice/FS-SelfService/SelfService.pm index e01d17b6a..bc54b1ef3 100644 --- a/fs_selfservice/FS-SelfService/SelfService.pm +++ b/fs_selfservice/FS-SelfService/SelfService.pm @@ -48,6 +48,9 @@ $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_payby' => 'MyAccount/list_payby', + 'insert_payby' => 'MyAccount/insert_payby', + 'delete_payby' => 'MyAccount/delete_payby', 'cancel' => 'MyAccount/cancel', #add to ss cgi! 'payment_info' => 'MyAccount/payment_info', 'payment_info_renew_info' => 'MyAccount/payment_info_renew_info', @@ -96,6 +99,7 @@ $socket .= '.'.$tag if defined $tag && length($tag); 'reset_passwd' => 'MyAccount/reset_passwd', 'check_reset_passwd' => 'MyAccount/check_reset_passwd', 'process_reset_passwd' => 'MyAccount/process_reset_passwd', + 'validate_passwd' => 'MyAccount/validate_passwd', 'list_tickets' => 'MyAccount/list_tickets', 'create_ticket' => 'MyAccount/create_ticket', 'get_ticket' => 'MyAccount/get_ticket', @@ -108,6 +112,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', @@ -134,6 +139,8 @@ $socket .= '.'.$tag if defined $tag && length($tag); 'quotation_remove_pkg' => 'MyAccount/quotation/quotation_remove_pkg', 'quotation_order' => 'MyAccount/quotation/quotation_order', + 'freesideinc_service' => 'Freeside/freesideinc_service', + ); @EXPORT_OK = ( keys(%autoload), @@ -567,6 +574,120 @@ Invoice date, in UNIX epoch time =back +=item list_payby HASHREF + +Returns a list of all stored customer payment information (credit cards and +electronic check accounts). Takes a hash reference with a single key, +session_id. + +Returns a hash reference with the following keys: + +=over 4 + +=item error + +Empty on success, or an error message on errors + +=item payby + +Reference to array of hash references with the following keys: + +=over 4 + +=item custpaybynum + +=item weight + +Numeric weighting. Stored payment information with a lower weight is attempted +first. + +=item payby + +CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD +(on-demand credit card) or DCHK (on-demand electronic check). + +=item paymask + +Masked credit card number (or, masked account and routing numbers) + +=item paydate + +Credit card expiration date + +=item payname + +Exact name on card (or bank name, for electronic checks) + +=item paystate + +For electronic checks, bank state + +=item paytype + +For electronic checks, account type (Personal/Business, Checking/Savings) + +=back + +=back + +=item insert_payby HASHREF + +Adds new stored payment information for this customer. Takes a hash reference +with the following keys: + +=over 4 + +=item session_id + +=item weight + +Numeric weighting. Stored payment information with a lower weight is attempted +first. + +=item payby + +CARD (Automatic credit card), CHEK (Automatic electronic check), DCRD +(on-demand credit card) or DCHK (on-demand electronic check). + +=item payinfo + +Credit card number (or electronic check "account@routing") + +=item paycvv + +CVV2 number / security code + +=item paydate + +Credit card expiration date + +=item payname + +Exact name on card (or bank name, for electronic checks) + +=item paystate + +For electronic checks, bank state + +=item paytype + +For electronic checks, account type (i.e. "Personal Savings", "Personal Checking", "Business Checking")A + +=item payip + +Optional IP address from which payment was submitted + +=back + +If there is an error, returns a hash reference with a single key, B, +otherwise returns a hash reference with a single key, B. + +=item delete_payby HASHREF + +Removes stored payment information. Takes a hash reference with two keys, +B and B. Returns a hash reference with a single key, +B, which is an error message or empty for successful removal. + =item cancel HASHREF Cancels this customer. @@ -951,6 +1072,10 @@ Number of total bytes gained by recharge Orders a package for this customer. +If signup_server-realtime is set, bills the new package, attemps to collect +payment and (for auto-payment customers) cancels the package if the payment is +declined. + Takes a hash reference as parameter with the following keys: =over 4 @@ -967,6 +1092,11 @@ Package to order (see L). Quantity for this package order (default 1). +=item run_bill_events + +If true, runs billing events for the customer after ordering and billing the +package (signup_server-realtime must be set). + =item locationnum Optional locationnum for this package order, for existing locations. @@ -974,13 +1104,22 @@ Optional locationnum for this package order, for existing locations. Or, for new locations, pass the following fields: address1*, address2, city*, county, state*, zip*, country. (* = required in this case) +(None of this is required at all if you are just ordering a package +at the customer's existing default service location.) + =item address1 -=item address 2 +=item address2 =item city -=item +=item county + +=item state + +=item zip + +=item country =item svcpart @@ -1140,7 +1279,7 @@ following keys: =item bill_date (Future) Bill date. Indicates a future date for which billing could be run. -Specified as a integer UNIX timestamp. Pass this value to the B +Specified as an integer UNIX timestamp. Pass this value to the B function. =item bill_date_pretty @@ -1156,7 +1295,7 @@ Base amount which will be charged if renewed early as of this date. Renewal date; i.e. even-futher future date at which the customer will be paid through if the early renewal is completed with the given B. -Specified as a integer UNIX timestamp. +Specified as an integer UNIX timestamp. =item renew_date_pretty @@ -1217,6 +1356,11 @@ Session identifier pkgpart of package to cancel +=item date + +Optional date, for future cancellation (expiration) instead of immediate +cancellation. Specified as an integer UNIX timestamp ("epoch time"). + =back Returns a hash reference with a single key, B, empty on success, or an @@ -1383,7 +1527,7 @@ message, or empty on success, and B, a list of contacts. B is an array reference of hash references (i.e. an array of structs, in XML-RPC). Each hash reference (struct) has the following keys: -=over4 +=over 4 =item contactnum @@ -1492,6 +1636,8 @@ Takes a hash reference as parameter with the following keys: Returns a hash reference with a single parameter, B, which contains an error message, or empty on success. +=back + =head2 "MY ACCOUNT" QUOTATION FUNCTIONS All of these functions require the user to be logged in, and the 'session_id' @@ -1635,8 +1781,6 @@ Removes a package from a quotation. Takes the following arguments: Returns 'error' => a string, which will be empty on success. -=back - =item quotation_order HASHREF Converts the packages in a quotation into real packages. Takes the following