10639126896

Committed 30 Aug 2024 09:03PM UTC coverage: 96.364% (+0.003%) from 96.361%

Build # 10639126896

Build Type

Pull #1376

github

Committed by

web-flow

Commit Message

Merge 030d28969 into 3d0426fea

Pull Request Pull Request #1376: Update generated code

Run Details

1298 of 1919 branches covered (67.64%)

Branch coverage included in aggregate %.

8 of 8 new or added lines in 4 files covered. (100.0%)

52 existing lines in 2 files now uncovered.

67032 of 68989 relevant lines covered (97.16%)

0.97 hits per line

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

78.73

/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 SpendThresholdConfig(StripeObject):
        aggregation: Literal["subscription", "subscription_item"]
        """
        Defines if the alert will fire on spend aggregated across a subscription, or on individual subscription items.
        """
        currency: str
        """
        Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
        """
        gte: int
        """
        The value at which this alert will trigger.
        """
        recurrence: Literal["one_time"]
        """
        Defines how the alert will behave.
        """

    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["spend_threshold", "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.
        """
        spend_threshold_config: NotRequired[
            "Alert.CreateParamsSpendThresholdConfig"
        ]
        """
        The configuration of the spend threshold.
        """
        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 CreateParamsSpendThresholdConfig(TypedDict):
        aggregation: Literal["subscription", "subscription_item"]
        """
        Whether the spend should be aggregated across items in a subscription or whether each subscription item is considered alone.
        """
        currency: str
        """
        Currency for which this spend alert is configured. This alert will only trigger for subscriptions matching this currency.
        """
        gte: int
        """
        Defines at which value the alert will fire.
        """
        recurrence: Literal["one_time"]
        """
        Whether the alert should only fire only once, or once per billing cycle.
        """

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

stripe / stripe-python / 10639126896

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