File Coverage

blib/lib/Net/API/Telegram/SuccessfulPayment.pm
Criterion Covered Total %
statement 7 14 50.0
branch n/a
condition n/a
subroutine 3 10 30.0
pod 7 7 100.0
total 17 31 54.8


line stmt bran cond sub pod time code
1             # -*- perl -*-
2             ##----------------------------------------------------------------------------
3             ## Telegram API - ~/lib/Net/API/Telegram/SuccessfulPayment.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 2019/11/01
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::SuccessfulPayment;
15             BEGIN
16             {
17 1     1   1079 use strict;
  1         2  
  1         37  
18 1     1   7 use parent qw( Net::API::Telegram::Generic );
  1         4  
  1         7  
19 1     1   269 our( $VERSION ) = '0.1';
20             };
21              
22 0     0 1   sub currency { return( shift->_set_get_scalar( 'currency', @_ ) ); }
23              
24 0     0 1   sub invoice_payload { return( shift->_set_get_scalar( 'invoice_payload', @_ ) ); }
25              
26 0     0 1   sub order_info { return( shift->_set_get_object( 'order_info', 'Net::API::Telegram::OrderInfo', @_ ) ); }
27              
28 0     0 1   sub provider_payment_charge_id { return( shift->_set_get_scalar( 'provider_payment_charge_id', @_ ) ); }
29              
30 0     0 1   sub shipping_option_id { return( shift->_set_get_scalar( 'shipping_option_id', @_ ) ); }
31              
32 0     0 1   sub telegram_payment_charge_id { return( shift->_set_get_scalar( 'telegram_payment_charge_id', @_ ) ); }
33              
34 0     0 1   sub total_amount { return( shift->_set_get_number( 'total_amount', @_ ) ); }
35              
36             1;
37              
38             __END__
39              
40             =encoding utf-8
41              
42             =head1 NAME
43              
44             Net::API::Telegram::SuccessfulPayment - Basic information about a successful payment
45              
46             =head1 SYNOPSIS
47              
48             my $msg = Net::API::Telegram::SuccessfulPayment->new( %data ) ||
49             die( Net::API::Telegram::SuccessfulPayment->error, "\n" );
50              
51             =head1 DESCRIPTION
52              
53             L<Net::API::Telegram::SuccessfulPayment> is a Telegram Message Object as defined here L<https://core.telegram.org/bots/api#successfulpayment>
54              
55             This module has been automatically generated from Telegram API documentation by the script scripts/telegram-doc2perl-methods.pl.
56              
57             =head1 METHODS
58              
59             =over 4
60              
61             =item B<new>( {INIT HASH REF}, %PARAMETERS )
62              
63             B<new>() will create a new object for the package, pass any argument it might receive
64             to the special standard routine B<init> that I<must> exist.
65             Then it returns what returns B<init>().
66              
67             The valid parameters are as follow. Methods available here are also parameters to the B<new> method.
68              
69             =over 8
70              
71             =item * I<verbose>
72              
73             =item * I<debug>
74              
75             =back
76              
77             =item B<currency>( String )
78              
79             Three-letter ISO 4217 currency code
80              
81             =item B<invoice_payload>( String )
82              
83             Bot specified invoice payload
84              
85             =item B<order_info>( L<Net::API::Telegram::OrderInfo> )
86              
87             Optional. Order info provided by the user
88              
89             =item B<provider_payment_charge_id>( String )
90              
91             Provider payment identifier
92              
93             =item B<shipping_option_id>( String )
94              
95             Optional. Identifier of the shipping option chosen by the user
96              
97             =item B<telegram_payment_charge_id>( String )
98              
99             Telegram payment identifier
100              
101             =item B<total_amount>( Integer )
102              
103             Total price in the smallest units of the currency (integer, not float/double). For example, for a price of US$ 1.45 pass amount = 145. See the exp parameter in currencies.json, it shows the number of digits past the decimal point for each currency (2 for the majority of currencies).
104              
105             =back
106              
107             =head1 COPYRIGHT
108              
109             Copyright (c) 2000-2019 DEGUEST Pte. Ltd.
110              
111             =head1 AUTHOR
112              
113             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
114              
115             =head1 SEE ALSO
116              
117             L<Net::API::Telegram>
118              
119             =head1 COPYRIGHT & LICENSE
120              
121             Copyright (c) 2018-2019 DEGUEST Pte. Ltd.
122              
123             You can use, copy, modify and redistribute this package and associated
124             files under the same terms as Perl itself.
125              
126             =cut
127