summaryrefslogtreecommitdiffstats
path: root/lib/WWW/YNAB/ScheduledSubTransaction.pm
diff options
context:
space:
mode:
Diffstat (limited to 'lib/WWW/YNAB/ScheduledSubTransaction.pm')
-rw-r--r--lib/WWW/YNAB/ScheduledSubTransaction.pm50
1 files changed, 50 insertions, 0 deletions
diff --git a/lib/WWW/YNAB/ScheduledSubTransaction.pm b/lib/WWW/YNAB/ScheduledSubTransaction.pm
index d275f4d..690cdd6 100644
--- a/lib/WWW/YNAB/ScheduledSubTransaction.pm
+++ b/lib/WWW/YNAB/ScheduledSubTransaction.pm
@@ -1,5 +1,27 @@
package WWW::YNAB::ScheduledSubTransaction;
+
use Moose;
+# ABSTRACT: ScheduledSubTransaction model object
+
+=head1 SYNOPSIS
+
+ use WWW::YNAB;
+
+ my $ynab = WWW::YNAB->new(...);
+ my @budgets = $ynab->budgets;
+ my $scheduled_transaction = $budgets[0]->scheduled_transaction('12345678-1234-1234-1234-1234567890ab');
+ my @scheduled_sub_transactions = $scheduled_transaction->subtransactions;
+
+=head1 OVERVIEW
+
+See L<https://api.youneedabudget.com/v1#/Scheduled_Transactions> for more
+information.
+
+=cut
+
+=method id
+
+=cut
has id => (
is => 'ro',
@@ -7,36 +29,64 @@ has id => (
required => 1,
);
+=method scheduled_transaction_id
+
+=cut
+
has scheduled_transaction_id => (
is => 'ro',
isa => 'Str',
);
+=method amount
+
+=cut
+
has amount => (
is => 'ro',
isa => 'Int',
);
+=method memo
+
+=cut
+
has memo => (
is => 'ro',
isa => 'Maybe[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 deleted
+
+=cut
+
has deleted => (
is => 'ro',
isa => 'Bool',