File Coverage

lib/Net/API/Stripe/Reporting/ReportType.pm
Criterion Covered Total %
statement 19 28 67.8
branch n/a
condition n/a
subroutine 7 16 43.7
pod 9 9 100.0
total 35 53 66.0


line stmt bran cond sub pod time code
1             package Net::API::Stripe::Reporting::ReportType;
2             BEGIN
3             {
4 2     2   21482298 use strict;
  2         16  
  2         66  
5 2     2   13 use warnings;
  2         5  
  2         78  
6 2     2   12 use parent qw( Net::API::Stripe::Generic );
  2         3  
  2         11  
7 2     2   145 use vars qw( $VERSION );
  2         10  
  2         138  
8 2     2   45 our( $VERSION ) = 'v0.2.0';
9             };
10              
11 2     2   14 use strict;
  2         8  
  2         58  
12 2     2   13 use warnings;
  2         5  
  2         475  
13              
14 0     0 1   sub id { return( shift->_set_get_scalar( 'id', @_ ) ); }
15              
16 0     0 1   sub object { return( shift->_set_get_scalar( 'object', @_ ) ); }
17              
18 0     0 1   sub data_available_end { return( shift->_set_get_datetime( 'data_available_end', @_ ) ); }
19              
20 0     0 1   sub data_available_start { return( shift->_set_get_datetime( 'data_available_start', @_ ) ); }
21              
22 0     0 1   sub default_columns { return( shift->_set_get_array( 'default_columns', @_ ) ); }
23              
24 0     0 1   sub livemode { return( shift->_set_get_boolean( 'livemode', @_ ) ); }
25              
26 0     0 1   sub name { return( shift->_set_get_scalar( 'name', @_ ) ); }
27              
28 0     0 1   sub updated { return( shift->_set_get_datetime( 'updated', @_ ) ); }
29              
30 0     0 1   sub version { return( shift->_set_get_number( 'version', @_ ) ); }
31              
32             1;
33              
34             __END__
35              
36             =encoding utf8
37              
38             =head1 NAME
39              
40             Net::API::Stripe::Reporting::ReportType - The Report Type object
41              
42             =head1 SYNOPSIS
43              
44             my $type = $stripe->report_type({
45             data_available_end => '2020-11-17T12:15:20',
46             data_available_start => '2020-03-01T07:30:20',
47             default_columns => $some_array,
48             name => 'type name',
49             updated => 'now',
50             version => 1,
51             });
52              
53             =head1 VERSION
54              
55             v0.2.0
56              
57             =head1 DESCRIPTION
58              
59             The Report Type resource corresponds to a particular type of report, such as the "Activity summary" or "Itemized payouts" reports. These objects are identified by an ID belonging to a set of enumerated values. See [API Access to Reports documentation](/docs/reporting/statements/api) for those Report Type IDs, along with required and optional parameters.
60             Note that reports can only be run based on your live-mode data (not test-mode data), and thus related requests must be made with a [live-mode API key](/docs/keys#test-live-modes).
61              
62             =head1 METHODS
63              
64             =head2 id string
65              
66             The [ID of the Report Type](/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`.
67              
68             =head2 object string
69              
70             String representing the object's type. Objects of the same type share the same value.
71              
72             =head2 data_available_end timestamp
73              
74             Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.
75              
76             =head2 data_available_start timestamp
77              
78             Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.
79              
80             =head2 default_columns string_array
81              
82             List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.)
83              
84             =head2 livemode boolean
85              
86             Has the value C<true> if the object exists in live mode or the value C<false> if the object exists in test mode.
87              
88             =head2 name string
89              
90             Human-readable name of the Report Type
91              
92             =head2 updated timestamp
93              
94             When this Report Type was latest updated. Measured in seconds since the Unix epoch.
95              
96             =head2 version integer
97              
98             Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas.
99              
100             =head1 API SAMPLE
101              
102             {
103             "id": "balance.summary.1",
104             "object": "reporting.report_type",
105             "data_available_end": 1604966400,
106             "data_available_start": 1385769600,
107             "default_columns": [
108             "category",
109             "description",
110             "net_amount",
111             "currency"
112             ],
113             "name": "Balance summary",
114             "updated": 1605009363,
115             "version": 1
116             }
117              
118             =head1 HISTORY
119              
120             =head2 v0.1.0
121              
122             Initial version
123              
124             =head1 AUTHOR
125              
126             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
127              
128             =head1 SEE ALSO
129              
130             Stripe API documentation:
131              
132             L<https://stripe.com/docs/api#reporting_report_type_object>
133              
134             =head1 COPYRIGHT & LICENSE
135              
136             Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
137              
138             You can use, copy, modify and redistribute this package and associated
139             files under the same terms as Perl itself.
140              
141             =cut