eliminate some false laziness in FS::Misc::send_email vs. msg_template/email.pm send_...

[freeside.git] / FS / FS / payby.pm

diff --git a/FS/FS/payby.pm b/FS/FS/payby.pm
index e223a05..b849655 100644 (file)
--- a/FS/FS/payby.pm
+++ b/FS/FS/payby.pm
@@ -5,7 +5,6 @@ use vars qw(%hash %payby2bop);
 use Tie::IxHash;
 use Business::CreditCard;
 
-
 =head1 NAME
 
 FS::payby - Object methods for payment type records
@@ -39,9 +38,10 @@ Payment types.
 =cut
 
 # paybys can be any/all of:
-# - a customer payment type (cust_main.payby)
+# - a customer saved payment type (cust_payby.payby)
 # - a payment or refund type (cust_pay.payby, cust_pay_batch.payby, cust_refund.payby)
-# - an event type (part_bill_event.payby)
+
+# customer methods that start with 'D' will be interpreted as on-demand
 
 tie %hash, 'Tie::IxHash',
   'CARD' => {
@@ -70,17 +70,12 @@ tie %hash, 'Tie::IxHash',
     cust_pay  => 'CHEK', #this is a customer type only, payments are CHEK...
     realtime  => 1,
   },
-  'LECB' => {
-    tinyname  => 'phone bill',
-    shortname => 'Phone bill billing',
-    longname  => 'Phone bill billing',
-    realtime  => 1,
-  },
   'BILL' => {
     tinyname  => 'billing',
     shortname => 'Billing',
     payname   => 'Check',
     longname  => 'Billing',
+    cust_main => '', #no longer a customer type
   },
   'PPAL' => {
     tinyname  => 'PayPal',
@@ -93,42 +88,54 @@ tie %hash, 'Tie::IxHash',
     tinyname  => 'prepaid card',
     shortname => 'Prepaid card',
     longname  => 'Prepaid card',
-    cust_main => 'BILL', #this is a payment type only, customers go to BILL...
+    cust_main => '', #this is a payment type only
   },
   'CASH' => {
     tinyname  => 'cash',
     shortname => 'Cash', # initial payment, then billing
     longname  => 'Cash',
-    cust_main => 'BILL', #this is a payment type only, customers go to BILL...
+    cust_main => '', #this is a payment type only
   },
   'WEST' => {
     tinyname  => 'western union',
     shortname => 'Western Union', # initial payment, then billing
     longname  => 'Western Union',
-    cust_main => 'BILL', #this is a payment type only, customers go to BILL...
+    cust_main => '', #this is a payment type only
+  },
+  'IDTP' => {
+    tinyname  => 'IDT',
+    shortname => 'IDT Payment Services',
+    longname  => 'IDT Payment Services',
+    cust_main => '', #this is a payment type only
   },
   'MCRD' => { #not the same as DCRD
     tinyname  => 'card',
     shortname => 'Manual credit card', # initial payment, then billing
     longname  => 'Manual credit card', 
-    cust_main => 'BILL', #this is a payment type only, customers go to BILL...
+    cust_main => '', #this is a payment type only
+  },
+  'MCHK' => { #not the same as DCHK
+    tinyname  => 'card',
+    shortname => 'Manual electronic check', # initial payment, then billing
+    longname  => 'Manual electronic check', 
+    cust_main => '', #this is a payment type only
   },
   'APPL' => {
     tinyname  => 'apple store',
     shortname => 'Apple Store',
     longname  => 'Apple Store',
-    cust_main => 'BILL', #this is a payment type only, customers go to BILL...
+    cust_main => '', #this is a payment type only
   },
   'ANRD' => {
     tinyname  => 'android market',
     shortname => 'Android Market',
     longname  => 'Android Market',
-    cust_main => 'BILL', #this is a payment type only, customers go to BILL...
+    cust_main => '', #this is a payment type only
   },
   'EDI' => {
     tinyname  => 'EDI',
-    shortname => 'Electronic Debit',
-    longname  => 'Electronic Debit',
+    shortname => 'Electronic Debit (EDI)',
+    longname  => 'Electronic Debit (EDI)',
     cust_main => '', #not a customer type
   },
   'WIRE' => {
@@ -137,12 +144,6 @@ tie %hash, 'Tie::IxHash',
     longname  => 'Wire transfer',
     cust_main => '', #not a customer type
   },
-  'COMP' => {
-    tinyname  => 'comp',
-    shortname => 'Complimentary',
-    longname  => 'Complimentary',
-    cust_pay  => '', # (free) is depricated as a payment type in cust_pay
-  },
   'CBAK' => {
     tinyname  => 'chargeback',
     shortname => 'Chargeback',
@@ -207,7 +208,9 @@ sub longname {
 %payby2bop = (
   'CARD' => 'CC',
   'CHEK' => 'ECHECK',
-  'MCRD' => 'CC',
+  'MCRD' => 'CC', #?  but doesn't MCRD mean _offline_ card?  i think it got
+                  # overloaded for third-party card payments -- but no one is
+                  # doing those other than paypal now
   'PPAL' => 'PAYPAL',
 );
 
@@ -226,11 +229,49 @@ sub cust_payby {
   grep { ! exists $hash{$_}->{cust_main} } $self->payby;
 }
 
+sub cust_payby2shortname {
+  my $self = shift;
+  map { $_ => $hash{$_}->{shortname} } $self->cust_payby;
+}
+
 sub cust_payby2longname {
   my $self = shift;
   map { $_ => $hash{$_}->{longname} } $self->cust_payby;
 }
 
+=item payment_payby
+
+Returns all values of payby that can be used by payments.
+
+=cut
+
+sub payment_payby {
+  my $self = shift;
+  grep { ! exists $hash{$_}->{cust_pay} } $self->payby;
+}
+
+=item payment_payby2longname
+
+Returns hash, keys are L</payment_payby> types, values are payby longname.
+
+=cut
+
+sub payment_payby2longname {
+  my $self = shift;
+  map { $_ => $hash{$_}->{longname} } $self->payment_payby;
+}
+
+=item payment_payby2payname
+
+Returns hash, keys are L</payment_payby> types, values are payby payname.
+
+=cut
+
+sub payment_payby2payname {
+  my $self = shift;
+  map { $_ => $self->payname($_) } $self->payment_payby;
+}
+
 =back
 
 =head1 BUGS