File Coverage

lib/Net/API/Stripe/Fraud/Review.pm

Criterion	Covered	Total	%
statement	19	33	57.5
branch			n/a
condition			n/a
subroutine	7	21	33.3
pod	14	14	100.0
total	40	68	58.8

line	stmt	sub	pod	time	code
1					##----------------------------------------------------------------------------
2					## Stripe API - ~/lib/Net/API/Stripe/Fraud/Review.pm
3					## Version v0.100.0
4					## Copyright(c) 2019 DEGUEST Pte. Ltd.
5					## Author: Jacques Deguest <jack@deguest.jp>
6					## Created 2019/11/02
7					## Modified 2020/05/15
8					##
9					##----------------------------------------------------------------------------
10					BEGIN
11					{
12					use strict;
13	2	2		24574721	use warnings;
	2			12
	2			62
14	2	2		12	use parent qw( Net::API::Stripe::Generic );
	2			3
	2			59
15	2	2		9	use vars qw( $VERSION );
	2			4
	2			10
16	2	2		138	our( $VERSION ) = 'v0.100.0';
	2			4
	2			107
17	2	2		37	};
18
19					use strict;
20	2	2		12	use warnings;
	2			3
	2			39
21	2	2		9
	2			3
	2			632
22
23	0	0	1
24
25	0	0	1
26
27	0	0	1
28
29	0	0	1
30
31	0	0	1
32
33	0	0	1
34
35	0	0	1
36					1;
37	0	0	1
38
39	0	0	1		=encoding utf8
40
41	0	0	1		=head1 NAME
42
43	0	0	1		Net::API::Stripe::Fraud::Review - A Stripe Fraud Review Object
44
45	0	0	1		=head1 SYNOPSIS
46
47	0	0	1		my $review = $stripe->review({
48					billing_zip => '123-4567',
49	0	0	1		# Could also be a Net::API::Stripe::Charge object when expanded
50					charge => 'ch_fake1234567890',
51					ip_address => '1.2.3.4',
52					ip_address_location =>
53					{
54					city => 'Tokyo',
55					country => 'jp',
56					latitude => '35.6935496',
57					longitude => '139.7461204',
58					region => undef,
59					},
60					open => $stripe->true,
61					payment_intent => $payment_intent_object,
62					reason => 'Some issue',
63					session => $session_object,
64					});
65
66					See documentation in L<Net::API::Stripe> for example to make api calls to Stripe to create those objects.
67
68					=head1 VERSION
69
70					v0.100.0
71
72					=head1 DESCRIPTION
73
74					Reviews can be used to supplement automated fraud detection with human expertise.
75
76					=head1 CONSTRUCTOR
77
78					=head2 new( %ARG )
79
80					Creates a new L<Net::API::Stripe::Fraud::Review> object.
81					It may also take an hash like arguments, that also are method of the same name.
82
83					=head1 METHODS
84
85					=head2 id string
86
87					Unique identifier for the object.
88
89					=head2 object string, value is "review"
90
91					String representing the object’s type. Objects of the same type share the same value.
92
93					=head2 billing_zip string
94
95					The ZIP or postal code of the card used, if applicable.
96
97					=head2 charge string (expandable)
98
99					The charge associated with this review.
100
101					When expanded, this is a L<Net::API::Stripe::Charge> object.
102
103					=head2 closed_reason string
104
105					The reason the review was closed, or null if it has not yet been closed. One of approved, refunded, refunded_as_fraud, or disputed.
106
107					=head2 created timestamp
108
109					Time at which the object was created. Measured in seconds since the Unix epoch.
110
111					=head2 ip_address string
112
113					The IP address where the payment originated.
114
115					=head2 ip_address_location hash
116
117					Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address.
118
119					This is a L<Net::API::Stripe::GeoLocation> object.
120
121					=head2 livemode boolean
122
123					Has the value true if the object exists in live mode or the value false if the object exists in test mode.
124
125					=head2 open boolean
126
127					If true, the review needs action.
128
129					=head2 opened_reason string
130
131					The reason the review was opened. One of rule or manual.
132
133					=head2 payment_intent string (expandable)
134
135					The PaymentIntent ID associated with this review, if one exists.
136
137					When expanded, this is a L<Net::API::Stripe::Payment::Intent> object.
138
139					=head2 reason string
140
141					The reason the review is currently open or closed. One of rule, manual, approved, refunded, refunded_as_fraud, or disputed.
142
143					=head2 session hash
144
145					Information related to the browsing session of the user who initiated the payment.
146
147					This is a L<Net::API::Stripe::Session> object.
148
149					=head1 API SAMPLE
150
151					{
152					"id": "prv_fake123456789",
153					"object": "review",
154					"billing_zip": null,
155					"charge": "ch_fake123456789",
156					"closed_reason": null,
157					"created": 1571480456,
158					"ip_address": null,
159					"ip_address_location": null,
160					"livemode": false,
161					"open": true,
162					"opened_reason": "rule",
163					"reason": "rule",
164					"session": null
165					}
166
167					=head1 HISTORY
168
169					=head2 v0.1
170
171					Initial version
172
173					=head1 AUTHOR
174
175					Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
176
177					=head1 SEE ALSO
178
179					Stripe API documentation:
180
181					L<https://stripe.com/docs/api/radar/reviews>, L<https://stripe.com/radar>
182
183					=head1 COPYRIGHT & LICENSE
184
185					Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
186
187					You can use, copy, modify and redistribute this package and associated
188					files under the same terms as Perl itself.
189
190					=cut