8378972063

Committed 21 Mar 2024 05:07PM UTC coverage: 96.379% (-0.04%) from 96.419%

Build # 8378972063

Build Type

Pull #1272

github

Committed by

web-flow

Commit Message

Merge 84142f87d into c71b88d42

Pull Request Pull Request #1272: Update generated code for beta

Run Details

1144 of 1812 branches covered (63.13%)

Branch coverage included in aggregate %.

390 of 435 new or added lines in 32 files covered. (89.66%)

9 existing lines in 1 file now uncovered.

80755 of 83164 relevant lines covered (97.1%)

0.97 hits per line

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

72.73

/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.
        """

    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

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	feature: str	1✔
42	"""	1✔
43	The feature that the customer is entitled to.
44	"""
45	id: str	1✔
46	"""	1✔
47	Unique identifier for the object.
48	"""
49	livemode: bool	1✔
50	"""	1✔
51	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
52	"""
53	lookup_key: str	1✔
54	"""	1✔
55	A unique key you provide as your own system identifier. This may be up to 80 characters.
56	"""
57	object: Literal["entitlements.active_entitlement"]	1✔
58	"""	1✔
59	String representing the object's type. Objects of the same type share the same value.
60	"""
61
62	@classmethod	1✔
63	def list(	1✔
64	cls, **params: Unpack["ActiveEntitlement.ListParams"]
65	) -> ListObject["ActiveEntitlement"]:
66	"""
67	Retrieve a list of active entitlements for a customer
68	"""
NEW 69	result = cls._static_request(	×
70	"get",
71	cls.class_url(),
72	params=params,
73	)
NEW 74	if not isinstance(result, ListObject):	×
75
NEW 76	raise TypeError(	×
77	"Expected list object from API, got %s"
78	% (type(result).__name__)
79	)
80
NEW 81	return result	×
82
83	@classmethod	1✔
84	async def list_async(	1✔
85	cls, **params: Unpack["ActiveEntitlement.ListParams"]
86	) -> ListObject["ActiveEntitlement"]:
87	"""
88	Retrieve a list of active entitlements for a customer
89	"""
NEW 90	result = await cls._static_request_async(	×
91	"get",
92	cls.class_url(),
93	params=params,
94	)
NEW 95	if not isinstance(result, ListObject):	×
96
NEW 97	raise TypeError(	×
98	"Expected list object from API, got %s"
99	% (type(result).__name__)
100	)
101
NEW 102	return result	×

stripe / stripe-python / 8378972063

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