NAME

Net::API::Stripe::Fraud::ValueList - A Stripe Value List Object

SYNOPSIS

my $list = $stripe->value_list({
    alias => 'custom_ip_blocklist',
    created_by => 'john.doe@example.com',
    item_type => 'ip_address',
    list_items => $list_object,
    metadata => { transaction_id => 123 },
    name => 'Custom IP Blocklist',
});

See documentation in Net::API::Stripe for example to make api calls to Stripe to create those objects.

VERSION

v0.100.0

DESCRIPTION

Value lists allow you to group values together which can then be referenced in rules.

CONSTRUCTOR

new( %ARG )

Creates a new Net::API::Stripe::Fraud::ValueList object.

METHODS

id string

Unique identifier for the object.

object string, value is "radar.value_list"

String representing the object’s type. Objects of the same type share the same value.

alias string

The name of the value list for use in rules.

created timestamp

Time at which the object was created. Measured in seconds since the Unix epoch.

created_by string

The name or email address of the user who created this value list.

item_type string

The type of items in the value list. One of card_fingerprint, card_bin, email, ip_address, country, string, or case_sensitive_string.

list_items list

List of items contained within this value list.

This is a Net::API::Stripe::List object with array of Net::API::Stripe::Fraud::List::Item objects.

livemode boolean

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadata hash

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.

name string

The name of the value list.

API SAMPLE

{
  "id": "rsl_fake123456789",
  "object": "radar.value_list",
  "alias": "custom_ip_blocklist",
  "created": 1571480456,
  "created_by": "jenny@example.com",
  "item_type": "ip_address",
  "list_items": {
    "object": "list",
    "data": [],
    "has_more": false,
    "url": "/v1/radar/value_list_items?value_list=rsl_fake123456789"
  },
  "livemode": false,
  "metadata": {},
  "name": "Custom IP Blocklist"
}

HISTORY

v0.1

Initial version

AUTHOR

Jacques Deguest <jack@deguest.jp>

SEE ALSO

Stripe API documentation:

https://stripe.com/docs/api/radar/value_lists, https://stripe.com/docs/radar/lists#managing-list-items

COPYRIGHT & LICENSE

Copyright (c) 2019-2020 DEGUEST Pte. Ltd.

You can use, copy, modify and redistribute this package and associated files under the same terms as Perl itself.

cpanm Net::API::Stripe

perl -MCPAN -e shell
install Net::API::Stripe