9068053662

Committed 13 May 2024 06:34PM UTC coverage: 96.395% (+0.02%) from 96.375%

Build # 9068053662

Build Type

Pull #1328

github

Committed by

web-flow

Commit Message

Merge 6c988eb81 into 46edbe3eb

Pull Request Pull Request #1328: Update generated code

Run Details

1288 of 1901 branches covered (67.75%)

Branch coverage included in aggregate %.

151 of 152 new or added lines in 17 files covered. (99.34%)

803 existing lines in 91 files now uncovered.

64401 of 66245 relevant lines covered (97.22%)

0.97 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

92.62

/stripe/radar/_value_list_item.py

# -*- 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._request_options import RequestOptions
from stripe._util import class_method_variant, sanitize_id
from typing import ClassVar, List, Optional, cast, overload
from typing_extensions import Literal, NotRequired, TypedDict, Unpack


class ValueListItem(
    CreateableAPIResource["ValueListItem"],
    DeletableAPIResource["ValueListItem"],
    ListableAPIResource["ValueListItem"],
):
    """
    Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.

    Related guide: [Managing list items](https://stripe.com/docs/radar/lists#managing-list-items)
    """

    OBJECT_NAME: ClassVar[Literal["radar.value_list_item"]] = (
        "radar.value_list_item"
    )

    class CreateParams(RequestOptions):
        expand: NotRequired[List[str]]
        """
        Specifies which fields in the response should be expanded.
        """
        value: str
        """
        The value of the item (whose type must match the type of the parent value list).
        """
        value_list: str
        """
        The identifier of the value list which the created item will be added to.
        """

    class DeleteParams(RequestOptions):
        pass

    class ListParams(RequestOptions):
        created: NotRequired["ValueListItem.ListParamsCreated|int"]
        """
        Only return items that were created during the given date interval.
        """
        ending_before: NotRequired[str]
        """
        A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
        """
        expand: NotRequired[List[str]]
        """
        Specifies which fields in the response should be expanded.
        """
        limit: NotRequired[int]
        """
        A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
        """
        starting_after: NotRequired[str]
        """
        A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
        """
        value: NotRequired[str]
        """
        Return items belonging to the parent list whose value matches the specified value (using an "is like" match).
        """
        value_list: str
        """
        Identifier for the parent value list this item belongs to.
        """

    class ListParamsCreated(TypedDict):
        gt: NotRequired[int]
        """
        Minimum value to filter by (exclusive)
        """
        gte: NotRequired[int]
        """
        Minimum value to filter by (inclusive)
        """
        lt: NotRequired[int]
        """
        Maximum value to filter by (exclusive)
        """
        lte: NotRequired[int]
        """
        Maximum value to filter by (inclusive)
        """

    class RetrieveParams(RequestOptions):
        expand: NotRequired[List[str]]
        """
        Specifies which fields in the response should be expanded.
        """

    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 added this item to the value list.
    """
    id: str
    """
    Unique identifier for the object.
    """
    livemode: bool
    """
    Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
    """
    object: Literal["radar.value_list_item"]
    """
    String representing the object's type. Objects of the same type share the same value.
    """
    value: str
    """
    The value of the item.
    """
    value_list: str
    """
    The identifier of the value list this item belongs to.
    """
    deleted: Optional[Literal[True]]
    """
    Always true for a deleted object
    """

    @classmethod
    def create(
        cls, **params: Unpack["ValueListItem.CreateParams"]
    ) -> "ValueListItem":
        """
        Creates a new ValueListItem object, which is added to the specified parent value list.
        """
        return cast(
            "ValueListItem",
            cls._static_request(
                "post",
                cls.class_url(),
                params=params,
            ),
        )

    @classmethod
    async def create_async(
        cls, **params: Unpack["ValueListItem.CreateParams"]
    ) -> "ValueListItem":
        """
        Creates a new ValueListItem object, which is added to the specified parent value list.
        """
        return cast(
            "ValueListItem",
            await cls._static_request_async(
                "post",
                cls.class_url(),
                params=params,
            ),
        )

    @classmethod
    def _cls_delete(
        cls, sid: str, **params: Unpack["ValueListItem.DeleteParams"]
    ) -> "ValueListItem":
        """
        Deletes a ValueListItem object, removing it from its parent value list.
        """
        url = "%s/%s" % (cls.class_url(), sanitize_id(sid))
        return cast(
            "ValueListItem",
            cls._static_request(
                "delete",
                url,
                params=params,
            ),
        )

    @overload
    @staticmethod
    def delete(
        sid: str, **params: Unpack["ValueListItem.DeleteParams"]
    ) -> "ValueListItem":
        """
        Deletes a ValueListItem object, removing it from its parent value list.
        """
        ...

    @overload
    def delete(
        self, **params: Unpack["ValueListItem.DeleteParams"]
    ) -> "ValueListItem":
        """
        Deletes a ValueListItem object, removing it from its parent value list.
        """
        ...

    @class_method_variant("_cls_delete")
    def delete(  # pyright: ignore[reportGeneralTypeIssues]
        self, **params: Unpack["ValueListItem.DeleteParams"]
    ) -> "ValueListItem":
        """
        Deletes a ValueListItem object, removing it from its parent value list.
        """
        return self._request_and_refresh(
            "delete",
            self.instance_url(),
            params=params,
        )

    @classmethod
    async def _cls_delete_async(
        cls, sid: str, **params: Unpack["ValueListItem.DeleteParams"]
    ) -> "ValueListItem":
        """
        Deletes a ValueListItem object, removing it from its parent value list.
        """
        url = "%s/%s" % (cls.class_url(), sanitize_id(sid))
        return cast(
            "ValueListItem",
            await cls._static_request_async(
                "delete",
                url,
                params=params,
            ),
        )

    @overload
    @staticmethod
    async def delete_async(
        sid: str, **params: Unpack["ValueListItem.DeleteParams"]
    ) -> "ValueListItem":
        """
        Deletes a ValueListItem object, removing it from its parent value list.
        """
        ...

    @overload
    async def delete_async(
        self, **params: Unpack["ValueListItem.DeleteParams"]
    ) -> "ValueListItem":
        """
        Deletes a ValueListItem object, removing it from its parent value list.
        """
        ...

    @class_method_variant("_cls_delete_async")
    async def delete_async(  # pyright: ignore[reportGeneralTypeIssues]
        self, **params: Unpack["ValueListItem.DeleteParams"]
    ) -> "ValueListItem":
        """
        Deletes a ValueListItem object, removing it from its parent value list.
        """
        return await self._request_and_refresh_async(
            "delete",
            self.instance_url(),
            params=params,
        )

    @classmethod
    def list(
        cls, **params: Unpack["ValueListItem.ListParams"]
    ) -> ListObject["ValueListItem"]:
        """
        Returns a list of ValueListItem 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["ValueListItem.ListParams"]
    ) -> ListObject["ValueListItem"]:
        """
        Returns a list of ValueListItem 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 retrieve(
        cls, id: str, **params: Unpack["ValueListItem.RetrieveParams"]
    ) -> "ValueListItem":
        """
        Retrieves a ValueListItem object.
        """
        instance = cls(id, **params)
        instance.refresh()
        return instance

    @classmethod
    async def retrieve_async(
        cls, id: str, **params: Unpack["ValueListItem.RetrieveParams"]
    ) -> "ValueListItem":
        """
        Retrieves a ValueListItem object.
        """
        instance = cls(id, **params)
        await instance.refresh_async()
        return instance

1	# -- coding: utf-8 --
2	# File generated from our OpenAPI spec
3	from stripe._createable_api_resource import CreateableAPIResource	1✔
4	from stripe._deletable_api_resource import DeletableAPIResource	1✔
5	from stripe._list_object import ListObject	1✔
6	from stripe._listable_api_resource import ListableAPIResource	1✔
7	from stripe._request_options import RequestOptions	1✔
8	from stripe._util import class_method_variant, sanitize_id	1✔
9	from typing import ClassVar, List, Optional, cast, overload	1✔
10	from typing_extensions import Literal, NotRequired, TypedDict, Unpack	1✔
11
12
13	class ValueListItem(	1✔
14	CreateableAPIResource["ValueListItem"],
15	DeletableAPIResource["ValueListItem"],
16	ListableAPIResource["ValueListItem"],
17	):
18	"""
19	Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.
20
21	Related guide: [Managing list items](https://stripe.com/docs/radar/lists#managing-list-items)
22	"""
23
24	OBJECT_NAME: ClassVar[Literal["radar.value_list_item"]] = (	1✔
25	"radar.value_list_item"
26	)
27
28	class CreateParams(RequestOptions):	1✔
29	expand: NotRequired[List[str]]	1✔
30	"""	1✔
31	Specifies which fields in the response should be expanded.
32	"""
33	value: str	1✔
34	"""	1✔
35	The value of the item (whose type must match the type of the parent value list).
36	"""
37	value_list: str	1✔
38	"""	1✔
39	The identifier of the value list which the created item will be added to.
40	"""
41
42	class DeleteParams(RequestOptions):	1✔
43	pass	1✔
44
45	class ListParams(RequestOptions):	1✔
46	created: NotRequired["ValueListItem.ListParamsCreated\|int"]	1✔
47	"""	1✔
48	Only return items that were created during the given date interval.
49	"""
50	ending_before: NotRequired[str]	1✔
51	"""	1✔
52	A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.
53	"""
54	expand: NotRequired[List[str]]	1✔
55	"""	1✔
56	Specifies which fields in the response should be expanded.
57	"""
58	limit: NotRequired[int]	1✔
59	"""	1✔
60	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
61	"""
62	starting_after: NotRequired[str]	1✔
63	"""	1✔
64	A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.
65	"""
66	value: NotRequired[str]	1✔
67	"""	1✔
68	Return items belonging to the parent list whose value matches the specified value (using an "is like" match).
69	"""
70	value_list: str	1✔
71	"""	1✔
72	Identifier for the parent value list this item belongs to.
73	"""
74
75	class ListParamsCreated(TypedDict):	1✔
76	gt: NotRequired[int]	1✔
77	"""	1✔
78	Minimum value to filter by (exclusive)
79	"""
80	gte: NotRequired[int]	1✔
81	"""	1✔
82	Minimum value to filter by (inclusive)
83	"""
84	lt: NotRequired[int]	1✔
85	"""	1✔
86	Maximum value to filter by (exclusive)
87	"""
88	lte: NotRequired[int]	1✔
89	"""	1✔
90	Maximum value to filter by (inclusive)
91	"""
92
93	class RetrieveParams(RequestOptions):	1✔
94	expand: NotRequired[List[str]]	1✔
95	"""	1✔
96	Specifies which fields in the response should be expanded.
97	"""
98
99	created: int	1✔
100	"""	1✔
101	Time at which the object was created. Measured in seconds since the Unix epoch.
102	"""
103	created_by: str	1✔
104	"""	1✔
105	The name or email address of the user who added this item to the value list.
106	"""
107	id: str	1✔
108	"""	1✔
109	Unique identifier for the object.
110	"""
111	livemode: bool	1✔
112	"""	1✔
113	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
114	"""
115	object: Literal["radar.value_list_item"]	1✔
116	"""	1✔
117	String representing the object's type. Objects of the same type share the same value.
118	"""
119	value: str	1✔
120	"""	1✔
121	The value of the item.
122	"""
123	value_list: str	1✔
124	"""	1✔
125	The identifier of the value list this item belongs to.
126	"""
127	deleted: Optional[Literal[True]]	1✔
128	"""	1✔
129	Always true for a deleted object
130	"""
131
132	@classmethod	1✔
133	def create(	1✔
134	cls, **params: Unpack["ValueListItem.CreateParams"]
135	) -> "ValueListItem":
136	"""
137	Creates a new ValueListItem object, which is added to the specified parent value list.
138	"""
139	return cast(	1✔
140	"ValueListItem",
141	cls._static_request(
142	"post",
143	cls.class_url(),
144	params=params,
145	),
146	)
147
148	@classmethod	1✔
149	async def create_async(	1✔
150	cls, **params: Unpack["ValueListItem.CreateParams"]
151	) -> "ValueListItem":
152	"""
153	Creates a new ValueListItem object, which is added to the specified parent value list.
154	"""
155	return cast(	1✔
156	"ValueListItem",
157	await cls._static_request_async(
158	"post",
159	cls.class_url(),
160	params=params,
161	),
162	)
163
164	@classmethod	1✔
165	def _cls_delete(	1✔
166	cls, sid: str, **params: Unpack["ValueListItem.DeleteParams"]
167	) -> "ValueListItem":
168	"""
169	Deletes a ValueListItem object, removing it from its parent value list.
170	"""
171	url = "%s/%s" % (cls.class_url(), sanitize_id(sid))	1✔
172	return cast(	1✔
173	"ValueListItem",
174	cls._static_request(
175	"delete",
176	url,
177	params=params,
178	),
179	)
180
181	@overload	1✔
182	@staticmethod	1✔
183	def delete(	1✔
184	sid: str, **params: Unpack["ValueListItem.DeleteParams"]
185	) -> "ValueListItem":
186	"""
187	Deletes a ValueListItem object, removing it from its parent value list.
188	"""
189	...	×
190
191	@overload	1✔
192	def delete(	1✔
193	self, **params: Unpack["ValueListItem.DeleteParams"]
194	) -> "ValueListItem":
195	"""
196	Deletes a ValueListItem object, removing it from its parent value list.
197	"""
198	...	×
199
200	@class_method_variant("_cls_delete")	1✔
201	def delete( # pyright: ignore[reportGeneralTypeIssues]	1✔
202	self, **params: Unpack["ValueListItem.DeleteParams"]
203	) -> "ValueListItem":
204	"""
205	Deletes a ValueListItem object, removing it from its parent value list.
206	"""
207	return self._request_and_refresh(	1✔
208	"delete",
209	self.instance_url(),
210	params=params,
211	)
212
213	@classmethod	1✔
214	async def _cls_delete_async(	1✔
215	cls, sid: str, **params: Unpack["ValueListItem.DeleteParams"]
216	) -> "ValueListItem":
217	"""
218	Deletes a ValueListItem object, removing it from its parent value list.
219	"""
220	url = "%s/%s" % (cls.class_url(), sanitize_id(sid))	1✔
221	return cast(	1✔
222	"ValueListItem",
223	await cls._static_request_async(
224	"delete",
225	url,
226	params=params,
227	),
228	)
229
230	@overload	1✔
231	@staticmethod	1✔
232	async def delete_async(	1✔
233	sid: str, **params: Unpack["ValueListItem.DeleteParams"]
234	) -> "ValueListItem":
235	"""
236	Deletes a ValueListItem object, removing it from its parent value list.
237	"""
238	...	×
239
240	@overload	1✔
241	async def delete_async(	1✔
242	self, **params: Unpack["ValueListItem.DeleteParams"]
243	) -> "ValueListItem":
244	"""
245	Deletes a ValueListItem object, removing it from its parent value list.
246	"""
247	...	×
248
249	@class_method_variant("_cls_delete_async")	1✔
250	async def delete_async( # pyright: ignore[reportGeneralTypeIssues]	1✔
251	self, **params: Unpack["ValueListItem.DeleteParams"]
252	) -> "ValueListItem":
253	"""
254	Deletes a ValueListItem object, removing it from its parent value list.
255	"""
256	return await self._request_and_refresh_async(	×
257	"delete",
258	self.instance_url(),
259	params=params,
260	)
261
262	@classmethod	1✔
263	def list(	1✔
264	cls, **params: Unpack["ValueListItem.ListParams"]
265	) -> ListObject["ValueListItem"]:
266	"""
267	Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
268	"""
269	result = cls._static_request(	1✔
270	"get",
271	cls.class_url(),
272	params=params,
273	)
274	if not isinstance(result, ListObject):	1!
UNCOV 275	raise TypeError(	×
276	"Expected list object from API, got %s"
277	% (type(result).__name__)
278	)
279
280	return result	1✔
281
282	@classmethod	1✔
283	async def list_async(	1✔
284	cls, **params: Unpack["ValueListItem.ListParams"]
285	) -> ListObject["ValueListItem"]:
286	"""
287	Returns a list of ValueListItem objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
288	"""
289	result = await cls._static_request_async(	1✔
290	"get",
291	cls.class_url(),
292	params=params,
293	)
294	if not isinstance(result, ListObject):	1!
UNCOV 295	raise TypeError(	×
296	"Expected list object from API, got %s"
297	% (type(result).__name__)
298	)
299
300	return result	1✔
301
302	@classmethod	1✔
303	def retrieve(	1✔
304	cls, id: str, **params: Unpack["ValueListItem.RetrieveParams"]
305	) -> "ValueListItem":
306	"""
307	Retrieves a ValueListItem object.
308	"""
309	instance = cls(id, **params)	1✔
310	instance.refresh()	1✔
311	return instance	1✔
312
313	@classmethod	1✔
314	async def retrieve_async(	1✔
315	cls, id: str, **params: Unpack["ValueListItem.RetrieveParams"]
316	) -> "ValueListItem":
317	"""
318	Retrieves a ValueListItem object.
319	"""
320	instance = cls(id, **params)	1✔
321	await instance.refresh_async()	1✔
322	return instance	1✔

stripe / stripe-python / 9068053662

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous