use FS::cust_credit;
use FS::cust_refund;
use FS::cust_pkg;
+use FS::cust_contact;
=head1 NAME
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
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
A single string for just one detail line, or an array reference of one or more
lines of detail
+=back
+
=cut
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;
$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 );
}
+=item email_optout OPTION => VALUE, ...
+
+Each e-mail address, or L<FS::cust_contact> record, has two opt-in flags:
+message_dest: recieve non-invoicing messages, and invoice_dest: recieve
+invoicing messages
+
+Use this API call to remove opt-in flags for an e-mail address
+
+=over 4
+
+=item address
+
+E-Mail address
+
+=item disable_message_dest
+
+Enabled by default:
+Set this parameter as 0 in your API call to leave the message_dest flag as is
+
+=item disable_invoice_dest
+
+Enabled by default:
+Set this parameter as 0 in your API call to leave the invoice_dest flag as is
+
+=back
+
+=cut
+
+sub email_opt_out {
+ my ($class, %opt) = @_;
+
+ return _shared_secret_error()
+ unless _check_shared_secret($opt{secret});
+
+ return {error => 'No e-mail address specified'}
+ unless $opt{address} && $opt{address} =~ /\@/;
+
+ $opt{disable_message_dest} ||= 1;
+ $opt{disable_invoice_dest} ||= 1;
+
+ my $address = FS::Record::dbh->quote($opt{address});
+
+ for my $cust_contact (
+ FS::Record::qsearch({
+ table => 'cust_contact',
+ select => 'cust_contact.*',
+ addl_from => 'LEFT JOIN contact_email USING (contactnum)',
+ extra_sql => "WHERE contact_email.emailaddress = $address",
+ })
+ ) {
+ $cust_contact->set(invoice_dest => '') if $opt{disable_invoice_dest};
+ $cust_contact->set(message_dest => '') if $opt{disable_message_dest};
+
+ my $error = $cust_contact->replace();
+ return {error => $error} if $error;
+ }
+ return;
+}
+
+
##
# helper subroutines
##
return { 'error' => 'Incorrect shared secret' };
}
+
+=back
+
+=cut
+
1;