File Coverage

blib/lib/WebService/Async/Onfido/Base/Report.pm
Criterion Covered Total %
statement 17 24 70.8
branch 1 2 50.0
condition n/a
subroutine 9 16 56.2
pod 11 13 84.6
total 38 55 69.0


line stmt bran cond sub pod time code
1             package WebService::Async::Onfido::Base::Report;
2              
3 2     2   938 use strict;
  2         6  
  2         60  
4 2     2   11 use warnings;
  2         4  
  2         45  
5              
6 2     2   10 use utf8;
  2         5  
  2         9  
7              
8             our $VERSION = '0.006'; # VERSION
9              
10             =head1 NAME
11              
12             WebService::Async::Onfido::Base::Report - represents data for Onfido
13              
14             =head1 DESCRIPTION
15              
16             This is autogenerated from the documentation in L<https://documentation.onfido.com>.
17              
18             =cut
19              
20             sub new {
21 3     3 0 30 my ($class, %args) = @_;
22 3 50       20 Scalar::Util::weaken($args{onfido}) if $args{onfido};
23 3         25 return bless \%args, $class;
24             }
25              
26             =head1 METHODS
27             =head2 id
28              
29             The unique identifier for the report.
30              
31             =cut
32              
33 2     2 0 50 sub id : method { return shift->{id} }
34              
35             =head2 created_at
36              
37             The date and time at which the report was first initiated.
38              
39             =cut
40              
41 2     2 1 17 sub created_at : method { return shift->{created_at} }
42              
43             =head2 name
44              
45             Report type string identifier. See Report Types.
46              
47             =cut
48              
49 5     5 1 1391 sub name : method { return shift->{name} }
50              
51             =head2 href
52              
53             The API endpoint to retrieve the report.
54              
55             =cut
56              
57 0     0 1 0 sub href : method { return shift->{href} }
58              
59             =head2 status
60              
61             The current state of the report in the checking process.
62              
63             =cut
64              
65 2     2 1 13 sub status : method { return shift->{status} }
66              
67             =head2 result
68              
69             The result of the report.
70              
71             =cut
72              
73 2     2 1 10 sub result : method { return shift->{result} }
74              
75             =head2 sub_result
76              
77             The sub_result of the report. It gives a more detailed result for document reports only, and will be null otherwise.
78              
79             =cut
80              
81 0     0 1   sub sub_result : method { return shift->{sub_result} }
82              
83             =head2 variant
84              
85             Report variant string identifier. Some reports have sub-types, which are identified by this field. These are detailed in Report Types.
86              
87             =cut
88              
89 0     0 1   sub variant : method { return shift->{variant} }
90              
91             =head2 options
92              
93             Report options. Some reports expose additional options. These are detailed in Report Types.
94              
95             =cut
96              
97 0     0 1   sub options : method { return shift->{options} }
98              
99             =head2 breakdown
100              
101             The details of the report. This is specific to each type of report.
102              
103             =cut
104              
105 0     0 1   sub breakdown : method { return shift->{breakdown} }
106              
107             =head2 properties
108              
109             The properties associated with the report, if any.
110              
111             =cut
112              
113 0     0 1   sub properties : method { return shift->{properties} }
114              
115             =head2 documents
116              
117             The document ids that were processed. Only for Document Report..
118              
119             =cut
120              
121 0     0 1   sub documents : method { return shift->{documents} }
122              
123             1;
124              
125             __END__
126              
127             =head1 AUTHOR
128              
129             deriv.com C<< DERIV@cpan.org >>
130              
131             =head1 LICENSE
132              
133             Copyright deriv.com 2019. Licensed under the same terms as Perl itself.
134