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