summaryrefslogtreecommitdiffstats
path: root/lib/WWW/YNAB/Month.pm
diff options
context:
space:
mode:
Diffstat (limited to 'lib/WWW/YNAB/Month.pm')
-rw-r--r--lib/WWW/YNAB/Month.pm36
1 files changed, 36 insertions, 0 deletions
diff --git a/lib/WWW/YNAB/Month.pm b/lib/WWW/YNAB/Month.pm
index 3680e18..c09ecd1 100644
--- a/lib/WWW/YNAB/Month.pm
+++ b/lib/WWW/YNAB/Month.pm
@@ -1,5 +1,25 @@
package WWW::YNAB::Month;
+
use Moose;
+# ABSTRACT: Month model object
+
+=head1 SYNOPSIS
+
+ use WWW::YNAB;
+
+ my $ynab = WWW::YNAB->new(...);
+ my @budgets = $ynab->budgets;
+ my $month = $budgets[0]->month('2018-06-01');
+
+=head1 OVERVIEW
+
+See L<https://api.youneedabudget.com/v1#/Months> for more information.
+
+=cut
+
+=method month
+
+=cut
has month => (
is => 'ro',
@@ -7,21 +27,37 @@ has month => (
required => 1,
);
+=method note
+
+=cut
+
has note => (
is => 'ro',
isa => 'Maybe[Str]',
);
+=method to_be_budgeted
+
+=cut
+
has to_be_budgeted => (
is => 'ro',
isa => 'Maybe[Int]',
);
+=method age_of_money
+
+=cut
+
has age_of_money => (
is => 'ro',
isa => 'Maybe[Int]',
);
+=method categories
+
+=cut
+
has categories => (
traits => ['Array'],
is => 'bare',