=head1 NAME
Net::Simplify::Deposit - A Simplify Commerce Deposit object
=head1 SYNOPSIS
use Net::Simplify;
$Net::Simplify::public_key = 'YOUR PUBLIC KEY';
$Net::Simplify::private_key = 'YOUR PRIVATE KEY';
# Retrieve a Deposit given its ID.
my $deposit = Net::Simplify::Deposit->find('a7e41');
# Retrieve a list of objects
my $deposits = Net::Simplify::Deposit->list({max => 10});
foreach my $v ($deposits->list) {
# ...
}
=head1 DESCRIPTION
=head2 METHODS
=head3 list(%criteria, $auth)
Retrieve a list of C<Net::Simplify::Deposit> objects. The parameters are:
=over 4
=item C<%criteria>
Hash map representing the criteria to limit the results of the list operation. Valid keys are:
=over 4
=item C<filter>
Filters to apply to the list.
=item C<max>
Allows up to a max of 50 list items to return. [max value: 50, default: 20]
=item C<offset>
Used in paging of the list. This is the start offset of the page. [default: 0]
=item C<sorting>
Allows for ascending or descending sorting of the list.
The value maps properties to the sort direction (either C<asc> for ascending or C<desc> for descending). Sortable properties are:
=over 4
=item C<amount>
=item C<dateCreated>
=item C<depositDate>
=back
=back
=back
=head3 find($id, $auth)
Retrieve a C<Net::Simplify::Deposit> object from the API. Parameters are:
=over 4
=item C<$id>
Identifier of the object to retrieve.
=item C<$auth>
Authentication object for accessing the API. If no value is passed the global keys
C<$Net::Simplify::public_key> and C<$Net::Simplify::private_key> are used.
=back
=head1 SEE ALSO
L<Net::Simplify>,
L<Net::Simplify::Domain>,
L<Net::Simplify::DomainList>,
L<Net::Simplify::Authentication>,
L<Net::Simplify::ApiException>,
=head1 VERSION
1.0.6
=head1 LICENSE
Copyright (c) 2013, 2014 MasterCard International Incorporated
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are
permitted provided that the following conditions are met:
Redistributions of source code must retain the above copyright notice, this list of
conditions and the following disclaimer.
Redistributions in binary form must reproduce the above copyright notice, this list of
conditions and the following disclaimer in the documentation and/or other materials
provided with the distribution.
Neither the name of the MasterCard International Incorporated nor the names of its
contributors may be used to endorse or promote products derived from this software
without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
=head1 SEE ALSO
=cut
use 5.006;
use strict;
use warnings FATAL => 'all';
our @ISA = qw(Net::Simplify::Domain);
sub list {
my ($class, $criteria, $auth) = @_;
$auth = Net::Simplify::SimplifyApi->get_authentication($auth);
my $result = Net::Simplify::SimplifyApi->send_api_request("deposit", 'list', $criteria, $auth);
Net::Simplify::DomainList->new($result, $class, $auth);
}
sub find {
my ($class, $id, $auth) = @_;
$auth = Net::Simplify::SimplifyApi->get_authentication($auth);
my $result = Net::Simplify::SimplifyApi->send_api_request("deposit", 'find', { id => $id }, $auth);
$class->SUPER::new($result, $auth);
}
1;