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             BEGIN
2             {
3             use strict;
4 2     2   24056836 use warnings;
  2         13  
  2         63  
5 2     2   11 use parent qw( Net::API::Stripe::Generic );
  2         4  
  2         59  
6 2     2   10 use vars qw( $VERSION );
  2         4  
  2         12  
7 2     2   156 our( $VERSION ) = 'v0.2.0';
  2         4  
  2         112  
8 2     2   55 };
9              
10             use strict;
11 2     2   16 use warnings;
  2         4  
  2         41  
12 2     2   11  
  2         6  
  2         480  
13              
14 0     0 1    
15              
16 0     0 1    
17              
18 0     0 1    
19              
20 0     0 1    
21              
22 0     0 1   1;
23              
24 0     0 1    
25             =encoding utf8
26 0     0 1    
27             =head1 NAME
28 0     0 1    
29             Net::API::Stripe::Reporting::ReportType - The Report Type object
30 0     0 1    
31             =head1 SYNOPSIS
32              
33             my $type = $stripe->report_type({
34             data_available_end => '2020-11-17T12:15:20',
35             data_available_start => '2020-03-01T07:30:20',
36             default_columns => $some_array,
37             name => 'type name',
38             updated => 'now',
39             version => 1,
40             });
41              
42             =head1 VERSION
43              
44             v0.2.0
45              
46             =head1 DESCRIPTION
47              
48             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.
49             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).
50              
51             =head1 METHODS
52              
53             =head2 id string
54              
55             The [ID of the Report Type](/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`.
56              
57             =head2 object string
58              
59             String representing the object's type. Objects of the same type share the same value.
60              
61             =head2 data_available_end timestamp
62              
63             Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch.
64              
65             =head2 data_available_start timestamp
66              
67             Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch.
68              
69             =head2 default_columns string_array
70              
71             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.)
72              
73             =head2 livemode boolean
74              
75             Has the value C<true> if the object exists in live mode or the value C<false> if the object exists in test mode.
76              
77             =head2 name string
78              
79             Human-readable name of the Report Type
80              
81             =head2 updated timestamp
82              
83             When this Report Type was latest updated. Measured in seconds since the Unix epoch.
84              
85             =head2 version integer
86              
87             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.
88              
89             =head1 API SAMPLE
90              
91             {
92             "id": "balance.summary.1",
93             "object": "reporting.report_type",
94             "data_available_end": 1604966400,
95             "data_available_start": 1385769600,
96             "default_columns": [
97             "category",
98             "description",
99             "net_amount",
100             "currency"
101             ],
102             "name": "Balance summary",
103             "updated": 1605009363,
104             "version": 1
105             }
106              
107             =head1 HISTORY
108              
109             =head2 v0.1.0
110              
111             Initial version
112              
113             =head1 AUTHOR
114              
115             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
116              
117             =head1 SEE ALSO
118              
119             Stripe API documentation:
120              
121             L<https://stripe.com/docs/api#reporting_report_type_object>
122              
123             =head1 COPYRIGHT & LICENSE
124              
125             Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
126              
127             You can use, copy, modify and redistribute this package and associated
128             files under the same terms as Perl itself.
129              
130             =cut