diff options
author | Jesse Luehrs <doy@tozt.net> | 2018-06-24 13:08:41 -0400 |
---|---|---|
committer | Jesse Luehrs <doy@tozt.net> | 2018-06-24 13:08:41 -0400 |
commit | 02645507b1ae3d9422f453568f4e1a732e18f5e7 (patch) | |
tree | 8914335e4648eff56bbeaddf79c7d634271b1dee /lib/WWW/YNAB/Account.pm | |
parent | c1fb530eea90fcf7c1c294b44d6d833e4dbcd809 (diff) | |
download | www-ynab-02645507b1ae3d9422f453568f4e1a732e18f5e7.tar.gz www-ynab-02645507b1ae3d9422f453568f4e1a732e18f5e7.zip |
docs
Diffstat (limited to 'lib/WWW/YNAB/Account.pm')
-rw-r--r-- | lib/WWW/YNAB/Account.pm | 62 |
1 files changed, 56 insertions, 6 deletions
diff --git a/lib/WWW/YNAB/Account.pm b/lib/WWW/YNAB/Account.pm index 6ce05bc..3b61b9e 100644 --- a/lib/WWW/YNAB/Account.pm +++ b/lib/WWW/YNAB/Account.pm @@ -1,21 +1,49 @@ package WWW::YNAB::Account; + use Moose; +# ABSTRACT: Account model object use Moose::Util::TypeConstraints qw(enum); with 'WWW::YNAB::ModelHelpers'; +=head1 SYNOPSIS + + use WWW::YNAB; + + my $ynab = WWW::YNAB->new(...); + my @budgets = $ynab->budgets; + my $account = $budgets[0]->account('12345678-1234-1234-1234-1234567890ab'); + +=head1 OVERVIEW + +See L<https://api.youneedabudget.com/v1#/Accounts> for more information. + +=cut + +=method id + +=cut + has id => ( is => 'ro', isa => 'Str', required => 1, ); +=method name + +=cut + has name => ( is => 'ro', isa => 'Str', ); +=method type + +=cut + has type => ( is => 'ro', isa => enum([ @@ -25,47 +53,69 @@ has type => ( ]), ); +=method on_budget + +=cut + has on_budget => ( is => 'ro', isa => 'Bool', ); +=method closed + +=cut + has closed => ( is => 'ro', isa => 'Bool', ); +=method note + +=cut + has note => ( is => 'ro', isa => 'Maybe[Str]', ); +=method balance + +=cut + has balance => ( is => 'ro', isa => 'Int', ); +=method cleared_balance + +=cut + has cleared_balance => ( is => 'ro', isa => 'Int', ); +=method uncleared_balance + +=cut + has uncleared_balance => ( is => 'ro', isa => 'Int', ); +=method deleted + +=cut + has deleted => ( is => 'ro', isa => 'Bool', ); -has _ua => ( - is => 'ro', - isa => 'WWW::YNAB::UA', - required => 1, -); - __PACKAGE__->meta->make_immutable; no Moose; |