8622149548

Committed 09 Apr 2024 08:53PM UTC coverage: 96.274% (-0.09%) from 96.366%

Build # 8622149548

Build Type

Pull #1295

github

Committed by

web-flow

Commit Message

Merge c9d30b62d into f14735dfc

Pull Request Pull Request #1295: Update generated code

Run Details

1073 of 1662 branches covered (64.56%)

Branch coverage included in aggregate %.

382 of 446 new or added lines in 21 files covered. (85.65%)

1 existing line in 1 file now uncovered.

61737 of 63579 relevant lines covered (97.1%)

0.97 hits per line

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

68.42

/stripe/entitlements/_active_entitlement.py

# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._list_object import ListObject
from stripe._listable_api_resource import ListableAPIResource
from stripe._request_options import RequestOptions
from typing import ClassVar, List
from typing_extensions import Literal, NotRequired, Unpack


class ActiveEntitlement(ListableAPIResource["ActiveEntitlement"]):
    """
    An active entitlement describes access to a feature for a customer.
    """

    OBJECT_NAME: ClassVar[
        Literal["entitlements.active_entitlement"]
    ] = "entitlements.active_entitlement"

    class ListParams(RequestOptions):
        customer: str
        """
        The ID of the customer.
        """
        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.
        """

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

    feature: str
    """
    The feature that the customer is entitled to.
    """
    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.
    """
    lookup_key: str
    """
    A unique key you provide as your own system identifier. This may be up to 80 characters.
    """
    object: Literal["entitlements.active_entitlement"]
    """
    String representing the object's type. Objects of the same type share the same value.
    """

    @classmethod
    def list(
        cls, **params: Unpack["ActiveEntitlement.ListParams"]
    ) -> ListObject["ActiveEntitlement"]:
        """
        Retrieve a list of active entitlements for a customer
        """
        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["ActiveEntitlement.ListParams"]
    ) -> ListObject["ActiveEntitlement"]:
        """
        Retrieve a list of active entitlements for a customer
        """
        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["ActiveEntitlement.RetrieveParams"]
    ) -> "ActiveEntitlement":
        """
        Retrieve an active entitlement
        """
        instance = cls(id, **params)
        instance.refresh()
        return instance

    @classmethod
    async def retrieve_async(
        cls, id: str, **params: Unpack["ActiveEntitlement.RetrieveParams"]
    ) -> "ActiveEntitlement":
        """
        Retrieve an active entitlement
        """
        instance = cls(id, **params)
        await instance.refresh_async()
        return instance

1	# -- coding: utf-8 --
2	# File generated from our OpenAPI spec
3	from stripe._list_object import ListObject	1✔
4	from stripe._listable_api_resource import ListableAPIResource	1✔
5	from stripe._request_options import RequestOptions	1✔
6	from typing import ClassVar, List	1✔
7	from typing_extensions import Literal, NotRequired, Unpack	1✔
8
9
10	class ActiveEntitlement(ListableAPIResource["ActiveEntitlement"]):	1✔
11	"""
12	An active entitlement describes access to a feature for a customer.
13	"""
14
15	OBJECT_NAME: ClassVar[	1✔
16	Literal["entitlements.active_entitlement"]
17	] = "entitlements.active_entitlement"
18
19	class ListParams(RequestOptions):	1✔
20	customer: str	1✔
21	"""	1✔
22	The ID of the customer.
23	"""
24	ending_before: NotRequired[str]	1✔
25	"""	1✔
26	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.
27	"""
28	expand: NotRequired[List[str]]	1✔
29	"""	1✔
30	Specifies which fields in the response should be expanded.
31	"""
32	limit: NotRequired[int]	1✔
33	"""	1✔
34	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
35	"""
36	starting_after: NotRequired[str]	1✔
37	"""	1✔
38	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.
39	"""
40
41	class RetrieveParams(RequestOptions):	1✔
42	expand: NotRequired[List[str]]	1✔
43	"""	1✔
44	Specifies which fields in the response should be expanded.
45	"""
46
47	feature: str	1✔
48	"""	1✔
49	The feature that the customer is entitled to.
50	"""
51	id: str	1✔
52	"""	1✔
53	Unique identifier for the object.
54	"""
55	livemode: bool	1✔
56	"""	1✔
57	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
58	"""
59	lookup_key: str	1✔
60	"""	1✔
61	A unique key you provide as your own system identifier. This may be up to 80 characters.
62	"""
63	object: Literal["entitlements.active_entitlement"]	1✔
64	"""	1✔
65	String representing the object's type. Objects of the same type share the same value.
66	"""
67
68	@classmethod	1✔
69	def list(	1✔
70	cls, **params: Unpack["ActiveEntitlement.ListParams"]
71	) -> ListObject["ActiveEntitlement"]:
72	"""
73	Retrieve a list of active entitlements for a customer
74	"""
NEW 75	result = cls._static_request(	×
76	"get",
77	cls.class_url(),
78	params=params,
79	)
NEW 80	if not isinstance(result, ListObject):	×
81
NEW 82	raise TypeError(	×
83	"Expected list object from API, got %s"
84	% (type(result).__name__)
85	)
86
NEW 87	return result	×
88
89	@classmethod	1✔
90	async def list_async(	1✔
91	cls, **params: Unpack["ActiveEntitlement.ListParams"]
92	) -> ListObject["ActiveEntitlement"]:
93	"""
94	Retrieve a list of active entitlements for a customer
95	"""
NEW 96	result = await cls._static_request_async(	×
97	"get",
98	cls.class_url(),
99	params=params,
100	)
NEW 101	if not isinstance(result, ListObject):	×
102
NEW 103	raise TypeError(	×
104	"Expected list object from API, got %s"
105	% (type(result).__name__)
106	)
107
NEW 108	return result	×
109
110	@classmethod	1✔
111	def retrieve(	1✔
112	cls, id: str, **params: Unpack["ActiveEntitlement.RetrieveParams"]
113	) -> "ActiveEntitlement":
114	"""
115	Retrieve an active entitlement
116	"""
NEW 117	instance = cls(id, **params)	×
NEW 118	instance.refresh()	×
NEW 119	return instance	×
120
121	@classmethod	1✔
122	async def retrieve_async(	1✔
123	cls, id: str, **params: Unpack["ActiveEntitlement.RetrieveParams"]
124	) -> "ActiveEntitlement":
125	"""
126	Retrieve an active entitlement
127	"""
NEW 128	instance = cls(id, **params)	×
NEW 129	await instance.refresh_async()	×
NEW 130	return instance	×

stripe / stripe-python / 8622149548

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