10516401730

Committed 22 Aug 2024 10:10PM UTC coverage: 96.387% (-0.01%) from 96.398%

Build # 10516401730

Build Type

push

github

Committed by

xavdid-stripe

Commit Message

Bump version to 10.9.0b2

Run Details

1343 of 2037 branches covered (65.93%)

Branch coverage included in aggregate %.

1 of 1 new or added line in 1 file covered. (100.0%)

582 existing lines in 33 files now uncovered.

84800 of 87335 relevant lines covered (97.1%)

0.97 hits per line

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

93.75

/stripe/_customer_payment_method_service.py

# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._list_object import ListObject
from stripe._payment_method import PaymentMethod
from stripe._request_options import RequestOptions
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import List, cast
from typing_extensions import Literal, NotRequired, TypedDict


class CustomerPaymentMethodService(StripeService):
    class ListParams(TypedDict):
        allow_redisplay: NotRequired[
            Literal["always", "limited", "unspecified"]
        ]
        """
        This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
        """
        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.
        """
        type: NotRequired[
            Literal[
                "acss_debit",
                "affirm",
                "afterpay_clearpay",
                "alipay",
                "amazon_pay",
                "au_becs_debit",
                "bacs_debit",
                "bancontact",
                "blik",
                "boleto",
                "card",
                "cashapp",
                "customer_balance",
                "eps",
                "fpx",
                "giropay",
                "grabpay",
                "ideal",
                "klarna",
                "konbini",
                "link",
                "mb_way",
                "mobilepay",
                "multibanco",
                "oxxo",
                "p24",
                "paynow",
                "paypal",
                "payto",
                "pix",
                "promptpay",
                "rechnung",
                "revolut_pay",
                "sepa_debit",
                "sofort",
                "swish",
                "twint",
                "us_bank_account",
                "wechat_pay",
                "zip",
            ]
        ]
        """
        An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.
        """

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

    def list(
        self,
        customer: str,
        params: "CustomerPaymentMethodService.ListParams" = {},
        options: RequestOptions = {},
    ) -> ListObject[PaymentMethod]:
        """
        Returns a list of PaymentMethods for a given Customer
        """
        return cast(
            ListObject[PaymentMethod],
            self._request(
                "get",
                "/v1/customers/{customer}/payment_methods".format(
                    customer=sanitize_id(customer),
                ),
                api_mode="V1",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    async def list_async(
        self,
        customer: str,
        params: "CustomerPaymentMethodService.ListParams" = {},
        options: RequestOptions = {},
    ) -> ListObject[PaymentMethod]:
        """
        Returns a list of PaymentMethods for a given Customer
        """
        return cast(
            ListObject[PaymentMethod],
            await self._request_async(
                "get",
                "/v1/customers/{customer}/payment_methods".format(
                    customer=sanitize_id(customer),
                ),
                api_mode="V1",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    def retrieve(
        self,
        customer: str,
        payment_method: str,
        params: "CustomerPaymentMethodService.RetrieveParams" = {},
        options: RequestOptions = {},
    ) -> PaymentMethod:
        """
        Retrieves a PaymentMethod object for a given Customer.
        """
        return cast(
            PaymentMethod,
            self._request(
                "get",
                "/v1/customers/{customer}/payment_methods/{payment_method}".format(
                    customer=sanitize_id(customer),
                    payment_method=sanitize_id(payment_method),
                ),
                api_mode="V1",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    async def retrieve_async(
        self,
        customer: str,
        payment_method: str,
        params: "CustomerPaymentMethodService.RetrieveParams" = {},
        options: RequestOptions = {},
    ) -> PaymentMethod:
        """
        Retrieves a PaymentMethod object for a given Customer.
        """
        return cast(
            PaymentMethod,
            await self._request_async(
                "get",
                "/v1/customers/{customer}/payment_methods/{payment_method}".format(
                    customer=sanitize_id(customer),
                    payment_method=sanitize_id(payment_method),
                ),
                api_mode="V1",
                base_address="api",
                params=params,
                options=options,
            ),
        )

1	# -- coding: utf-8 --
2	# File generated from our OpenAPI spec
3	from stripe._list_object import ListObject	1✔
4	from stripe._payment_method import PaymentMethod	1✔
5	from stripe._request_options import RequestOptions	1✔
6	from stripe._stripe_service import StripeService	1✔
7	from stripe._util import sanitize_id	1✔
8	from typing import List, cast	1✔
9	from typing_extensions import Literal, NotRequired, TypedDict	1✔
10
11
12	class CustomerPaymentMethodService(StripeService):	1✔
13	class ListParams(TypedDict):	1✔
14	allow_redisplay: NotRequired[	1✔
15	Literal["always", "limited", "unspecified"]
16	]
17	"""	1✔
18	This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to `unspecified`.
19	"""
20	ending_before: NotRequired[str]	1✔
21	"""	1✔
22	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.
23	"""
24	expand: NotRequired[List[str]]	1✔
25	"""	1✔
26	Specifies which fields in the response should be expanded.
27	"""
28	limit: NotRequired[int]	1✔
29	"""	1✔
30	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
31	"""
32	starting_after: NotRequired[str]	1✔
33	"""	1✔
34	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.
35	"""
36	type: NotRequired[	1✔
37	Literal[
38	"acss_debit",
39	"affirm",
40	"afterpay_clearpay",
41	"alipay",
42	"amazon_pay",
43	"au_becs_debit",
44	"bacs_debit",
45	"bancontact",
46	"blik",
47	"boleto",
48	"card",
49	"cashapp",
50	"customer_balance",
51	"eps",
52	"fpx",
53	"giropay",
54	"grabpay",
55	"ideal",
56	"klarna",
57	"konbini",
58	"link",
59	"mb_way",
60	"mobilepay",
61	"multibanco",
62	"oxxo",
63	"p24",
64	"paynow",
65	"paypal",
66	"payto",
67	"pix",
68	"promptpay",
69	"rechnung",
70	"revolut_pay",
71	"sepa_debit",
72	"sofort",
73	"swish",
74	"twint",
75	"us_bank_account",
76	"wechat_pay",
77	"zip",
78	]
79	]
80	"""	1✔
81	An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request.
82	"""
83
84	class RetrieveParams(TypedDict):	1✔
85	expand: NotRequired[List[str]]	1✔
86	"""	1✔
87	Specifies which fields in the response should be expanded.
88	"""
89
90	def list(	1✔
91	self,
92	customer: str,
93	params: "CustomerPaymentMethodService.ListParams" = {},
94	options: RequestOptions = {},
95	) -> ListObject[PaymentMethod]:
96	"""
97	Returns a list of PaymentMethods for a given Customer
98	"""
99	return cast(	1✔
100	ListObject[PaymentMethod],
101	self._request(
102	"get",
103	"/v1/customers/{customer}/payment_methods".format(
104	customer=sanitize_id(customer),
105	),
106	api_mode="V1",
107	base_address="api",
108	params=params,
109	options=options,
110	),
111	)
112
113	async def list_async(	1✔
114	self,
115	customer: str,
116	params: "CustomerPaymentMethodService.ListParams" = {},
117	options: RequestOptions = {},
118	) -> ListObject[PaymentMethod]:
119	"""
120	Returns a list of PaymentMethods for a given Customer
121	"""
122	return cast(	1✔
123	ListObject[PaymentMethod],
124	await self._request_async(
125	"get",
126	"/v1/customers/{customer}/payment_methods".format(
127	customer=sanitize_id(customer),
128	),
129	api_mode="V1",
130	base_address="api",
131	params=params,
132	options=options,
133	),
134	)
135
136	def retrieve(	1✔
137	self,
138	customer: str,
139	payment_method: str,
140	params: "CustomerPaymentMethodService.RetrieveParams" = {},
141	options: RequestOptions = {},
142	) -> PaymentMethod:
143	"""
144	Retrieves a PaymentMethod object for a given Customer.
145	"""
UNCOV 146	return cast(	×
147	PaymentMethod,
148	self._request(
149	"get",
150	"/v1/customers/{customer}/payment_methods/{payment_method}".format(
151	customer=sanitize_id(customer),
152	payment_method=sanitize_id(payment_method),
153	),
154	api_mode="V1",
155	base_address="api",
156	params=params,
157	options=options,
158	),
159	)
160
161	async def retrieve_async(	1✔
162	self,
163	customer: str,
164	payment_method: str,
165	params: "CustomerPaymentMethodService.RetrieveParams" = {},
166	options: RequestOptions = {},
167	) -> PaymentMethod:
168	"""
169	Retrieves a PaymentMethod object for a given Customer.
170	"""
UNCOV 171	return cast(	×
172	PaymentMethod,
173	await self._request_async(
174	"get",
175	"/v1/customers/{customer}/payment_methods/{payment_method}".format(
176	customer=sanitize_id(customer),
177	payment_method=sanitize_id(payment_method),
178	),
179	api_mode="V1",
180	base_address="api",
181	params=params,
182	options=options,
183	),
184	)

stripe / stripe-python / 10516401730

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