docs

1 files changed, 84 insertions, 0 deletions

diff --git a/lib/WWW/YNAB/Transaction.pm b/lib/WWW/YNAB/Transaction.pm
index 8fa1cc5..74a6764 100644
--- a/lib/WWW/YNAB/Transaction.pm
+++ b/lib/WWW/YNAB/Transaction.pm
@@ -1,89 +1,173 @@
 package WWW::YNAB::Transaction;
+
 use Moose;
+# ABSTRACT: Transaction model object
 
 use Moose::Util::TypeConstraints qw(enum maybe_type);
 
+=head1 SYNOPSIS
+
+  use WWW::YNAB;
+
+  my $ynab = WWW::YNAB->new(...);
+  my @budgets = $ynab->budgets;
+  my $transaction = $budgets[0]->transaction('12345678-1234-1234-1234-1234567890ab');
+
+=head1 OVERVIEW
+
+See L<https://api.youneedabudget.com/v1#/Transactions> for more information.
+
+=cut
+
+=method id
+
+=cut
+
 has id => (
     is       => 'ro',
     isa      => 'Str',
     required => 1,
 );
 
+=method date
+
+=cut
+
 has date => (
     is  => 'ro',
     isa => 'Str',
 );
 
+=method amount
+
+=cut
+
 has amount => (
     is  => 'ro',
     isa => 'Int',
 );
 
+=method memo
+
+=cut
+
 has memo => (
     is  => 'ro',
     isa => 'Maybe[Str]',
 );
 
+=method cleared
+
+=cut
+
 has cleared => (
     is  => 'ro',
     isa => enum([qw(cleared uncleared reconciled)]),
 );
 
+=method approved
+
+=cut
+
 has approved => (
     is  => 'ro',
     isa => 'Bool',
 );
 
+=method flag_color
+
+=cut
+
 has flag_color => (
     is  => 'ro',
     isa => maybe_type(enum([qw(red orange yellow green blue purple)])),
 );
 
+=method account_id
+
+=cut
+
 has account_id => (
     is  => 'ro',
     isa => 'Str',
 );
 
+=method payee_id
+
+=cut
+
 has payee_id => (
     is  => 'ro',
     isa => 'Maybe[Str]',
 );
 
+=method category_id
+
+=cut
+
 has category_id => (
     is  => 'ro',
     isa => 'Maybe[Str]',
 );
 
+=method transfer_account_id
+
+=cut
+
 has transfer_account_id => (
     is  => 'ro',
     isa => 'Maybe[Str]',
 );
 
+=method import_id
+
+=cut
+
 has import_id => (
     is  => 'ro',
     isa => 'Maybe[Str]',
 );
 
+=method deleted
+
+=cut
+
 has deleted => (
     is  => 'ro',
     isa => 'Bool',
 );
 
+=method account_name
+
+=cut
+
 has account_name => (
     is  => 'ro',
     isa => 'Str',
 );
 
+=method payee_name
+
+=cut
+
 has payee_name => (
     is  => 'ro',
     isa => 'Maybe[Str]',
 );
 
+=method category_name
+
+=cut
+
 has category_name => (
     is  => 'ro',
     isa => 'Maybe[Str]',
 );
 
+=method subtransactions
+
+=cut
+
 has subtransactions => (
     traits  => ['Array'],
     is      => 'bare',