File Coverage

blib/lib/Net/API/Telegram/EncryptedPassportElement.pm
Criterion Covered Total %
statement 7 17 41.1
branch n/a
condition n/a
subroutine 3 13 23.0
pod 10 10 100.0
total 20 40 50.0


line stmt bran cond sub pod time code
1             # -*- perl -*-
2             ##----------------------------------------------------------------------------
3             ## Net/API/Telegram/EncryptedPassportElement.pm
4             ## Version 0.1
5             ## Copyright(c) 2019 Jacques Deguest
6             ## Author: Jacques Deguest <jack@deguest.jp>
7             ## Created 2019/05/29
8             ## Modified 2020/03/28
9             ## All rights reserved.
10             ##
11             ## This program is free software; you can redistribute it and/or modify it
12             ## under the same terms as Perl itself.
13             ##----------------------------------------------------------------------------
14             package Net::API::Telegram::EncryptedPassportElement;
15             BEGIN
16             {
17 1     1   1004 use strict;
  1         3  
  1         32  
18 1     1   6 use parent qw( Net::API::Telegram::Generic );
  1         2  
  1         5  
19 1     1   358 our( $VERSION ) = '0.1';
20             };
21              
22 0     0 1   sub data { return( shift->_set_get_scalar( 'data', @_ ) ); }
23              
24 0     0 1   sub email { return( shift->_set_get_scalar( 'email', @_ ) ); }
25              
26 0     0 1   sub files { return( shift->_set_get_object_array( 'files', 'Net::API::Telegram::PassportFile', @_ ) ); }
27              
28 0     0 1   sub front_side { return( shift->_set_get_object( 'front_side', 'Net::API::Telegram::PassportFile', @_ ) ); }
29              
30 0     0 1   sub hash { return( shift->_set_get_scalar( 'hash', @_ ) ); }
31              
32 0     0 1   sub phone_number { return( shift->_set_get_scalar( 'phone_number', @_ ) ); }
33              
34 0     0 1   sub reverse_side { return( shift->_set_get_object( 'reverse_side', 'Net::API::Telegram::PassportFile', @_ ) ); }
35              
36 0     0 1   sub selfie { return( shift->_set_get_object( 'selfie', 'Net::API::Telegram::PassportFile', @_ ) ); }
37              
38 0     0 1   sub translation { return( shift->_set_get_object_array( 'translation', 'Net::API::Telegram::PassportFile', @_ ) ); }
39              
40 0     0 1   sub type { return( shift->_set_get_scalar( 'type', @_ ) ); }
41              
42             1;
43              
44             __END__
45              
46             =encoding utf-8
47              
48             =head1 NAME
49              
50             Net::API::Telegram::EncryptedPassportElement - Information about documents or other Telegram Passport elements shared with the bot by the user
51              
52             =head1 SYNOPSIS
53              
54             my $msg = Net::API::Telegram::EncryptedPassportElement->new( %data ) ||
55             die( Net::API::Telegram::EncryptedPassportElement->error, "\n" );
56              
57             =head1 DESCRIPTION
58              
59             L<Net::API::Telegram::EncryptedPassportElement> is a Telegram Message Object as defined here L<https://core.telegram.org/bots/api#encryptedpassportelement>
60              
61             This module has been automatically generated from Telegram API documentation by the script scripts/telegram-doc2perl-methods.pl.
62              
63             =head1 METHODS
64              
65             =over 4
66              
67             =item B<new>( {INIT HASH REF}, %PARAMETERS )
68              
69             B<new>() will create a new object for the package, pass any argument it might receive
70             to the special standard routine B<init> that I<must> exist.
71             Then it returns what returns B<init>().
72              
73             The valid parameters are as follow. Methods available here are also parameters to the B<new> method.
74              
75             =over 8
76              
77             =item * I<verbose>
78              
79             =item * I<debug>
80              
81             =back
82              
83             =item B<data>( String )
84              
85             Optional. Base64-encoded encrypted Telegram Passport element data provided by the user, available for I<personal_details>, I<passport>, I<driver_license>, I<identity_card>, I<internal_passport> and I<address> types. Can be decrypted and verified using the accompanying EncryptedCredentials.
86              
87             =item B<email>( String )
88              
89             Optional. User's verified email address, available only for I<email> type
90              
91             =item B<files>( Array of PassportFile )
92              
93             Optional. Array of encrypted files with documents provided by the user, available for I<utility_bill>, I<bank_statement>, I<rental_agreement>, I<passport_registration> and I<temporary_registration> types. Files can be decrypted and verified using the accompanying EncryptedCredentials.
94              
95             =item B<front_side>( L<Net::API::Telegram::PassportFile> )
96              
97             Optional. Encrypted file with the front side of the document, provided by the user. Available for I<passport>, I<driver_license>, I<identity_card> and I<internal_passport>. The file can be decrypted and verified using the accompanying EncryptedCredentials.
98              
99             =item B<hash>( String )
100              
101             Base64-encoded element hash for using in PassportElementErrorUnspecified
102              
103             =item B<phone_number>( String )
104              
105             Optional. User's verified phone number, available only for I<phone_number> type
106              
107             =item B<reverse_side>( L<Net::API::Telegram::PassportFile> )
108              
109             Optional. Encrypted file with the reverse side of the document, provided by the user. Available for I<driver_license> and I<identity_card>. The file can be decrypted and verified using the accompanying EncryptedCredentials.
110              
111             =item B<selfie>( L<Net::API::Telegram::PassportFile> )
112              
113             Optional. Encrypted file with the selfie of the user holding a document, provided by the user; available for I<passport>, I<driver_license>, I<identity_card> and I<internal_passport>. The file can be decrypted and verified using the accompanying EncryptedCredentials.
114              
115             =item B<translation>( Array of PassportFile )
116              
117             Optional. Array of encrypted files with translated versions of documents provided by the user. Available if requested for I<passport>, I<driver_license>, I<identity_card>, I<internal_passport>, I<utility_bill>, I<bank_statement>, I<rental_agreement>, I<passport_registration> and I<temporary_registration> types. Files can be decrypted and verified using the accompanying EncryptedCredentials.
118              
119             =item B<type>( String )
120              
121             Element type. One of I<personal_details>, I<passport>, I<driver_license>, I<identity_card>, I<internal_passport>, I<address>, I<utility_bill>, I<bank_statement>, I<rental_agreement>, I<passport_registration>, I<temporary_registration>, I<phone_number>, I<email>.
122              
123             =back
124              
125             =head1 COPYRIGHT
126              
127             Copyright (c) 2000-2019 DEGUEST Pte. Ltd.
128              
129             =head1 AUTHOR
130              
131             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
132              
133             =head1 SEE ALSO
134              
135             L<Net::API::Telegram>
136              
137             =head1 COPYRIGHT & LICENSE
138              
139             Copyright (c) 2018-2019 DEGUEST Pte. Ltd.
140              
141             You can use, copy, modify and redistribute this package and associated
142             files under the same terms as Perl itself.
143              
144             =cut
145