# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._createable_api_resource import CreateableAPIResource
from stripe._deletable_api_resource import DeletableAPIResource
from stripe._list_object import ListObject
from stripe._listable_api_resource import ListableAPIResource
from stripe._stripe_object import UntypedStripeObject
from stripe._updateable_api_resource import UpdateableAPIResource
from stripe._util import class_method_variant, sanitize_id
from typing import ClassVar, Optional, cast, overload
from typing_extensions import Literal, Unpack, TYPE_CHECKING
if TYPE_CHECKING:
from stripe.params.radar._value_list_create_params import (
ValueListCreateParams,
)
from stripe.params.radar._value_list_delete_params import (
ValueListDeleteParams,
)
from stripe.params.radar._value_list_list_params import ValueListListParams
from stripe.params.radar._value_list_modify_params import (
ValueListModifyParams,
)
from stripe.params.radar._value_list_retrieve_params import (
ValueListRetrieveParams,
)
from stripe.radar._value_list_item import ValueListItem
class ValueList(
CreateableAPIResource["ValueList"],
DeletableAPIResource["ValueList"],
ListableAPIResource["ValueList"],
UpdateableAPIResource["ValueList"],
):
"""
Value lists allow you to group values together which can then be referenced in rules.
Related guide: [Default Stripe lists](https://docs.stripe.com/radar/lists#managing-list-items)
"""
OBJECT_NAME: ClassVar[Literal["radar.value_list"]] = "radar.value_list"
alias: str
"""
The name of the value list for use in rules.
"""
created: int
"""
Time at which the object was created. Measured in seconds since the Unix epoch.
"""
created_by: str
"""
The name or email address of the user who created this value list.
"""
deleted: Optional[Literal[True]]
"""
Always true for a deleted object
"""
id: str
"""
Unique identifier for the object.
"""
item_type: Literal[
"account",
"card_bin",
"card_fingerprint",
"case_sensitive_string",
"country",
"crypto_fingerprint",
"customer_id",
"email",
"ip_address",
"sepa_debit_fingerprint",
"string",
"us_bank_account_fingerprint",
]
"""
The type of items in the value list. One of `card_fingerprint`, `card_bin`, `crypto_fingerprint`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, `customer_id`, `account`, `sepa_debit_fingerprint`, or `us_bank_account_fingerprint`.
"""
list_items: ListObject["ValueListItem"]
"""
List of items contained within this value list.
"""
livemode: bool
"""
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
"""
metadata: UntypedStripeObject[str]
"""
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
"""
name: str
"""
The name of the value list.
"""
object: Literal["radar.value_list"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
@classmethod
def create(cls, **params: Unpack["ValueListCreateParams"]) -> "ValueList":
"""
Creates a new ValueList object, which can then be referenced in rules.
"""
return cast(
"ValueList",
cls._static_request(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
async def create_async(
cls, **params: Unpack["ValueListCreateParams"]
) -> "ValueList":
"""
Creates a new ValueList object, which can then be referenced in rules.
"""
return cast(
"ValueList",
await cls._static_request_async(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
def _cls_delete(
cls, sid: str, **params: Unpack["ValueListDeleteParams"]
) -> "ValueList":
"""
Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(sid))
return cast(
"ValueList",
cls._static_request(
"delete",
url,
params=params,
),
)
@overload
@staticmethod
def delete(
sid: str, **params: Unpack["ValueListDeleteParams"]
) -> "ValueList":
"""
Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.
"""
...
@overload
def delete(self, **params: Unpack["ValueListDeleteParams"]) -> "ValueList":
"""
Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.
"""
...
@class_method_variant("_cls_delete")
def delete( # pyright: ignore[reportGeneralTypeIssues]
self, **params: Unpack["ValueListDeleteParams"]
) -> "ValueList":
"""
Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.
"""
return self._request_and_refresh(
"delete",
self.instance_url(),
params=params,
)
@classmethod
async def _cls_delete_async(
cls, sid: str, **params: Unpack["ValueListDeleteParams"]
) -> "ValueList":
"""
Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(sid))
return cast(
"ValueList",
await cls._static_request_async(
"delete",
url,
params=params,
),
)
@overload
@staticmethod
async def delete_async(
sid: str, **params: Unpack["ValueListDeleteParams"]
) -> "ValueList":
"""
Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.
"""
...
@overload
async def delete_async(
self, **params: Unpack["ValueListDeleteParams"]
) -> "ValueList":
"""
Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.
"""
...
@class_method_variant("_cls_delete_async")
async def delete_async( # pyright: ignore[reportGeneralTypeIssues]
self, **params: Unpack["ValueListDeleteParams"]
) -> "ValueList":
"""
Deletes a ValueList object, also deleting any items contained within the value list. To be deleted, a value list must not be referenced in any rules.
"""
return await self._request_and_refresh_async(
"delete",
self.instance_url(),
params=params,
)
@classmethod
def list(
cls, **params: Unpack["ValueListListParams"]
) -> ListObject["ValueList"]:
"""
Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
"""
result = cls._static_request(
"get",
cls.class_url(),
params=params,
)
if not isinstance(result, ListObject):
raise TypeError(
"Expected list object from API, got %s"
% (type(result).__name__)
)
return result
@classmethod
async def list_async(
cls, **params: Unpack["ValueListListParams"]
) -> ListObject["ValueList"]:
"""
Returns a list of ValueList objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
"""
result = await cls._static_request_async(
"get",
cls.class_url(),
params=params,
)
if not isinstance(result, ListObject):
raise TypeError(
"Expected list object from API, got %s"
% (type(result).__name__)
)
return result
@classmethod
def modify(
cls, id: str, **params: Unpack["ValueListModifyParams"]
) -> "ValueList":
"""
Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return cast(
"ValueList",
cls._static_request(
"post",
url,
params=params,
),
)
@classmethod
async def modify_async(
cls, id: str, **params: Unpack["ValueListModifyParams"]
) -> "ValueList":
"""
Updates a ValueList object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Note that item_type is immutable.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return cast(
"ValueList",
await cls._static_request_async(
"post",
url,
params=params,
),
)
@classmethod
def retrieve(
cls, id: str, **params: Unpack["ValueListRetrieveParams"]
) -> "ValueList":
"""
Retrieves a ValueList object.
"""
instance = cls(id, **params)
instance.refresh()
return instance
@classmethod
async def retrieve_async(
cls, id: str, **params: Unpack["ValueListRetrieveParams"]
) -> "ValueList":
"""
Retrieves a ValueList object.
"""
instance = cls(id, **params)
await instance.refresh_async()
return instance