File Coverage

lib/Net/API/Stripe/Cash/Balance.pm
Criterion Covered Total %
statement 19 25 76.0
branch n/a
condition n/a
subroutine 7 13 53.8
pod 5 6 83.3
total 31 44 70.4


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## Stripe API - ~/lib/Net/API/Stripe/Cash/Balance.pm
3             ## Version v0.1.0
4             ## Copyright(c) 2022 DEGUEST Pte. Ltd.
5             ## Author: Jacques Deguest <jack@deguest.jp>
6             ## Created 2022/07/06
7             ## Modified 2022/07/06
8             ## All rights reserved
9             ##
10             ## This program is free software; you can redistribute it and/or modify it
11             ## under the same terms as Perl itself.
12             ##----------------------------------------------------------------------------
13             BEGIN
14             {
15             use strict;
16 2     2   23819371 use warnings;
  2         13  
  2         59  
17 2     2   11 use parent qw( Net::API::Stripe::Generic );
  2         3  
  2         60  
18 2     2   12 use vars qw( $VERSION );
  2         3  
  2         11  
19 2     2   137 our $VERSION = 'v0.1.0';
  2         6  
  2         111  
20 2     2   40 };
21              
22             use strict;
23 2     2   9 use warnings;
  2         5  
  2         38  
24 2     2   8  
  2         5  
  2         372  
25              
26 0     0 0    
27              
28 0     0 1    
29              
30 0     0 1   {
31             return( shift->_set_get_class( 'settings',
32 0     0 1   {
33             reconciliation_mode => { type => 'scalar' },
34 0     0 1   }, @_ ) );
35             }
36              
37             1;
38 0     0 1   # NOTE: POD
39              
40             =encoding utf-8
41              
42             =head1 NAME
43              
44             Net::API::Stripe::Cash::Balance - Stripe API
45              
46             =head1 SYNOPSIS
47              
48             use Net::API::Stripe::Cash::Balance;
49             my $this = Net::API::Stripe::Cash::Balance->new(
50             object => 'cash_balance',
51             available =>
52             {
53             jpy => 10000,
54             },
55             customer => 'cu_abcdefgh1234567890',
56             livemode => 0,
57             settings =>
58             {
59             reconciliation_mode => 'automatic'
60             ) || die( Net::API::Stripe::Cash::Balance->error, "\n" );
61              
62             =head1 VERSION
63              
64             v0.1.0
65              
66             =head1 DESCRIPTION
67              
68             This class represent a Stripe customer cash balance.
69              
70             =head1 METHODS
71              
72             =head2 object
73              
74             String, value is "cash_balance"
75              
76             String representing the object’s type. Objects of the same type share the same value.
77              
78             =head2 available
79              
80             A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0.
81              
82             =head2 customer
83              
84             String
85              
86             The ID of the customer whose cash balance this object represents.
87              
88             =head2 livemode
89              
90             Boolean
91              
92             Has the value true if the object exists in live mode or the value false if the object exists in test mode.
93              
94             =head2 settings
95              
96             Hash
97              
98             The customer’s default cash balance settings.
99              
100             =over 4
101              
102             =item * C<reconciliation_mode> string
103              
104             =back
105              
106             The configuration for how funds that land in the customer cash balance are reconciled.
107              
108             =head1 API SAMPLE
109              
110             {
111             "object": "cash_balance",
112             "available": {
113             "jpy": 10000
114             },
115             "customer": "cu_1A3RPuCeyNCl6fY2YeKa3wSH",
116             "livemode": false,
117             "settings": {
118             "reconciliation_mode": "automatic"
119             }
120             }
121              
122             =head1 AUTHOR
123              
124             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
125              
126             =head1 SEE ALSO
127              
128             Stripe API documentation:
129              
130             L<https://stripe.com/docs/api/cash_balance/object>
131              
132             =head1 COPYRIGHT & LICENSE
133              
134             Copyright(c) 2022 DEGUEST Pte. Ltd.
135              
136             All rights reserved
137             This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
138              
139             =cut