X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2FAPI.pm;h=91d0a9bce03d512f08010f7dc229a06dfcdec660;hb=618c671fd12beb2122a4c32c0042546a19a9c765;hp=047bb4e6046bab660ce0bf0caf74cc67033cee65;hpb=b569c819b7acbdd91f31621ac04cbc3c9645c7eb;p=freeside.git diff --git a/FS/FS/API.pm b/FS/FS/API.pm index 047bb4e60..91d0a9bce 100644 --- a/FS/FS/API.pm +++ b/FS/FS/API.pm @@ -372,6 +372,23 @@ Used for determining FCC 477 reporting Used for determining FCC 477 reporting +=item ship_address1 + +=item ship_address2 + +=item ship_city + +=item ship_county + +=item ship_state + +=item ship_zip + +=item ship_country + +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 @@ -432,7 +449,7 @@ sub new_customer { #same for refnum like signup_server-default_refnum $opt{refnum} ||= FS::Conf->new->config('signup_server-default_refnum'); - $class->API_insert( %opt ); + FS::cust_main->API_insert( %opt ); } =item update_customer @@ -556,6 +573,104 @@ Example: print Dumper($result); +Returns the following fields: + +=over 4 + +=item error + +Empty, or error message (in which case, none of the other fields will be populated) + +=item display_custnum + +Optional customer number display override - if present, use this for all UI instead of the real database custnum + +=item name + +Simple string for customer identification (from first, last, company) + +=item balance + +=item status + +=item statuscolor + +=item first + +=item last + +=item company + +=item daytime + +=item night + +=item mobile + +=item fax + +=item agentnum + +Agent (Company) + +=item salesnum + +Sales person + +=item refnum + +Advertising channel + +=item classnum + +Customer class + +=item usernum + +Employee (initial customer insert) + +=item referral_custnum + +Referring customer + +=item address1 + +=item address2 + +=item city + +=item county + +=item state + +=item zip + +=item country + +=item ship_address1 + +=item ship_address2 + +=item ship_city + +=item ship_county + +=item ship_state + +=item ship_zip + +=item ship_country + +=item invoicing_list + +Comma-separated list of email addresses + +=item postal_invoicing + +0 or 1 + +=back + =cut sub customer_info { @@ -650,6 +765,102 @@ sub location_info { return \%return; } +=item list_customer_packages OPTION => VALUE, ... + +Lists all customer packages. + +=over + +=item secret + +API Secret + +=item custnum + +Customer Number + +=back + +Example: + + my $result = FS::API->list_packages( + 'secret' => 'sharingiscaring', + 'custnum' => custnum, + ); + + if ( $result->{'error'} ) { + die $result->{'error'}; + } else { + # list packages returns an array of hashes for packages ordered by custnum and pkgnum. + print Dumper($result->{'pkgs'}); + } + +=cut + +sub list_customer_packages { + my( $class, %opt ) = @_; + return _shared_secret_error() unless _check_shared_secret($opt{secret}); + + my $sql_query = FS::cust_pkg->search({ 'custnum' => $opt{custnum}, }); + + $sql_query->{order_by} = 'ORDER BY custnum, pkgnum'; + + my @packages = qsearch($sql_query) + or return { 'error' => 'No packages' }; + + my $return = { + 'packages' => [ map $_->hashref, @packages ], + }; + + $return; +} + +=item package_status OPTION => VALUE, ... + +Get package status. + +=over + +=item secret + +API Secret + +=item pkgnum + +Package Number + +=back + +Example: + + my $result = FS::API->package_status( + 'secret' => 'sharingiscaring', + 'pkgnum' => pkgnum, + ); + + if ( $result->{'error'} ) { + die $result->{'error'}; + } else { + # package status returns a hash with the status for a package. + print Dumper($result->{'status'}); + } + +=cut + +sub package_status { + my( $class, %opt ) = @_; + return _shared_secret_error() unless _check_shared_secret($opt{secret}); + + my $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $opt{pkgnum} } ) + or return { 'error' => 'No packages' }; + + my $return = { + 'status' => $cust_pkg->status, + }; + + $return; +} + =item order_package OPTION => VALUE, ... Orders a new customer package. Takes a list of keys and values as paramaters @@ -731,6 +942,9 @@ sub order_package { or ( length($r) && $r != $part_pkg->option('recur_fee') ) ) { + + local($FS::part_pkg::skip_pkg_svc_hack) = 1; + my $custom_part_pkg = $part_pkg->clone; $custom_part_pkg->disabled('Y'); my %options = $part_pkg->options; @@ -738,7 +952,18 @@ sub order_package { $options{'recur_fee'} = $r if length($r); my $error = $custom_part_pkg->insert( options=>\%options ); return ( 'error' => "error customizing package: $error" ) if $error; + + #not ->pkg_svc, we want to ignore links and clone the actual package def + foreach my $pkg_svc ( $part_pkg->_pkg_svc ) { + my $c_pkg_svc = new FS::pkg_svc { $pkg_svc->hash }; + $c_pkg_svc->pkgsvcnum(''); + $c_pkg_svc->pkgpart( $custom_part_pkg->pkgpart ); + my $error = $c_pkg_svc->insert; + return "error customizing package: $error" if $error; + } + $cust_pkg->pkgpart( $custom_part_pkg->pkgpart ); + } my %order_pkg = ( 'cust_pkg' => $cust_pkg );