X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2FAPI.pm;h=6e09713b23f15cd5c6b1411c3e597baa059104d6;hb=5f7c4a6025b9e3a49bee72dbc06cac37a45e6f10;hp=77ae03b10e746f005b64c08ce7da171e675b3d88;hpb=b7f8a7cfd566881a6d89117d17e391ceb58097d4;p=freeside.git diff --git a/FS/FS/API.pm b/FS/FS/API.pm index 77ae03b10..6e09713b2 100644 --- a/FS/FS/API.pm +++ b/FS/FS/API.pm @@ -16,7 +16,20 @@ FS::API - Freeside backend API =head1 SYNOPSIS - use FS::API; + use Frontier::Client; + use Data::Dumper; + + my $url = new URI 'http://localhost:8008/'; #or if accessing remotely, secure + # the traffic + + my $xmlrpc = new Frontier::Client url=>$url; + + my $result = $xmlrpc->call( 'FS.API.customer_info', + 'secret' => 'sharingiscaring', + 'custnum' => 181318, + ); + + print Dumper($result); =head1 DESCRIPTION @@ -66,6 +79,10 @@ Amount paid Option date for payment +=item order_number + +Optional order number + =back Example: @@ -78,6 +95,7 @@ Example: #optional '_date' => 1397977200, #UNIX timestamp + 'order_number' => '12345', ); if ( $result->{'error'} ) { @@ -520,6 +538,23 @@ sub update_customer { Returns general customer information. Takes a list of keys and values as parameters with the following keys: custnum, secret +Example: + + use Frontier::Client; + use Data::Dumper; + + my $url = new URI 'http://localhost:8008/'; #or if accessing remotely, secure + # the traffic + + my $xmlrpc = new Frontier::Client url=>$url; + + my $result = $xmlrpc->call( 'FS.API.customer_info', + 'secret' => 'sharingiscaring', + 'custnum' => 181318, + ); + + print Dumper($result); + =cut sub customer_info { @@ -532,6 +567,63 @@ sub customer_info { $cust_main->API_getinfo; } +=item customer_list_svcs OPTION => VALUE, ... + +Returns customer service information. Takes a list of keys and values as +parameters with the following keys: custnum, secret + +Example: + + use Frontier::Client; + use Data::Dumper; + + my $url = new URI 'http://localhost:8008/'; #or if accessing remotely, secure + # the traffic + + my $xmlrpc = new Frontier::Client url=>$url; + + my $result = $xmlrpc->call( 'FS.API.customer_list_svcs', + 'secret' => 'sharingiscaring', + 'custnum' => 181318, + ); + + print Dumper($result); + + foreach my $cust_svc ( @{ $result->{'cust_svc'} } ) { + #print $cust_svc->{mac_addr}."\n" if exists $cust_svc->{mac_addr}; + print $cust_svc->{circuit_id}."\n" if exists $cust_svc->{circuit_id}; + } + +=cut + +sub customer_list_svcs { + my( $class, %opt ) = @_; + return _shared_secret_error() unless _check_shared_secret($opt{secret}); + + my $cust_main = qsearchs('cust_main', { 'custnum' => $opt{custnum} }) + or return { 'error' => 'Unknown custnum' }; + + #$cust_main->API_list_svcs; + + #false laziness w/ClientAPI/list_svcs + + my @cust_svc = (); + #my @cust_pkg_usage = (); + #foreach my $cust_pkg ( $p->{'ncancelled'} + # ? $cust_main->ncancelled_pkgs + # : $cust_main->unsuspended_pkgs ) { + foreach my $cust_pkg ( $cust_main->all_pkgs ) { + #next if $pkgnum && $cust_pkg->pkgnum != $pkgnum; + push @cust_svc, @{[ $cust_pkg->cust_svc ]}; #@{[ ]} to force array context + #push @cust_pkg_usage, $cust_pkg->cust_pkg_usage; + } + + return { + 'cust_svc' => [ map $_->API_getinfo, @cust_svc ], + }; + +} + =item location_info Returns location specific information for the customer. Takes a list of keys @@ -568,6 +660,8 @@ secret locationnum - pass this, or the following keys (don't pass both) +locationname + address1 address2 @@ -580,8 +674,22 @@ state zip +addr_clean + country +censustract + +censusyear + +location_type + +location_number + +location_kind + +incorporated + On error, returns a hashref with an 'error' key. On success, returns a hashref with 'pkgnum' and 'locationnum' keys, containing the new values. @@ -589,7 +697,7 @@ containing the new values. =cut sub change_package_location { - my $self = shift; + my $class = shift; my %opt = @_; return _shared_secret_error() unless _check_shared_secret($opt{'secret'}); @@ -597,13 +705,27 @@ sub change_package_location { or return { 'error' => 'Unknown pkgnum' }; my %changeopt; - $changeopt{'pkgnum'} = $pkgnum; - my $cust_location = FS::cust_location->new({ - 'custnum' => $cust_pkg->custnum, - %location_hash, - }); - $changeopt{'cust_location'} = $cust_location; + foreach my $field ( qw( + locationnum + locationname + address1 + address2 + city + county + state + zip + addr_clean + country + censustract + censusyear + location_type + location_number + location_kind + incorporated + )) { + $changeopt{$field} = $opt{$field} if $opt{$field}; + } $cust_pkg->API_change(%changeopt); } @@ -649,7 +771,205 @@ sub bill_now { } -#next.. Advertising sources? +#next.. Delete Advertising sources? + +=item list_advertising_sources OPTION => VALUE, ... + +Lists all advertising sources. + +=over + +=item secret + +API Secret + +=back + +Example: + + my $result = FS::API->list_advertising_sources( + 'secret' => 'sharingiscaring', + ); + + if ( $result->{'error'} ) { + die $result->{'error'}; + } else { + # list advertising sources returns an array of hashes for sources. + print Dumper($result->{'sources'}); + } + +=cut + +#list_advertising_sources +sub list_advertising_sources { + my( $class, %opt ) = @_; + return _shared_secret_error() unless _check_shared_secret($opt{secret}); + + my @sources = qsearch('part_referral', {}, '', "") + or return { 'error' => 'No referrals' }; + + my $return = { + 'sources' => [ map $_->hashref, @sources ], + }; + + $return; +} + +=item add_advertising_source OPTION => VALUE, ... + +Add a new advertising source. + +=over + +=item secret + +API Secret + +=item referral + +Referral name + +=item disabled + +Referral disabled, Y for disabled or nothing for enabled + +=item agentnum + +Agent ID number + +=item title + +External referral ID + +=back + +Example: + + my $result = FS::API->add_advertising_source( + 'secret' => 'sharingiscaring', + 'referral' => 'test referral', + + #optional + 'disabled' => 'Y', + 'agentnum' => '2', #agent id number + 'title' => 'test title', + ); + + if ( $result->{'error'} ) { + die $result->{'error'}; + } else { + # add_advertising_source returns new source upon success. + print Dumper($result); + } + +=cut + +#add_advertising_source +sub add_advertising_source { + my( $class, %opt ) = @_; + return _shared_secret_error() unless _check_shared_secret($opt{secret}); + + use FS::part_referral; + + my $new_source = $opt{source}; + + my $source = new FS::part_referral $new_source; + + my $error = $source->insert; + + my $return = {$source->hash}; + $return = { 'error' => $error, } if $error; + + $return; +} + +=item edit_advertising_source OPTION => VALUE, ... + +Edit a advertising source. + +=over + +=item secret + +API Secret + +=item refnum + +Referral number to edit + +=item source + +hash of edited source fields. + +=over + +=item referral + +Referral name + +=item disabled + +Referral disabled, Y for disabled or nothing for enabled + +=item agentnum + +Agent ID number + +=item title + +External referral ID + +=back + +=back + +Example: + + my $result = FS::API->edit_advertising_source( + 'secret' => 'sharingiscaring', + 'refnum' => '4', # referral number to edit + 'source' => { + #optional + 'referral' => 'test referral', + 'disabled' => 'Y', + 'agentnum' => '2', #agent id number + 'title' => 'test title', + } + ); + + if ( $result->{'error'} ) { + die $result->{'error'}; + } else { + # edit_advertising_source returns updated source upon success. + print Dumper($result); + } + +=cut + +#edit_advertising_source +sub edit_advertising_source { + my( $class, %opt ) = @_; + return _shared_secret_error() unless _check_shared_secret($opt{secret}); + + use FS::part_referral; + + my $refnum = $opt{refnum}; + my $source = $opt{source}; + + my $old = FS::Record::qsearchs('part_referral', {'refnum' => $refnum,}); + my $new = new FS::part_referral { $old->hash }; + + foreach my $key (keys %$source) { + $new->$key($source->{$key}); + } + + my $error = $new->replace; + + my $return = {$new->hash}; + $return = { 'error' => $error, } if $error; + + $return; +} ##