10101774768

Committed 25 Jul 2024 09:28PM UTC coverage: 96.392% (-0.05%) from 96.446%

Build # 10101774768

Build Type

push

github

Committed by

web-flow

Commit Message

Merge pull request #1361 from stripe/latest-codegen-beta

Update generated code for beta

Run Details

1343 of 2037 branches covered (65.93%)

Branch coverage included in aggregate %.

692 of 758 new or added lines in 32 files covered. (91.29%)

1 existing line in 1 file now uncovered.

84468 of 86986 relevant lines covered (97.11%)

0.97 hits per line

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

76.38

/stripe/billing/_alert.py

# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._createable_api_resource import CreateableAPIResource
from stripe._expandable_field import ExpandableField
from stripe._list_object import ListObject
from stripe._listable_api_resource import ListableAPIResource
from stripe._request_options import RequestOptions
from stripe._stripe_object import StripeObject
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,
    TYPE_CHECKING,
)

if TYPE_CHECKING:
    from stripe._customer import Customer
    from stripe.billing._meter import Meter


class Alert(CreateableAPIResource["Alert"], ListableAPIResource["Alert"]):
    """
    A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.
    """

    OBJECT_NAME: ClassVar[Literal["billing.alert"]] = "billing.alert"

    class Filter(StripeObject):
        customer: Optional[ExpandableField["Customer"]]
        """
        Limit the scope of the alert to this customer ID
        """

    class UsageThresholdConfig(StripeObject):
        gte: int
        """
        The value at which this alert will trigger.
        """
        meter: ExpandableField["Meter"]
        """
        The [Billing Meter](https://stripe.com/api/billing/meter) ID whose usage is monitored.
        """
        recurrence: Literal["one_time"]
        """
        Defines how the alert will behave.
        """

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

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

    class CreateParams(RequestOptions):
        alert_type: Literal["usage_threshold"]
        """
        The type of alert to create.
        """
        expand: NotRequired[List[str]]
        """
        Specifies which fields in the response should be expanded.
        """
        filter: NotRequired["Alert.CreateParamsFilter"]
        """
        Filters to limit the scope of an alert.
        """
        title: str
        """
        The title of the alert.
        """
        usage_threshold_config: NotRequired[
            "Alert.CreateParamsUsageThresholdConfig"
        ]
        """
        The configuration of the usage threshold.
        """

    class CreateParamsFilter(TypedDict):
        customer: NotRequired[str]
        """
        Limit the scope to this alert only to this customer.
        """

    class CreateParamsUsageThresholdConfig(TypedDict):
        gte: int
        """
        Defines at which value the alert will fire.
        """
        meter: NotRequired[str]
        """
        The [Billing Meter](https://stripe.com/api/billing/meter) ID whose usage is monitored.
        """
        recurrence: Literal["one_time"]
        """
        Whether the alert should only fire only once, or once per billing cycle.
        """

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

    class ListParams(RequestOptions):
        alert_type: NotRequired[Literal["usage_threshold"]]
        """
        Filter results to only include this type of alert.
        """
        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.
        """
        meter: NotRequired[str]
        """
        Filter results to only include alerts with the given meter.
        """
        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.
        """

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

    alert_type: Literal["usage_threshold"]
    """
    Defines the type of the alert.
    """
    filter: Optional[Filter]
    """
    Limits the scope of the alert to a specific [customer](https://stripe.com/docs/api/customers).
    """
    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["billing.alert"]
    """
    String representing the object's type. Objects of the same type share the same value.
    """
    status: Optional[Literal["active", "archived", "inactive"]]
    """
    Status of the alert. This can be active, inactive or archived.
    """
    title: str
    """
    Title of the alert.
    """
    usage_threshold_config: Optional[UsageThresholdConfig]
    """
    Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter).
    """

    @classmethod
    def _cls_activate(
        cls, id: str, **params: Unpack["Alert.ActivateParams"]
    ) -> "Alert":
        """
        Reactivates this alert, allowing it to trigger again.
        """
        return cast(
            "Alert",
            cls._static_request(
                "post",
                "/v1/billing/alerts/{id}/activate".format(id=sanitize_id(id)),
                params=params,
            ),
        )

    @overload
    @staticmethod
    def activate(id: str, **params: Unpack["Alert.ActivateParams"]) -> "Alert":
        """
        Reactivates this alert, allowing it to trigger again.
        """
        ...

    @overload
    def activate(self, **params: Unpack["Alert.ActivateParams"]) -> "Alert":
        """
        Reactivates this alert, allowing it to trigger again.
        """
        ...

    @class_method_variant("_cls_activate")
    def activate(  # pyright: ignore[reportGeneralTypeIssues]
        self, **params: Unpack["Alert.ActivateParams"]
    ) -> "Alert":
        """
        Reactivates this alert, allowing it to trigger again.
        """
        return cast(
            "Alert",
            self._request(
                "post",
                "/v1/billing/alerts/{id}/activate".format(
                    id=sanitize_id(self.get("id"))
                ),
                params=params,
            ),
        )

    @classmethod
    async def _cls_activate_async(
        cls, id: str, **params: Unpack["Alert.ActivateParams"]
    ) -> "Alert":
        """
        Reactivates this alert, allowing it to trigger again.
        """
        return cast(
            "Alert",
            await cls._static_request_async(
                "post",
                "/v1/billing/alerts/{id}/activate".format(id=sanitize_id(id)),
                params=params,
            ),
        )

    @overload
    @staticmethod
    async def activate_async(
        id: str, **params: Unpack["Alert.ActivateParams"]
    ) -> "Alert":
        """
        Reactivates this alert, allowing it to trigger again.
        """
        ...

    @overload
    async def activate_async(
        self, **params: Unpack["Alert.ActivateParams"]
    ) -> "Alert":
        """
        Reactivates this alert, allowing it to trigger again.
        """
        ...

    @class_method_variant("_cls_activate_async")
    async def activate_async(  # pyright: ignore[reportGeneralTypeIssues]
        self, **params: Unpack["Alert.ActivateParams"]
    ) -> "Alert":
        """
        Reactivates this alert, allowing it to trigger again.
        """
        return cast(
            "Alert",
            await self._request_async(
                "post",
                "/v1/billing/alerts/{id}/activate".format(
                    id=sanitize_id(self.get("id"))
                ),
                params=params,
            ),
        )

    @classmethod
    def _cls_archive(
        cls, id: str, **params: Unpack["Alert.ArchiveParams"]
    ) -> "Alert":
        """
        Archives this alert, removing it from the list view and APIs. This is non-reversible.
        """
        return cast(
            "Alert",
            cls._static_request(
                "post",
                "/v1/billing/alerts/{id}/archive".format(id=sanitize_id(id)),
                params=params,
            ),
        )

    @overload
    @staticmethod
    def archive(id: str, **params: Unpack["Alert.ArchiveParams"]) -> "Alert":
        """
        Archives this alert, removing it from the list view and APIs. This is non-reversible.
        """
        ...

    @overload
    def archive(self, **params: Unpack["Alert.ArchiveParams"]) -> "Alert":
        """
        Archives this alert, removing it from the list view and APIs. This is non-reversible.
        """
        ...

    @class_method_variant("_cls_archive")
    def archive(  # pyright: ignore[reportGeneralTypeIssues]
        self, **params: Unpack["Alert.ArchiveParams"]
    ) -> "Alert":
        """
        Archives this alert, removing it from the list view and APIs. This is non-reversible.
        """
        return cast(
            "Alert",
            self._request(
                "post",
                "/v1/billing/alerts/{id}/archive".format(
                    id=sanitize_id(self.get("id"))
                ),
                params=params,
            ),
        )

    @classmethod
    async def _cls_archive_async(
        cls, id: str, **params: Unpack["Alert.ArchiveParams"]
    ) -> "Alert":
        """
        Archives this alert, removing it from the list view and APIs. This is non-reversible.
        """
        return cast(
            "Alert",
            await cls._static_request_async(
                "post",
                "/v1/billing/alerts/{id}/archive".format(id=sanitize_id(id)),
                params=params,
            ),
        )

    @overload
    @staticmethod
    async def archive_async(
        id: str, **params: Unpack["Alert.ArchiveParams"]
    ) -> "Alert":
        """
        Archives this alert, removing it from the list view and APIs. This is non-reversible.
        """
        ...

    @overload
    async def archive_async(
        self, **params: Unpack["Alert.ArchiveParams"]
    ) -> "Alert":
        """
        Archives this alert, removing it from the list view and APIs. This is non-reversible.
        """
        ...

    @class_method_variant("_cls_archive_async")
    async def archive_async(  # pyright: ignore[reportGeneralTypeIssues]
        self, **params: Unpack["Alert.ArchiveParams"]
    ) -> "Alert":
        """
        Archives this alert, removing it from the list view and APIs. This is non-reversible.
        """
        return cast(
            "Alert",
            await self._request_async(
                "post",
                "/v1/billing/alerts/{id}/archive".format(
                    id=sanitize_id(self.get("id"))
                ),
                params=params,
            ),
        )

    @classmethod
    def create(cls, **params: Unpack["Alert.CreateParams"]) -> "Alert":
        """
        Creates a billing alert
        """
        return cast(
            "Alert",
            cls._static_request(
                "post",
                cls.class_url(),
                params=params,
            ),
        )

    @classmethod
    async def create_async(
        cls, **params: Unpack["Alert.CreateParams"]
    ) -> "Alert":
        """
        Creates a billing alert
        """
        return cast(
            "Alert",
            await cls._static_request_async(
                "post",
                cls.class_url(),
                params=params,
            ),
        )

    @classmethod
    def _cls_deactivate(
        cls, id: str, **params: Unpack["Alert.DeactivateParams"]
    ) -> "Alert":
        """
        Deactivates this alert, preventing it from triggering.
        """
        return cast(
            "Alert",
            cls._static_request(
                "post",
                "/v1/billing/alerts/{id}/deactivate".format(
                    id=sanitize_id(id)
                ),
                params=params,
            ),
        )

    @overload
    @staticmethod
    def deactivate(
        id: str, **params: Unpack["Alert.DeactivateParams"]
    ) -> "Alert":
        """
        Deactivates this alert, preventing it from triggering.
        """
        ...

    @overload
    def deactivate(
        self, **params: Unpack["Alert.DeactivateParams"]
    ) -> "Alert":
        """
        Deactivates this alert, preventing it from triggering.
        """
        ...

    @class_method_variant("_cls_deactivate")
    def deactivate(  # pyright: ignore[reportGeneralTypeIssues]
        self, **params: Unpack["Alert.DeactivateParams"]
    ) -> "Alert":
        """
        Deactivates this alert, preventing it from triggering.
        """
        return cast(
            "Alert",
            self._request(
                "post",
                "/v1/billing/alerts/{id}/deactivate".format(
                    id=sanitize_id(self.get("id"))
                ),
                params=params,
            ),
        )

    @classmethod
    async def _cls_deactivate_async(
        cls, id: str, **params: Unpack["Alert.DeactivateParams"]
    ) -> "Alert":
        """
        Deactivates this alert, preventing it from triggering.
        """
        return cast(
            "Alert",
            await cls._static_request_async(
                "post",
                "/v1/billing/alerts/{id}/deactivate".format(
                    id=sanitize_id(id)
                ),
                params=params,
            ),
        )

    @overload
    @staticmethod
    async def deactivate_async(
        id: str, **params: Unpack["Alert.DeactivateParams"]
    ) -> "Alert":
        """
        Deactivates this alert, preventing it from triggering.
        """
        ...

    @overload
    async def deactivate_async(
        self, **params: Unpack["Alert.DeactivateParams"]
    ) -> "Alert":
        """
        Deactivates this alert, preventing it from triggering.
        """
        ...

    @class_method_variant("_cls_deactivate_async")
    async def deactivate_async(  # pyright: ignore[reportGeneralTypeIssues]
        self, **params: Unpack["Alert.DeactivateParams"]
    ) -> "Alert":
        """
        Deactivates this alert, preventing it from triggering.
        """
        return cast(
            "Alert",
            await self._request_async(
                "post",
                "/v1/billing/alerts/{id}/deactivate".format(
                    id=sanitize_id(self.get("id"))
                ),
                params=params,
            ),
        )

    @classmethod
    def list(cls, **params: Unpack["Alert.ListParams"]) -> ListObject["Alert"]:
        """
        Lists billing active and inactive alerts
        """
        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["Alert.ListParams"]
    ) -> ListObject["Alert"]:
        """
        Lists billing active and inactive alerts
        """
        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["Alert.RetrieveParams"]
    ) -> "Alert":
        """
        Retrieves a billing alert given an ID
        """
        instance = cls(id, **params)
        instance.refresh()
        return instance

    @classmethod
    async def retrieve_async(
        cls, id: str, **params: Unpack["Alert.RetrieveParams"]
    ) -> "Alert":
        """
        Retrieves a billing alert given an ID
        """
        instance = cls(id, **params)
        await instance.refresh_async()
        return instance

    _inner_class_types = {
        "filter": Filter,
        "usage_threshold_config": UsageThresholdConfig,
    }

1	# -- coding: utf-8 --
2	# File generated from our OpenAPI spec
3	from stripe._createable_api_resource import CreateableAPIResource	1✔
4	from stripe._expandable_field import ExpandableField	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._stripe_object import StripeObject	1✔
9	from stripe._util import class_method_variant, sanitize_id	1✔
10	from typing import ClassVar, List, Optional, cast, overload	1✔
11	from typing_extensions import (	1✔
12	Literal,
13	NotRequired,
14	TypedDict,
15	Unpack,
16	TYPE_CHECKING,
17	)
18
19	if TYPE_CHECKING:	1!
NEW 20	from stripe._customer import Customer	×
NEW 21	from stripe.billing._meter import Meter	×
22
23
24	class Alert(CreateableAPIResource["Alert"], ListableAPIResource["Alert"]):	1✔
25	"""
26	A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.
27	"""
28
29	OBJECT_NAME: ClassVar[Literal["billing.alert"]] = "billing.alert"	1✔
30
31	class Filter(StripeObject):	1✔
32	customer: Optional[ExpandableField["Customer"]]	1✔
33	"""	1✔
34	Limit the scope of the alert to this customer ID
35	"""
36
37	class UsageThresholdConfig(StripeObject):	1✔
38	gte: int	1✔
39	"""	1✔
40	The value at which this alert will trigger.
41	"""
42	meter: ExpandableField["Meter"]	1✔
43	"""	1✔
44	The [Billing Meter](https://stripe.com/api/billing/meter) ID whose usage is monitored.
45	"""
46	recurrence: Literal["one_time"]	1✔
47	"""	1✔
48	Defines how the alert will behave.
49	"""
50
51	class ActivateParams(RequestOptions):	1✔
52	expand: NotRequired[List[str]]	1✔
53	"""	1✔
54	Specifies which fields in the response should be expanded.
55	"""
56
57	class ArchiveParams(RequestOptions):	1✔
58	expand: NotRequired[List[str]]	1✔
59	"""	1✔
60	Specifies which fields in the response should be expanded.
61	"""
62
63	class CreateParams(RequestOptions):	1✔
64	alert_type: Literal["usage_threshold"]	1✔
65	"""	1✔
66	The type of alert to create.
67	"""
68	expand: NotRequired[List[str]]	1✔
69	"""	1✔
70	Specifies which fields in the response should be expanded.
71	"""
72	filter: NotRequired["Alert.CreateParamsFilter"]	1✔
73	"""	1✔
74	Filters to limit the scope of an alert.
75	"""
76	title: str	1✔
77	"""	1✔
78	The title of the alert.
79	"""
80	usage_threshold_config: NotRequired[	1✔
81	"Alert.CreateParamsUsageThresholdConfig"
82	]
83	"""	1✔
84	The configuration of the usage threshold.
85	"""
86
87	class CreateParamsFilter(TypedDict):	1✔
88	customer: NotRequired[str]	1✔
89	"""	1✔
90	Limit the scope to this alert only to this customer.
91	"""
92
93	class CreateParamsUsageThresholdConfig(TypedDict):	1✔
94	gte: int	1✔
95	"""	1✔
96	Defines at which value the alert will fire.
97	"""
98	meter: NotRequired[str]	1✔
99	"""	1✔
100	The [Billing Meter](https://stripe.com/api/billing/meter) ID whose usage is monitored.
101	"""
102	recurrence: Literal["one_time"]	1✔
103	"""	1✔
104	Whether the alert should only fire only once, or once per billing cycle.
105	"""
106
107	class DeactivateParams(RequestOptions):	1✔
108	expand: NotRequired[List[str]]	1✔
109	"""	1✔
110	Specifies which fields in the response should be expanded.
111	"""
112
113	class ListParams(RequestOptions):	1✔
114	alert_type: NotRequired[Literal["usage_threshold"]]	1✔
115	"""	1✔
116	Filter results to only include this type of alert.
117	"""
118	ending_before: NotRequired[str]	1✔
119	"""	1✔
120	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.
121	"""
122	expand: NotRequired[List[str]]	1✔
123	"""	1✔
124	Specifies which fields in the response should be expanded.
125	"""
126	limit: NotRequired[int]	1✔
127	"""	1✔
128	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
129	"""
130	meter: NotRequired[str]	1✔
131	"""	1✔
132	Filter results to only include alerts with the given meter.
133	"""
134	starting_after: NotRequired[str]	1✔
135	"""	1✔
136	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.
137	"""
138
139	class RetrieveParams(RequestOptions):	1✔
140	expand: NotRequired[List[str]]	1✔
141	"""	1✔
142	Specifies which fields in the response should be expanded.
143	"""
144
145	alert_type: Literal["usage_threshold"]	1✔
146	"""	1✔
147	Defines the type of the alert.
148	"""
149	filter: Optional[Filter]	1✔
150	"""	1✔
151	Limits the scope of the alert to a specific [customer](https://stripe.com/docs/api/customers).
152	"""
153	id: str	1✔
154	"""	1✔
155	Unique identifier for the object.
156	"""
157	livemode: bool	1✔
158	"""	1✔
159	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
160	"""
161	object: Literal["billing.alert"]	1✔
162	"""	1✔
163	String representing the object's type. Objects of the same type share the same value.
164	"""
165	status: Optional[Literal["active", "archived", "inactive"]]	1✔
166	"""	1✔
167	Status of the alert. This can be active, inactive or archived.
168	"""
169	title: str	1✔
170	"""	1✔
171	Title of the alert.
172	"""
173	usage_threshold_config: Optional[UsageThresholdConfig]	1✔
174	"""	1✔
175	Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://stripe.com/docs/api/billing/meter).
176	"""
177
178	@classmethod	1✔
179	def _cls_activate(	1✔
180	cls, id: str, **params: Unpack["Alert.ActivateParams"]
181	) -> "Alert":
182	"""
183	Reactivates this alert, allowing it to trigger again.
184	"""
NEW 185	return cast(	×
186	"Alert",
187	cls._static_request(
188	"post",
189	"/v1/billing/alerts/{id}/activate".format(id=sanitize_id(id)),
190	params=params,
191	),
192	)
193
194	@overload	1✔
195	@staticmethod	1✔
196	def activate(id: str, **params: Unpack["Alert.ActivateParams"]) -> "Alert":	1✔
197	"""
198	Reactivates this alert, allowing it to trigger again.
199	"""
NEW 200	...	×
201
202	@overload	1✔
203	def activate(self, **params: Unpack["Alert.ActivateParams"]) -> "Alert":	1✔
204	"""
205	Reactivates this alert, allowing it to trigger again.
206	"""
NEW 207	...	×
208
209	@class_method_variant("_cls_activate")	1✔
210	def activate( # pyright: ignore[reportGeneralTypeIssues]	1✔
211	self, **params: Unpack["Alert.ActivateParams"]
212	) -> "Alert":
213	"""
214	Reactivates this alert, allowing it to trigger again.
215	"""
NEW 216	return cast(	×
217	"Alert",
218	self._request(
219	"post",
220	"/v1/billing/alerts/{id}/activate".format(
221	id=sanitize_id(self.get("id"))
222	),
223	params=params,
224	),
225	)
226
227	@classmethod	1✔
228	async def _cls_activate_async(	1✔
229	cls, id: str, **params: Unpack["Alert.ActivateParams"]
230	) -> "Alert":
231	"""
232	Reactivates this alert, allowing it to trigger again.
233	"""
NEW 234	return cast(	×
235	"Alert",
236	await cls._static_request_async(
237	"post",
238	"/v1/billing/alerts/{id}/activate".format(id=sanitize_id(id)),
239	params=params,
240	),
241	)
242
243	@overload	1✔
244	@staticmethod	1✔
245	async def activate_async(	1✔
246	id: str, **params: Unpack["Alert.ActivateParams"]
247	) -> "Alert":
248	"""
249	Reactivates this alert, allowing it to trigger again.
250	"""
NEW 251	...	×
252
253	@overload	1✔
254	async def activate_async(	1✔
255	self, **params: Unpack["Alert.ActivateParams"]
256	) -> "Alert":
257	"""
258	Reactivates this alert, allowing it to trigger again.
259	"""
NEW 260	...	×
261
262	@class_method_variant("_cls_activate_async")	1✔
263	async def activate_async( # pyright: ignore[reportGeneralTypeIssues]	1✔
264	self, **params: Unpack["Alert.ActivateParams"]
265	) -> "Alert":
266	"""
267	Reactivates this alert, allowing it to trigger again.
268	"""
NEW 269	return cast(	×
270	"Alert",
271	await self._request_async(
272	"post",
273	"/v1/billing/alerts/{id}/activate".format(
274	id=sanitize_id(self.get("id"))
275	),
276	params=params,
277	),
278	)
279
280	@classmethod	1✔
281	def _cls_archive(	1✔
282	cls, id: str, **params: Unpack["Alert.ArchiveParams"]
283	) -> "Alert":
284	"""
285	Archives this alert, removing it from the list view and APIs. This is non-reversible.
286	"""
NEW 287	return cast(	×
288	"Alert",
289	cls._static_request(
290	"post",
291	"/v1/billing/alerts/{id}/archive".format(id=sanitize_id(id)),
292	params=params,
293	),
294	)
295
296	@overload	1✔
297	@staticmethod	1✔
298	def archive(id: str, **params: Unpack["Alert.ArchiveParams"]) -> "Alert":	1✔
299	"""
300	Archives this alert, removing it from the list view and APIs. This is non-reversible.
301	"""
NEW 302	...	×
303
304	@overload	1✔
305	def archive(self, **params: Unpack["Alert.ArchiveParams"]) -> "Alert":	1✔
306	"""
307	Archives this alert, removing it from the list view and APIs. This is non-reversible.
308	"""
NEW 309	...	×
310
311	@class_method_variant("_cls_archive")	1✔
312	def archive( # pyright: ignore[reportGeneralTypeIssues]	1✔
313	self, **params: Unpack["Alert.ArchiveParams"]
314	) -> "Alert":
315	"""
316	Archives this alert, removing it from the list view and APIs. This is non-reversible.
317	"""
NEW 318	return cast(	×
319	"Alert",
320	self._request(
321	"post",
322	"/v1/billing/alerts/{id}/archive".format(
323	id=sanitize_id(self.get("id"))
324	),
325	params=params,
326	),
327	)
328
329	@classmethod	1✔
330	async def _cls_archive_async(	1✔
331	cls, id: str, **params: Unpack["Alert.ArchiveParams"]
332	) -> "Alert":
333	"""
334	Archives this alert, removing it from the list view and APIs. This is non-reversible.
335	"""
NEW 336	return cast(	×
337	"Alert",
338	await cls._static_request_async(
339	"post",
340	"/v1/billing/alerts/{id}/archive".format(id=sanitize_id(id)),
341	params=params,
342	),
343	)
344
345	@overload	1✔
346	@staticmethod	1✔
347	async def archive_async(	1✔
348	id: str, **params: Unpack["Alert.ArchiveParams"]
349	) -> "Alert":
350	"""
351	Archives this alert, removing it from the list view and APIs. This is non-reversible.
352	"""
NEW 353	...	×
354
355	@overload	1✔
356	async def archive_async(	1✔
357	self, **params: Unpack["Alert.ArchiveParams"]
358	) -> "Alert":
359	"""
360	Archives this alert, removing it from the list view and APIs. This is non-reversible.
361	"""
NEW 362	...	×
363
364	@class_method_variant("_cls_archive_async")	1✔
365	async def archive_async( # pyright: ignore[reportGeneralTypeIssues]	1✔
366	self, **params: Unpack["Alert.ArchiveParams"]
367	) -> "Alert":
368	"""
369	Archives this alert, removing it from the list view and APIs. This is non-reversible.
370	"""
NEW 371	return cast(	×
372	"Alert",
373	await self._request_async(
374	"post",
375	"/v1/billing/alerts/{id}/archive".format(
376	id=sanitize_id(self.get("id"))
377	),
378	params=params,
379	),
380	)
381
382	@classmethod	1✔
383	def create(cls, **params: Unpack["Alert.CreateParams"]) -> "Alert":	1✔
384	"""
385	Creates a billing alert
386	"""
NEW 387	return cast(	×
388	"Alert",
389	cls._static_request(
390	"post",
391	cls.class_url(),
392	params=params,
393	),
394	)
395
396	@classmethod	1✔
397	async def create_async(	1✔
398	cls, **params: Unpack["Alert.CreateParams"]
399	) -> "Alert":
400	"""
401	Creates a billing alert
402	"""
NEW 403	return cast(	×
404	"Alert",
405	await cls._static_request_async(
406	"post",
407	cls.class_url(),
408	params=params,
409	),
410	)
411
412	@classmethod	1✔
413	def _cls_deactivate(	1✔
414	cls, id: str, **params: Unpack["Alert.DeactivateParams"]
415	) -> "Alert":
416	"""
417	Deactivates this alert, preventing it from triggering.
418	"""
NEW 419	return cast(	×
420	"Alert",
421	cls._static_request(
422	"post",
423	"/v1/billing/alerts/{id}/deactivate".format(
424	id=sanitize_id(id)
425	),
426	params=params,
427	),
428	)
429
430	@overload	1✔
431	@staticmethod	1✔
432	def deactivate(	1✔
433	id: str, **params: Unpack["Alert.DeactivateParams"]
434	) -> "Alert":
435	"""
436	Deactivates this alert, preventing it from triggering.
437	"""
NEW 438	...	×
439
440	@overload	1✔
441	def deactivate(	1✔
442	self, **params: Unpack["Alert.DeactivateParams"]
443	) -> "Alert":
444	"""
445	Deactivates this alert, preventing it from triggering.
446	"""
NEW 447	...	×
448
449	@class_method_variant("_cls_deactivate")	1✔
450	def deactivate( # pyright: ignore[reportGeneralTypeIssues]	1✔
451	self, **params: Unpack["Alert.DeactivateParams"]
452	) -> "Alert":
453	"""
454	Deactivates this alert, preventing it from triggering.
455	"""
NEW 456	return cast(	×
457	"Alert",
458	self._request(
459	"post",
460	"/v1/billing/alerts/{id}/deactivate".format(
461	id=sanitize_id(self.get("id"))
462	),
463	params=params,
464	),
465	)
466
467	@classmethod	1✔
468	async def _cls_deactivate_async(	1✔
469	cls, id: str, **params: Unpack["Alert.DeactivateParams"]
470	) -> "Alert":
471	"""
472	Deactivates this alert, preventing it from triggering.
473	"""
NEW 474	return cast(	×
475	"Alert",
476	await cls._static_request_async(
477	"post",
478	"/v1/billing/alerts/{id}/deactivate".format(
479	id=sanitize_id(id)
480	),
481	params=params,
482	),
483	)
484
485	@overload	1✔
486	@staticmethod	1✔
487	async def deactivate_async(	1✔
488	id: str, **params: Unpack["Alert.DeactivateParams"]
489	) -> "Alert":
490	"""
491	Deactivates this alert, preventing it from triggering.
492	"""
NEW 493	...	×
494
495	@overload	1✔
496	async def deactivate_async(	1✔
497	self, **params: Unpack["Alert.DeactivateParams"]
498	) -> "Alert":
499	"""
500	Deactivates this alert, preventing it from triggering.
501	"""
NEW 502	...	×
503
504	@class_method_variant("_cls_deactivate_async")	1✔
505	async def deactivate_async( # pyright: ignore[reportGeneralTypeIssues]	1✔
506	self, **params: Unpack["Alert.DeactivateParams"]
507	) -> "Alert":
508	"""
509	Deactivates this alert, preventing it from triggering.
510	"""
NEW 511	return cast(	×
512	"Alert",
513	await self._request_async(
514	"post",
515	"/v1/billing/alerts/{id}/deactivate".format(
516	id=sanitize_id(self.get("id"))
517	),
518	params=params,
519	),
520	)
521
522	@classmethod	1✔
523	def list(cls, **params: Unpack["Alert.ListParams"]) -> ListObject["Alert"]:	1✔
524	"""
525	Lists billing active and inactive alerts
526	"""
NEW 527	result = cls._static_request(	×
528	"get",
529	cls.class_url(),
530	params=params,
531	)
NEW 532	if not isinstance(result, ListObject):	×
NEW 533	raise TypeError(	×
534	"Expected list object from API, got %s"
535	% (type(result).__name__)
536	)
537
NEW 538	return result	×
539
540	@classmethod	1✔
541	async def list_async(	1✔
542	cls, **params: Unpack["Alert.ListParams"]
543	) -> ListObject["Alert"]:
544	"""
545	Lists billing active and inactive alerts
546	"""
NEW 547	result = await cls._static_request_async(	×
548	"get",
549	cls.class_url(),
550	params=params,
551	)
NEW 552	if not isinstance(result, ListObject):	×
NEW 553	raise TypeError(	×
554	"Expected list object from API, got %s"
555	% (type(result).__name__)
556	)
557
NEW 558	return result	×
559
560	@classmethod	1✔
561	def retrieve(	1✔
562	cls, id: str, **params: Unpack["Alert.RetrieveParams"]
563	) -> "Alert":
564	"""
565	Retrieves a billing alert given an ID
566	"""
NEW 567	instance = cls(id, **params)	×
NEW 568	instance.refresh()	×
NEW 569	return instance	×
570
571	@classmethod	1✔
572	async def retrieve_async(	1✔
573	cls, id: str, **params: Unpack["Alert.RetrieveParams"]
574	) -> "Alert":
575	"""
576	Retrieves a billing alert given an ID
577	"""
NEW 578	instance = cls(id, **params)	×
NEW 579	await instance.refresh_async()	×
NEW 580	return instance	×
581
582	_inner_class_types = {	1✔
583	"filter": Filter,
584	"usage_threshold_config": UsageThresholdConfig,
585	}

stripe / stripe-python / 10101774768

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