File Coverage

lib/Net/API/Stripe/Balance/Pending.pm
Criterion Covered Total %
statement 19 22 86.3
branch n/a
condition n/a
subroutine 7 10 70.0
pod 3 3 100.0
total 29 35 82.8


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## Stripe API - ~/lib/Net/API/Stripe/Balance/Pending.pm
3             ## Version v0.100.0
4             ## Copyright(c) 2019 DEGUEST Pte. Ltd.
5             ## Author: Jacques Deguest <jack@deguest.jp>
6             ## Created 2019/11/02
7             ## Modified 2020/05/15
8             ##
9             ##----------------------------------------------------------------------------
10             package Net::API::Stripe::Balance::Pending;
11             BEGIN
12             {
13 1     1   943 use strict;
  1         1  
  1         31  
14 1     1   9 use warnings;
  1         2  
  1         28  
15 1     1   5 use parent qw( Net::API::Stripe::Generic );
  1         2  
  1         4  
16 1     1   62 use vars qw( $VERSION );
  1         2  
  1         46  
17 1     1   34 our( $VERSION ) = 'v0.100.0';
18             };
19              
20 1     1   5 use strict;
  1         2  
  1         16  
21 1     1   4 use warnings;
  1         1  
  1         100  
22              
23 0     0 1   sub amount { return( shift->_set_get_number( 'amount', @_ ) ); }
24              
25 0     0 1   sub currency { return( shift->_set_get_scalar( 'currency', @_ ) ); }
26              
27 0     0 1   sub source_types { return( shift->_set_get_hash_as_object( 'source_types', 'Net::API::Stripe::Payment::Source::Types', @_ ) ); }
28              
29             1;
30              
31             __END__
32              
33             =encoding utf8
34              
35             =head1 NAME
36              
37             Net::API::Stripe::Balance::Pending - A Stripe Pending Fund Object
38              
39             =head1 SYNOPSIS
40              
41             my $pending = $stripe->balance->pending({
42             amount => 100000,
43             currency => 'jpy',
44             source_types =>
45             {
46             bank_account => 1000000,
47             card => 10000,
48             },
49             });
50              
51             =head1 VERSION
52              
53             v0.100.0
54              
55             =head1 DESCRIPTION
56              
57             This is called from L<Net::API::Stripe::Balance> by B<pending> method.
58              
59             =head1 CONSTRUCTOR
60              
61             =head2 new( %ARG )
62              
63             Creates a new L<Net::API::Stripe::Balance::Pending> object.
64             It may also take an hash like arguments, that also are method of the same name.
65              
66             =head1 METHODS
67              
68             =head2 amount integer
69              
70             Balance amount.
71              
72             =head2 currency currency
73              
74             Three-letter ISO currency code, in lowercase. Must be a supported currency.
75              
76             =head2 source_types hash
77              
78             Breakdown of balance by source types. This is a virtual L<Net::API::Stripe::Payment::Source::Types> module that contains the following properties:
79              
80             =over 4
81              
82             =item I<bank_account> integer
83              
84             Amount for bank account.
85              
86             =item I<card> integer
87              
88             Amount for card.
89              
90             =back
91              
92             =head1 API SAMPLE
93              
94             {
95             "object": "balance",
96             "available": [
97             {
98             "amount": 7712,
99             "currency": "jpy",
100             "source_types": {
101             "card": 7712
102             }
103             }
104             ],
105             "connect_reserved": [
106             {
107             "amount": 0,
108             "currency": "jpy"
109             }
110             ],
111             "livemode": false,
112             "pending": [
113             {
114             "amount": 0,
115             "currency": "jpy",
116             "source_types": {
117             "card": 0
118             }
119             }
120             ]
121             }
122              
123             =head1 HISTORY
124              
125             =head2 v0.1
126              
127             Initial version
128              
129             =head1 AUTHOR
130              
131             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
132              
133             =head1 SEE ALSO
134              
135             Stripe API documentation:
136              
137             L<https://stripe.com/docs/api>
138              
139             =head1 COPYRIGHT & LICENSE
140              
141             Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
142              
143             You can use, copy, modify and redistribute this package and associated
144             files under the same terms as Perl itself.
145              
146             =cut