Difference between revisions of "Freeside:4:Documentation:Developer/FS/prepay credit"

Latest revision as of 07:27, 18 November 2015

NAME

FS::prepay_credit - Object methods for prepay_credit records

SYNOPSIS

 use FS::prepay_credit;

 $record = new FS::prepay_credit \%hash;
 $record = new FS::prepay_credit {
   'identifier' => '4198123455512121'
   'amount'     => '19.95',
 };

 $record = new FS::prepay_credit {
   'identifier' => '4198123455512121'
   'seconds'    => '7200',
 };


 $error = $record->insert;

 $error = $new_record->replace($old_record);

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::prepay_credit object represents a pre-paid card. FS::prepay_credit inherits from FS::Record. The following fields are currently supported:

field - description; identifier - identifier entered by the user to receive the credit; amount - amount of the credit; seconds - time amount of credit (see "seconds" in FS::svc acct|FS::svc_acct#seconds|"seconds" in FS::svc_acct); agentnum - optional agent (see FS::agent) for this prepaid card

METHODS

new HASHREF

Creates a new pre-paid credit. To add the pre-paid credit to the database, see "insert".

Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the hash method.

insert

Adds this record to the database. If there is an error, returns the error, otherwise returns false.

delete

Delete this record from the database.

replace OLD_RECORD

Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.

check

Checks all fields to make sure this is a valid pre-paid credit. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

agent

Returns the agent (see FS::agent) for this prepaid card, if any.

SUBROUTINES

generate NUM TYPE LENGTH HASHREF

Generates the specified number of prepaid cards. Returns an array reference of the newly generated card identifiers, or a scalar error message.

BUGS

SEE ALSO

FS::svc_acct, FS::Record, schema.html from the base documentation.

POD ERRORS

Hey! The above document had some coding errors, which are explained below:

Around line 197:

You forgot a '=back' before '=head1'