11111627158

Committed 30 Sep 2024 06:03PM UTC coverage: 96.186% (-0.1%) from 96.317%

Build # 11111627158

Build Type

Pull #1404

github

Committed by

prathmesh-stripe

Commit Message

Pagination related comments

Pull Request Pull Request #1404: Support for APIs in the new API version 2024-09-30

Run Details

1343 of 1991 branches covered (67.45%)

Branch coverage included in aggregate %.

1167 of 1285 new or added lines in 65 files covered. (90.82%)

6 existing lines in 4 files now uncovered.

68268 of 70380 relevant lines covered (97.0%)

0.97 hits per line

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

92.59

/stripe/billing/_credit_balance_summary_service.py

# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._request_options import RequestOptions
from stripe._stripe_service import StripeService
from stripe.billing._credit_balance_summary import CreditBalanceSummary
from typing import List, cast
from typing_extensions import Literal, NotRequired, TypedDict


class CreditBalanceSummaryService(StripeService):
    class RetrieveParams(TypedDict):
        customer: str
        """
        The customer for which to fetch credit balance summary.
        """
        expand: NotRequired[List[str]]
        """
        Specifies which fields in the response should be expanded.
        """
        filter: "CreditBalanceSummaryService.RetrieveParamsFilter"
        """
        The filter criteria for the credit balance summary.
        """

    class RetrieveParamsFilter(TypedDict):
        applicability_scope: NotRequired[
            "CreditBalanceSummaryService.RetrieveParamsFilterApplicabilityScope"
        ]
        """
        The credit applicability scope for which to fetch balance summary.
        """
        credit_grant: NotRequired[str]
        """
        The credit grant for which to fetch balance summary.
        """
        type: Literal["applicability_scope", "credit_grant"]
        """
        Specify the type of this filter.
        """

    class RetrieveParamsFilterApplicabilityScope(TypedDict):
        price_type: Literal["metered"]
        """
        The price type to which credit grants can apply to. We currently only support `metered` price type.
        """

    def retrieve(
        self,
        params: "CreditBalanceSummaryService.RetrieveParams",
        options: RequestOptions = {},
    ) -> CreditBalanceSummary:
        """
        Retrieves the credit balance summary for a customer
        """
        return cast(
            CreditBalanceSummary,
            self._request(
                "get",
                "/v1/billing/credit_balance_summary",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    async def retrieve_async(
        self,
        params: "CreditBalanceSummaryService.RetrieveParams",
        options: RequestOptions = {},
    ) -> CreditBalanceSummary:
        """
        Retrieves the credit balance summary for a customer
        """
        return cast(
            CreditBalanceSummary,
            await self._request_async(
                "get",
                "/v1/billing/credit_balance_summary",
                base_address="api",
                params=params,
                options=options,
            ),
        )

1	# -- coding: utf-8 --
2	# File generated from our OpenAPI spec
3	from stripe._request_options import RequestOptions	1✔
4	from stripe._stripe_service import StripeService	1✔
5	from stripe.billing._credit_balance_summary import CreditBalanceSummary	1✔
6	from typing import List, cast	1✔
7	from typing_extensions import Literal, NotRequired, TypedDict	1✔
8
9
10	class CreditBalanceSummaryService(StripeService):	1✔
11	class RetrieveParams(TypedDict):	1✔
12	customer: str	1✔
13	"""	1✔
14	The customer for which to fetch credit balance summary.
15	"""
16	expand: NotRequired[List[str]]	1✔
17	"""	1✔
18	Specifies which fields in the response should be expanded.
19	"""
20	filter: "CreditBalanceSummaryService.RetrieveParamsFilter"	1✔
21	"""	1✔
22	The filter criteria for the credit balance summary.
23	"""
24
25	class RetrieveParamsFilter(TypedDict):	1✔
26	applicability_scope: NotRequired[	1✔
27	"CreditBalanceSummaryService.RetrieveParamsFilterApplicabilityScope"
28	]
29	"""	1✔
30	The credit applicability scope for which to fetch balance summary.
31	"""
32	credit_grant: NotRequired[str]	1✔
33	"""	1✔
34	The credit grant for which to fetch balance summary.
35	"""
36	type: Literal["applicability_scope", "credit_grant"]	1✔
37	"""	1✔
38	Specify the type of this filter.
39	"""
40
41	class RetrieveParamsFilterApplicabilityScope(TypedDict):	1✔
42	price_type: Literal["metered"]	1✔
43	"""	1✔
44	The price type to which credit grants can apply to. We currently only support `metered` price type.
45	"""
46
47	def retrieve(	1✔
48	self,
49	params: "CreditBalanceSummaryService.RetrieveParams",
50	options: RequestOptions = {},
51	) -> CreditBalanceSummary:
52	"""
53	Retrieves the credit balance summary for a customer
54	"""
NEW 55	return cast(	×
56	CreditBalanceSummary,
57	self._request(
58	"get",
59	"/v1/billing/credit_balance_summary",
60	base_address="api",
61	params=params,
62	options=options,
63	),
64	)
65
66	async def retrieve_async(	1✔
67	self,
68	params: "CreditBalanceSummaryService.RetrieveParams",
69	options: RequestOptions = {},
70	) -> CreditBalanceSummary:
71	"""
72	Retrieves the credit balance summary for a customer
73	"""
NEW 74	return cast(	×
75	CreditBalanceSummary,
76	await self._request_async(
77	"get",
78	"/v1/billing/credit_balance_summary",
79	base_address="api",
80	params=params,
81	options=options,
82	),
83	)

stripe / stripe-python / 11111627158

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