Business-GoCardless

 view release on metacpan or  search on metacpan

lib/Business/GoCardless/BillingRequestTemplate.pm  view on Meta::CPAN

=head1 Operations on a billing request template

=head2 update

Update the template, this affects all future billing requests created from it:

    $Template->update( name => 'New name' );

=cut

sub update { shift->_update( @_ ); }

=head1 AUTHOR

Lee Johnson - C<lee@payprop.com>

This library is free software; you can redistribute it and/or modify it under
the same terms as Perl itself. If you would like to contribute documentation,
features, bug fixes, or anything else then please raise an issue / pull request:

    https://github.com/payprop/business-gocardless

lib/Business/GoCardless/Creditor.pm  view on Meta::CPAN

=head1 Operations on a creditor

=head2 update

Update the creditor:

    $Creditor->update( name => 'New name' );

=cut

sub update { shift->_update( @_ ); }

=head1 AUTHOR

Lee Johnson - C<lee@payprop.com>

This library is free software; you can redistribute it and/or modify it under
the same terms as Perl itself. If you would like to contribute documentation,
features, bug fixes, or anything else then please raise an issue / pull request:

    https://github.com/payprop/business-gocardless

lib/Business/GoCardless/Customer.pm  view on Meta::CPAN

=head2 remove

Remove the customer, which removes all of their personal data. B<This cannot
be undone>, and the customer must not have any active mandates:

    $Customer->remove;

=cut

sub update { shift->_update( @_ ); }
sub remove { shift->_delete; }

# BACK COMPATIBILITY METHODS
sub first_name { shift->given_name; }
sub last_name  { shift->family_name; }

=head1 AUTHOR

Lee Johnson - C<lee@payprop.com>

lib/Business/GoCardless/CustomerBankAccount.pm  view on Meta::CPAN

=head2 disable

Disable the bank account, B<this immediately cancels all associated mandates
and cancellable payments>:

    $BankAccount->disable;

=cut

sub update  { shift->_update( @_ ); }
sub disable { shift->_action( 'disable',@_ ); }

=head1 Links

Shortcut methods to get the IDs of the linked resources

    customer_id

=cut

lib/Business/GoCardless/InstalmentSchedule.pm  view on Meta::CPAN

    $Schedule->update( metadata => { ... } );

=head2 cancel

Cancel the instalment schedule, cancelling any payments not yet submitted:

    $Schedule->cancel;

=cut

sub update { shift->_update( @_ ); }
sub cancel { shift->_action( 'cancel',@_ ); }

=head1 Status checks on an instalment schedule

    pending
    active
    creation_failed
    completed
    cancelled
    errored

lib/Business/GoCardless/Mandate.pm  view on Meta::CPAN

Returns the (updated) Mandate object. note that you can only update the metadata on a mandate, so you must pass the params
hash as something that looks like:

    %params = ( metadata => { ... } );

=cut

sub cancel    { shift->_action( 'cancel',@_ ); }
sub reinstate { shift->_action( 'reinstate',@_ ); }
sub update    { shift->_update( @_ ); }

=head1 Status checks on a mandate

    pending_customer_approval
    pending_submission
    submitted
    active
    failed
    cancelled
    expired

lib/Business/GoCardless/OutboundPayment.pm  view on Meta::CPAN

    $OutboundPayment->approve;

=head2 cancel

Cancel the outbound payment (only possible before it is C<executing>):

    $OutboundPayment->cancel;

=cut

sub update  { shift->_update( @_ ); }
sub approve { shift->_action( 'approve',@_ ); }
sub cancel  { shift->_action( 'cancel',@_ ); }

=head1 Status checks on an outbound payment

    verifying
    pending_approval
    scheduled
    executing
    executed

lib/Business/GoCardless/Payment.pm  view on Meta::CPAN

total_amount_confirmation is a safety check used by GoCardless to prevent
accidental duplicate refunds - it is the total amount refunded on the payment
once this refund is applied. If the payment object is stale (i.e. another refund
has since been made) then GoCardless will reject the refund.

=cut

sub retry  { shift->_action( 'retry',@_ ); }
sub cancel { shift->_action( 'cancel',@_ ); }
sub update { shift->_update( @_ ); }

sub refund {
    my ( $self,%params ) = @_;

    # no default for the amount, we don't want to refund anything by accident
    Business::GoCardless::Exception->throw({
        message => "amount is required for ->refund",
    }) if ! defined( $params{amount} );

    my $already_refunded = $self->amount_refunded // 0;

lib/Business/GoCardless/Payout.pm  view on Meta::CPAN

=head1 Operations on a payout

=head2 update

Update the payout's metadata (Pro API only), returns the updated Payout object:

    $Payout->update( metadata => { ... } );

=cut

sub update { shift->_update( @_ ); }

=head1 AUTHOR

Lee Johnson - C<lee@payprop.com>

This library is free software; you can redistribute it and/or modify it under
the same terms as Perl itself. If you would like to contribute documentation,
features, bug fixes, or anything else then please raise an issue / pull request:

    https://github.com/payprop/business-gocardless

lib/Business/GoCardless/Refund.pm  view on Meta::CPAN

=head1 Operations on a refund

=head2 update

Update the refund's metadata, returns the updated Refund object:

    $Refund->update( metadata => { ... } );

=cut

sub update { shift->_update( @_ ); }

=head1 Status checks on a refund

    created
    pending_submission
    submitted
    paid
    cancelled
    bounced
    funds_returned

lib/Business/GoCardless/Subscription.pm  view on Meta::CPAN

sub cancel {
    my ( $self,%params ) = @_;

    if ( $self->client->api_version > 1 ) {
        return $self->_action( 'cancel',%params );
    } else {
        return $self->_operation( 'cancel','api_put' );
    }
}

sub update { shift->_update( @_ ); }
sub pause  { shift->_action( 'pause',@_ ); }
sub resume { shift->_action( 'resume',@_ ); }

=head1 Status checks on a subscription

    pending_customer_approval
    customer_approval_denied
    inactive
    active
    finished