File Coverage

lib/Net/API/Stripe/Fraud/ValueList.pm
Criterion Covered Total %
statement 19 29 65.5
branch n/a
condition n/a
subroutine 7 17 41.1
pod 10 10 100.0
total 36 56 64.2


line stmt bran cond sub pod time code
1             ##----------------------------------------------------------------------------
2             ## Stripe API - ~/lib/Net/API/Stripe/Fraud/ValueList.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   24023569 use warnings;
  2         15  
  2         61  
14 2     2   12 use parent qw( Net::API::Stripe::Generic );
  2         5  
  2         58  
15 2     2   10 use vars qw( $VERSION );
  2         3  
  2         11  
16 2     2   137 our( $VERSION ) = 'v0.100.0';
  2         4  
  2         110  
17 2     2   37 };
18              
19             use strict;
20 2     2   11 use warnings;
  2         4  
  2         37  
21 2     2   47  
  2         5  
  2         443  
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             1;
33 0     0 1    
34              
35 0     0 1   =encoding utf8
36              
37 0     0 1   =head1 NAME
38              
39 0     0 1   Net::API::Stripe::Fraud::ValueList - A Stripe Value List Object
40              
41 0     0 1   =head1 SYNOPSIS
42              
43             my $list = $stripe->value_list({
44             alias => 'custom_ip_blocklist',
45             created_by => 'john.doe@example.com',
46             item_type => 'ip_address',
47             list_items => $list_object,
48             metadata => { transaction_id => 123 },
49             name => 'Custom IP Blocklist',
50             });
51              
52             See documentation in L<Net::API::Stripe> for example to make api calls to Stripe to create those objects.
53              
54             =head1 VERSION
55              
56             v0.100.0
57              
58             =head1 DESCRIPTION
59              
60             Value lists allow you to group values together which can then be referenced in rules.
61              
62             =head1 CONSTRUCTOR
63              
64             =head2 new( %ARG )
65              
66             Creates a new L<Net::API::Stripe::Fraud::ValueList> object.
67              
68             =head1 METHODS
69              
70             =head2 id string
71              
72             Unique identifier for the object.
73              
74             =head2 object string, value is "radar.value_list"
75              
76             String representing the object’s type. Objects of the same type share the same value.
77              
78             =head2 alias string
79              
80             The name of the value list for use in rules.
81              
82             =head2 created timestamp
83              
84             Time at which the object was created. Measured in seconds since the Unix epoch.
85              
86             =head2 created_by string
87              
88             The name or email address of the user who created this value list.
89              
90             =head2 item_type string
91              
92             The type of items in the value list. One of card_fingerprint, card_bin, email, ip_address, country, string, or case_sensitive_string.
93              
94             =head2 list_items list
95              
96             List of items contained within this value list.
97              
98             This is a L<Net::API::Stripe::List> object with array of L<Net::API::Stripe::Fraud::List::Item> objects.
99              
100             =head2 livemode boolean
101              
102             Has the value true if the object exists in live mode or the value false if the object exists in test mode.
103              
104             =head2 metadata hash
105              
106             Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
107              
108             =head2 name string
109              
110             The name of the value list.
111              
112             =head1 API SAMPLE
113              
114             {
115             "id": "rsl_fake123456789",
116             "object": "radar.value_list",
117             "alias": "custom_ip_blocklist",
118             "created": 1571480456,
119             "created_by": "jenny@example.com",
120             "item_type": "ip_address",
121             "list_items": {
122             "object": "list",
123             "data": [],
124             "has_more": false,
125             "url": "/v1/radar/value_list_items?value_list=rsl_fake123456789"
126             },
127             "livemode": false,
128             "metadata": {},
129             "name": "Custom IP Blocklist"
130             }
131              
132             =head1 HISTORY
133              
134             =head2 v0.1
135              
136             Initial version
137              
138             =head1 AUTHOR
139              
140             Jacques Deguest E<lt>F<jack@deguest.jp>E<gt>
141              
142             =head1 SEE ALSO
143              
144             Stripe API documentation:
145              
146             L<https://stripe.com/docs/api/radar/value_lists>, L<https://stripe.com/docs/radar/lists#managing-list-items>
147              
148             =head1 COPYRIGHT & LICENSE
149              
150             Copyright (c) 2019-2020 DEGUEST Pte. Ltd.
151              
152             You can use, copy, modify and redistribute this package and associated
153             files under the same terms as Perl itself.
154              
155             =cut