summaryrefslogtreecommitdiffstats
path: root/lib/WWW/YNAB/Payee.pm
diff options
context:
space:
mode:
Diffstat (limited to 'lib/WWW/YNAB/Payee.pm')
-rw-r--r--lib/WWW/YNAB/Payee.pm33
1 files changed, 33 insertions, 0 deletions
diff --git a/lib/WWW/YNAB/Payee.pm b/lib/WWW/YNAB/Payee.pm
index d25ef9e..443cf9e 100644
--- a/lib/WWW/YNAB/Payee.pm
+++ b/lib/WWW/YNAB/Payee.pm
@@ -1,5 +1,26 @@
package WWW::YNAB::Payee;
+
use Moose;
+# ABSTRACT: Payee model object
+
+=head1 SYNOPSIS
+
+ use WWW::YNAB;
+
+ my $ynab = WWW::YNAB->new(...);
+ my @budgets = $ynab->budgets;
+ my $payee = $budgets[0]->payee('12345678-1234-1234-1234-1234567890ab');
+
+=head1 OVERVIEW
+
+See L<https://api.youneedabudget.com/v1#/Payees> for more
+information.
+
+=cut
+
+=method id
+
+=cut
has id => (
is => 'ro',
@@ -7,16 +28,28 @@ has id => (
required => 1,
);
+=method name
+
+=cut
+
has name => (
is => 'ro',
isa => 'Str',
);
+=method transfer_account_id
+
+=cut
+
has transfer_account_id => (
is => 'ro',
isa => 'Maybe[Str]',
);
+=method deleted
+
+=cut
+
has deleted => (
is => 'ro',
isa => 'Bool',