[freeside-commits] branch master updated. f3853d3ed85d993f6bc058747d338fcbf344cb61
Ivan
ivan at 420.am
Wed Mar 5 17:40:00 PST 2014
The branch, master has been updated
via f3853d3ed85d993f6bc058747d338fcbf344cb61 (commit)
from 7a7a0c736e3cfbd10b06151a93bf499d185d37d3 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
commit f3853d3ed85d993f6bc058747d338fcbf344cb61
Author: Ivan Kohler <ivan at freeside.biz>
Date: Wed Mar 5 17:39:57 2014 -0800
API methods to insert payments & credits (and look them up via phonenum), RT#27958
diff --git a/FS/FS/API.pm b/FS/FS/API.pm
index df48802..98c1a93 100644
--- a/FS/FS/API.pm
+++ b/FS/FS/API.pm
@@ -3,6 +3,9 @@ package FS::API;
use FS::Conf;
use FS::Record qw( qsearchs );
use FS::cust_main;
+use FS::cust_pay;
+use FS::cust_credit;
+use FS::cust_refund;
=head1 NAME
@@ -31,12 +34,181 @@ in plaintext.
=over 4
-# needs to be able to:
-Enter cash payment
-Enter credit
-Enter cash refund.
+=item insert_payment
-# would like to be able to pass the phone number ( from svc_phone ) to the API for this query.
+Example:
+
+ my $result = FS::API->insert_payment(
+ 'secret' => 'sharingiscaring',
+ 'custnum' => 181318,
+ 'payby' => 'CASH',
+ 'paid' => '54.32',
+
+ #optional
+ '_date' => 1397977200, #UNIX timestamp
+ );
+
+ if ( $result->{'error'} ) {
+ die $result->{'error'};
+ } else {
+ #payment was inserted
+ print "paynum ". $result->{'paynum'};
+ }
+
+=cut
+
+#enter cash payment
+sub insert_payment {
+ my($class, %opt) = @_;
+ my $conf = new FS::Conf;
+ return { 'error' => 'Incorrect shared secret' }
+ unless $opt{secret} eq $conf->config('api_shared_secret');
+
+ #less "raw" than this? we are the backoffice API, and aren't worried
+ # about version migration ala cust_main/cust_location here
+ my $cust_pay = new FS::cust_pay { %opt };
+ my $error = $cust_pay->insert( 'manual'=>1 );
+ return { 'error' => $error,
+ 'paynum' => $cust_pay->paynum,
+ };
+}
+
+# pass the phone number ( from svc_phone )
+sub insert_payment_phonenum {
+ my($class, %opt) = @_;
+ my $conf = new FS::Conf;
+ return { 'error' => 'Incorrect shared secret' }
+ unless $opt{secret} eq $conf->config('api_shared_secret');
+
+ $class->_by_phonenum('insert_payment', %opt);
+
+}
+
+sub _by_phonenum {
+ my($class, $method, %opt) = @_;
+ my $conf = new FS::Conf;
+ return { 'error' => 'Incorrect shared secret' }
+ unless $opt{secret} eq $conf->config('api_shared_secret');
+
+ my $phonenum = delete $opt{'phonenum'};
+
+ my $svc_phone = qsearchs('svc_phone', { 'phonenum' => $phonenum } )
+ or return { 'error' => 'Unknown phonenum' };
+
+ my $cust_pkg = $svc_phone->cust_svc->cust_pkg
+ or return { 'error' => 'Unlinked phonenum' };
+
+ $opt{'custnum'} = $cust_pkg->custnum;
+
+ $class->$method(%opt);
+
+}
+
+=item insert_credit
+
+Example:
+
+ my $result = FS::API->insert_credit(
+ 'secret' => 'sharingiscaring',
+ 'custnum' => 181318,
+ 'amount' => '54.32',
+
+ #optional
+ '_date' => 1397977200, #UNIX timestamp
+ );
+
+ if ( $result->{'error'} ) {
+ die $result->{'error'};
+ } else {
+ #credit was inserted
+ print "crednum ". $result->{'crednum'};
+ }
+
+=cut
+
+#Enter credit
+sub insert_credit {
+ my($class, %opt) = @_;
+ my $conf = new FS::Conf;
+ return { 'error' => 'Incorrect shared secret' }
+ unless $opt{secret} eq $conf->config('api_shared_secret');
+
+ $opt{'reasonnum'} ||= $conf->config('api_credit_reason');
+
+ #less "raw" than this? we are the backoffice API, and aren't worried
+ # about version migration ala cust_main/cust_location here
+ my $cust_credit = new FS::cust_credit { %opt };
+ my $error = $cust_credit->insert;
+ return { 'error' => $error,
+ 'crednum' => $cust_credit->crednum,
+ };
+}
+
+# pass the phone number ( from svc_phone )
+sub insert_credit_phonenum {
+ my($class, %opt) = @_;
+ my $conf = new FS::Conf;
+ return { 'error' => 'Incorrect shared secret' }
+ unless $opt{secret} eq $conf->config('api_shared_secret');
+
+ $class->_by_phonenum('insert_credit', %opt);
+
+}
+
+=item insert_refund
+
+Example:
+
+ my $result = FS::API->insert_refund(
+ 'secret' => 'sharingiscaring',
+ 'custnum' => 181318,
+ 'payby' => 'CASH',
+ 'refund' => '54.32',
+
+ #optional
+ '_date' => 1397977200, #UNIX timestamp
+ );
+
+ if ( $result->{'error'} ) {
+ die $result->{'error'};
+ } else {
+ #refund was inserted
+ print "refundnum ". $result->{'crednum'};
+ }
+
+=cut
+
+#Enter cash refund.
+sub insert_refund {
+ my($class, %opt) = @_;
+ my $conf = new FS::Conf;
+ return { 'error' => 'Incorrect shared secret' }
+ unless $opt{secret} eq $conf->config('api_shared_secret');
+
+ # when github pull request #24 is merged,
+ # will have to change over to default reasonnum like credit
+ # but until then, this will do
+ $opt{'reason'} ||= 'API refund';
+
+ #less "raw" than this? we are the backoffice API, and aren't worried
+ # about version migration ala cust_main/cust_location here
+ my $cust_refund = new FS::cust_refund { %opt };
+ my $error = $cust_refund->insert;
+ return { 'error' => $error,
+ 'refundnum' => $cust_refund->refundnum,
+ };
+}
+
+# pass the phone number ( from svc_phone )
+sub insert_refund_phonenum {
+ my($class, %opt) = @_;
+ my $conf = new FS::Conf;
+ return { 'error' => 'Incorrect shared secret' }
+ unless $opt{secret} eq $conf->config('api_shared_secret');
+
+ $class->_by_phonenum('insert_refund', %opt);
+
+}
#---
diff --git a/FS/FS/Conf.pm b/FS/FS/Conf.pm
index ccf8752..34254c6 100644
--- a/FS/FS/Conf.pm
+++ b/FS/FS/Conf.pm
@@ -2920,6 +2920,7 @@ and customer address. Include units.',
'section' => 'self-service',
'description' => 'Suspend reason when customers suspend their own packages. Set to nothing to disallow self-suspension.',
'type' => 'select-sub',
+ #false laziness w/api_credit_reason
'options_sub' => sub { require FS::Record;
require FS::reason;
my $type = qsearchs('reason_type',
@@ -5627,6 +5628,31 @@ and customer address. Include units.',
# 'type' => 'checkbox',
# },
+ {
+ 'key' => 'api_credit_reason',
+ 'section' => 'API',
+ 'description' => 'Default reason for back-office API credits',
+ 'type' => 'select-sub',
+ #false laziness w/api_credit_reason
+ 'options_sub' => sub { require FS::Record;
+ require FS::reason;
+ my $type = qsearchs('reason_type',
+ { class => 'R' })
+ or return ();
+ map { $_->reasonnum => $_->reason }
+ FS::Record::qsearch('reason',
+ { reason_type => $type->typenum }
+ );
+ },
+ 'option_sub' => sub { require FS::Record;
+ require FS::reason;
+ my $reason = FS::Record::qsearchs(
+ 'reason', { 'reasonnum' => shift }
+ );
+ $reason ? $reason->reason : '';
+ },
+ },
+
{ key => "apacheroot", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
{ key => "apachemachine", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
{ key => "apachemachines", section => "deprecated", description => "<b>DEPRECATED</b>", type => "text" },
diff --git a/bin/xmlrpc-insert_credit_phonenum b/bin/xmlrpc-insert_credit_phonenum
new file mode 100755
index 0000000..a8774a4
--- /dev/null
+++ b/bin/xmlrpc-insert_credit_phonenum
@@ -0,0 +1,25 @@
+#!/usr/bin/perl
+
+use strict;
+use Frontier::Client;
+use Data::Dumper;
+
+my $uri = new URI 'http://localhost:8008/';
+
+my $server = new Frontier::Client ( 'url' => $uri );
+
+my $result = $server->call(
+ 'FS.API.insert_credit_phonenum',
+ 'secret' => 'sharingiscaring',
+ 'phonenum' => '3125550001',
+ 'amount' => '54.32',
+
+ #optional
+ '_date' => 1397977200, #UNIX timestamp
+);
+
+#die $result->{'error'} if $result->{'error'};
+
+print Dumper($result);
+
+1;
diff --git a/bin/xmlrpc-insert_payment b/bin/xmlrpc-insert_payment
new file mode 100755
index 0000000..a0d60fd
--- /dev/null
+++ b/bin/xmlrpc-insert_payment
@@ -0,0 +1,26 @@
+#!/usr/bin/perl
+
+use strict;
+use Frontier::Client;
+use Data::Dumper;
+
+my $uri = new URI 'http://localhost:8008/';
+
+my $server = new Frontier::Client ( 'url' => $uri );
+
+my $result = $server->call(
+ 'FS.API.insert_payment',
+ 'secret' => 'sharingiscaring',
+ 'custnum' => 181318,
+ 'payby' => 'CASH',
+ 'paid' => '54.32',
+
+ #optional
+ '_date' => 1397977200, #UNIX timestamp
+);
+
+#die $result->{'error'} if $result->{'error'};
+
+print Dumper($result);
+
+1;
diff --git a/bin/xmlrpc-insert_payment_phonenum b/bin/xmlrpc-insert_payment_phonenum
new file mode 100755
index 0000000..21f01f0
--- /dev/null
+++ b/bin/xmlrpc-insert_payment_phonenum
@@ -0,0 +1,26 @@
+#!/usr/bin/perl
+
+use strict;
+use Frontier::Client;
+use Data::Dumper;
+
+my $uri = new URI 'http://localhost:8008/';
+
+my $server = new Frontier::Client ( 'url' => $uri );
+
+my $result = $server->call(
+ 'FS.API.insert_payment_phonenum',
+ 'secret' => 'sharingiscaring',
+ 'phonenum' => '3125550001',
+ 'payby' => 'CASH',
+ 'paid' => '54.32',
+
+ #optional
+ '_date' => 1397977200, #UNIX timestamp
+);
+
+#die $result->{'error'} if $result->{'error'};
+
+print Dumper($result);
+
+1;
diff --git a/bin/xmlrpc-insert_refund_phonenum b/bin/xmlrpc-insert_refund_phonenum
new file mode 100755
index 0000000..bdcd504
--- /dev/null
+++ b/bin/xmlrpc-insert_refund_phonenum
@@ -0,0 +1,26 @@
+#!/usr/bin/perl
+
+use strict;
+use Frontier::Client;
+use Data::Dumper;
+
+my $uri = new URI 'http://localhost:8008/';
+
+my $server = new Frontier::Client ( 'url' => $uri );
+
+my $result = $server->call(
+ 'FS.API.insert_refund_phonenum',
+ 'secret' => 'sharingiscaring',
+ 'phonenum' => '3125550001',
+ 'payby' => 'CASH',
+ 'refund' => '54.32',
+
+ #optional
+ '_date' => 1397977200, #UNIX timestamp
+);
+
+#die $result->{'error'} if $result->{'error'};
+
+print Dumper($result);
+
+1;
-----------------------------------------------------------------------
Summary of changes:
FS/FS/API.pm | 182 +++++++++++++++++++-
FS/FS/Conf.pm | 26 +++
...customer_info => xmlrpc-insert_credit_phonenum} | 10 +-
...{xmlrpc-customer_info => xmlrpc-insert_payment} | 7 +-
...ustomer_info => xmlrpc-insert_payment_phonenum} | 11 +-
...customer_info => xmlrpc-insert_refund_phonenum} | 11 +-
6 files changed, 232 insertions(+), 15 deletions(-)
copy bin/{xmlrpc-customer_info => xmlrpc-insert_credit_phonenum} (59%)
copy bin/{xmlrpc-customer_info => xmlrpc-insert_payment} (70%)
copy bin/{xmlrpc-customer_info => xmlrpc-insert_payment_phonenum} (55%)
copy bin/{xmlrpc-customer_info => xmlrpc-insert_refund_phonenum} (55%)
More information about the freeside-commits
mailing list