File Coverage

blib/lib/WebService/Async/Onfido/Base/Check.pm
Criterion Covered Total %
statement 17 25 68.0
branch 1 2 50.0
condition n/a
subroutine 8 16 50.0
pod 11 13 84.6
total 37 56 66.0


line stmt bran cond sub pod time code
1             package WebService::Async::Onfido::Base::Check;
2              
3 2     2   949 use strict;
  2         5  
  2         59  
4 2     2   10 use warnings;
  2         4  
  2         52  
5              
6 2     2   10 use utf8;
  2         3  
  2         9  
7              
8             our $VERSION = '0.003'; # VERSION
9              
10             =head1 NAME
11              
12             WebService::Async::Onfido::Base::Check - 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 27 my ($class, %args) = @_;
22 3 50       28 Scalar::Util::weaken($args{onfido}) if $args{onfido};
23 3         35 return bless \%args, $class;
24             }
25              
26             =head1 METHODS
27             =head2 id
28              
29             The unique identifier for the check..
30              
31             =cut
32              
33 5     5 0 616 sub id : method { return shift->{id} }
34              
35             =head2 created_at
36              
37             The date and time at which the check was initiated..
38              
39             =cut
40              
41 0     0 1 0 sub created_at : method { return shift->{created_at} }
42              
43             =head2 href
44              
45             The API endpoint to retrieve the check..
46              
47             =cut
48              
49 0     0 1 0 sub href : method { return shift->{href} }
50              
51             =head2 status
52              
53             The current state of the check in the checking process..
54              
55             =cut
56              
57 0     0 1 0 sub status : method { return shift->{status} }
58              
59             =head2 tags
60              
61             A list of tags associated with this check..
62              
63             =cut
64              
65 1     1 1 1857 sub tags : method { return shift->{tags} }
66              
67             =head2 result
68              
69             The overall result of the check, based on the results of the constituent reports..
70              
71             =cut
72              
73 0     0 1 0 sub result : method { return shift->{result} }
74              
75             =head2 download_uri
76              
77             A link to a PDF output of the check results. Append .pdf to get the pdf file..
78              
79             Since v3 this PDF is meant to be downloaded from the API.
80              
81             =cut
82              
83             sub download_uri : method {
84 1     1 1 6 my $self = shift;
85              
86 1         8 return $self->onfido->endpoint('check_download', check_id => $self->id);
87             }
88              
89             =head2 form_uri
90              
91             A link to the applicant form, if the check is of type standard.
92              
93             =cut
94              
95 0     0 1 0 sub form_uri : method { return shift->{form_uri} }
96              
97             =head2 redirect_uri
98              
99             For standard checks, redirect to this URI when the applicant has submitted their data..
100              
101             =cut
102              
103 0     0 1 0 sub redirect_uri : method { return shift->{redirect_uri} }
104              
105             =head2 results_uri
106              
107             A link to the corresponding results page on the Onfido dashboard.
108              
109             =cut
110              
111 0     0 1 0 sub results_uri : method { return shift->{results_uri} }
112              
113             =head2 reports_ids
114              
115             The list of report ids associated with the check..
116              
117             =cut
118              
119 0     0 1 0 sub reports_ids : method { return shift->{reports_ids} }
120              
121             =head2 applicant_id
122              
123             The applicant the check belongs to
124              
125             =cut
126              
127 1     1 1 2630 sub applicant_id : method { return shift->{applicant_id} }
128              
129             1;
130              
131             __END__
132              
133             =head1 AUTHOR
134              
135             deriv.com C<< DERIV@cpan.org >>
136              
137             =head1 LICENSE
138              
139             Copyright deriv.com 2019. Licensed under the same terms as Perl itself.
140