File Coverage

lib/Net/API/Stripe/Connect/Transfer/Reversals.pm
Criterion Covered Total %
statement 19 19 100.0
branch n/a
condition n/a
subroutine 7 7 100.0
pod n/a
total 26 26 100.0


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## Stripe API - ~/lib/Net/API/Stripe/Connect/Transfer/Reversals.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::Connect::Transfer::Reversals;
11             BEGIN
12             {
13 1     1   1048 use strict;
  1         4  
  1         36  
14 1     1   9 use warnings;
  1         5  
  1         28  
15 1     1   16 use parent qw( Net::API::Stripe::List );
  1         4  
  1         6  
16 1     1   99 use vars qw( $VERSION );
  1         2  
  1         67  
17 1     1   19 our( $VERSION ) = 'v0.100.0';
18             };
19              
20 1     1   5 use strict;
  1         2  
  1         25  
21 1     1   6 use warnings;
  1         2  
  1         38  
22              
23             # Inherited
24             # sub object { return( shift->_set_get_scalar( 'object', @_ ) ); }
25              
26             ## Array of Net::API::Stripe::Connect::Transfer::Reversal
27             ## sub data { return( shift->_set_get_object_array( 'data', 'Net::API::Stripe::Connect::Transfer::Reversal', @_ ) ); }
28              
29             # Inherited
30             # sub has_more { return( shift->_set_get_scalar( 'has_more', @_ ) ); }
31              
32             # Inherited
33             # sub total_count { return( shift->_set_get_scalar( 'total_count', @_ ) ); }
34              
35             # Inherited
36             # sub url { return( shift->_set_get_uri( 'url', @_ ) ); }
37              
38             1;
39              
40             __END__
41              
42             =encoding utf8
43              
44             =head1 NAME
45              
46             Net::API::Stripe::Connect::Transfer::Reversals - A list of Transfer Reversal as Object
47              
48             =head1 SYNOPSIS
49              
50             my $list = $stripe->reversals( 'list' ) || die( $stripe->error );
51             while( my $rev = $list->next )
52             {
53             printf( <<EOT, $rev->amount->format_money( 0, '¥' ), $rev->currency, $rev->created->iso8601 );
54             Amount: %s
55             Currency: %s
56             Created: %s
57             EOT
58             }
59              
60             Would produce:
61              
62             Amount: ¥2,000
63             Currency: jpy
64             Created: 2020-04-06T06:00:00
65              
66             =head1 VERSION
67              
68             v0.100.0
69              
70             =head1 DESCRIPTION
71              
72             A list of reversals that have been applied to the transfer.
73              
74             This module inherits from L<Net::API::Stripe::List> and overrides only the B<data> method.
75              
76             =head1 CONSTRUCTOR
77              
78             =head2 new( %ARG )
79              
80             Creates a new L<Net::API::Stripe::Connect::Transfer::Reversals> object.
81              
82             =head2 has_more boolean
83              
84             True if this list has another page of items after this one that can be fetched.
85              
86             =head2 url string
87              
88             The URL where this list can be accessed.
89              
90             =head1 API SAMPLE
91              
92             {
93             "object": "list",
94             "url": "/v1/transfers/tr_fake123456789/reversals",
95             "has_more": false,
96             "data": [
97             {
98             "id": "trr_fake123456789",
99             "object": "transfer_reversal",
100             "amount": 1100,
101             "balance_transaction": "txn_fake123456789",
102             "created": 1571480456,
103             "currency": "jpy",
104             "destination_payment_refund": null,
105             "metadata": {},
106             "source_refund": null,
107             "transfer": "tr_fake123456789"
108             },
109             {...},
110             {...}
111             ]
112             }
113              
114             =head1 HISTORY
115              
116             =head2 v0.1
117              
118             Initial version
119              
120             =head1 AUTHOR
121              
122             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
123              
124             =head1 SEE ALSO
125              
126             Stripe API documentation:
127              
128             L<https://stripe.com/docs/api/transfer_reversals/list>
129              
130             =head1 COPYRIGHT & LICENSE
131              
132             Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
133              
134             You can use, copy, modify and redistribute this package and associated
135             files under the same terms as Perl itself.
136              
137             =cut