File Coverage

blib/lib/Net/API/Stripe/Connect/Account/Document.pm
Criterion Covered Total %
statement 7 11 63.6
branch n/a
condition n/a
subroutine 3 7 42.8
pod 4 4 100.0
total 14 22 63.6


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## Stripe API - ~/lib/Net/API/Stripe/Connect/Account/Document.pm
3             ## Version v0.100.0
4             ## Copyright(c) 2019 DEGUEST Pte. Ltd.
5             ## Author: Jacques Deguest <@sitael.tokyo.deguest.jp>
6             ## Created 2019/11/02
7             ## Modified 2020/05/15
8             ##
9             ##----------------------------------------------------------------------------
10             package Net::API::Stripe::Connect::Account::Document;
11             BEGIN
12             {
13 1     1   831 use strict;
  1         2  
  1         28  
14 1     1   5 use parent qw( Net::API::Stripe::Generic );
  1         1  
  1         4  
15 1     1   134 our( $VERSION ) = 'v0.100.0';
16             };
17              
18 0     0 1   sub back { return( shift->_set_get_scalar_or_object( 'back', 'Net::API::Stripe::File', @_ ) ); }
19              
20 0     0 1   sub details { return( shift->_set_get_scalar( 'details', @_ ) ); }
21              
22 0     0 1   sub details_code { return( shift->_set_get_scalar( 'details_code', @_ ) ); }
23              
24 0     0 1   sub front { return( shift->_set_get_scalar_or_object( 'front', 'Net::API::Stripe::File', @_ ) ); }
25              
26             1;
27              
28             __END__
29              
30             =encoding utf8
31              
32             =head1 NAME
33              
34             Net::API::Stripe::Connect::Account::Document - An interface to Stripe API
35              
36             =head1 SYNOPSIS
37              
38             my $doc = $stripe->account->verification->document({
39             back => '/some/file/path/scan_back.jpg',
40             details => 'Low resolution jpeg',
41             # Set by Stripe
42             # details_code => 'document_not_readable',
43             front => '/some/file/path/scan_front.jpg',
44             });
45              
46             =head1 VERSION
47              
48             v0.100.0
49              
50             =head1 DESCRIPTION
51              
52             A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
53              
54             Tis is called from method B<document> in module L<Net::API::Stripe::Connect::Account::Verification>
55              
56             =head1 CONSTRUCTOR
57              
58             =over 4
59              
60             =item B<new>( %ARG )
61              
62             Creates a new L<Net::API::Stripe::Connect::Account::Document> object.
63             It may also take an hash like arguments, that also are method of the same name.
64              
65             =back
66              
67             =head1 METHODS
68              
69             =over 4
70              
71             =item B<back> string (expandable)
72              
73             The back of an ID returned by a file upload with a purpose value of identity_document.
74              
75             When expanded, this is a L<Net::API::Stripe::File> object.
76              
77             =item B<details> string
78              
79             A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say “Identity document is too unclear to read”.
80              
81             =item B<details_code> string
82              
83             One of document_corrupt, document_country_not_supported, document_expired, document_failed_copy, document_failed_other, document_failed_test_mode, document_fraudulent, document_failed_greyscale, document_incomplete, document_invalid, document_manipulated, document_missing_back, document_missing_front, document_not_readable, document_not_uploaded, document_photo_mismatch, document_too_large, or document_type_not_supported. A machine-readable code specifying the verification state for this document.
84              
85             =item B<front> string (expandable)
86              
87             The front of an ID returned by a file upload with a purpose value of identity_document.
88              
89             When expanded, this is a L<Net::API::Stripe::File> object.
90              
91             =back
92              
93             =head1 API SAMPLE
94              
95             {
96             "id": "person_fake123456789",
97             "object": "person",
98             "account": "acct_fake123456789",
99             "created": 1580075612,
100             "dob": {
101             "day": null,
102             "month": null,
103             "year": null
104             },
105             "first_name_kana": null,
106             "first_name_kanji": null,
107             "gender": null,
108             "last_name_kana": null,
109             "last_name_kanji": null,
110             "metadata": {},
111             "relationship": {
112             "director": false,
113             "executive": false,
114             "owner": false,
115             "percent_ownership": null,
116             "representative": false,
117             "title": null
118             },
119             "requirements": {
120             "currently_due": [],
121             "eventually_due": [],
122             "past_due": [],
123             "pending_verification": []
124             },
125             "verification": {
126             "additional_document": {
127             "back": null,
128             "details": null,
129             "details_code": null,
130             "front": null
131             },
132             "details": null,
133             "details_code": null,
134             "document": {
135             "back": null,
136             "details": null,
137             "details_code": null,
138             "front": null
139             },
140             "status": "unverified"
141             }
142             }
143              
144             =head1 HISTORY
145              
146             =head2 v0.1
147              
148             Initial version
149              
150             =head1 AUTHOR
151              
152             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
153              
154             =head1 SEE ALSO
155              
156             Stripe API documentation:
157              
158             L<https://stripe.com/docs/api>
159              
160             =head1 COPYRIGHT & LICENSE
161              
162             Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
163              
164             You can use, copy, modify and redistribute this package and associated
165             files under the same terms as Perl itself.
166              
167             =cut