8138576110

Committed 04 Mar 2024 10:13AM UTC coverage: 96.392% (+0.02%) from 96.37%

Build # 8138576110

Build Type

Pull #1265

github

Committed by

web-flow

Commit Message

Merge e2aba2663 into 851f63a5b

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

Run Details

1124 of 1774 branches covered (63.36%)

Branch coverage included in aggregate %.

85 of 85 new or added lines in 12 files covered. (100.0%)

106 existing lines in 7 files now uncovered.

78650 of 80986 relevant lines covered (97.12%)

0.97 hits per line

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

98.66

/stripe/_account_session.py

# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._createable_api_resource import CreateableAPIResource
from stripe._request_options import RequestOptions
from stripe._stripe_object import StripeObject
from typing import ClassVar, List, Optional, cast
from typing_extensions import Literal, NotRequired, TypedDict, Unpack


class AccountSession(CreateableAPIResource["AccountSession"]):
    """
    An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.

    We recommend that you create an AccountSession each time you need to display an embedded component
    to your user. Do not save AccountSessions to your database as they expire relatively
    quickly, and cannot be used more than once.

    Related guide: [Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components)
    """

    OBJECT_NAME: ClassVar[Literal["account_session"]] = "account_session"

    class Components(StripeObject):
        class AccountOnboarding(StripeObject):
            class Features(StripeObject):
                pass

            enabled: bool
            """
            Whether the embedded component is enabled.
            """
            features: Features
            _inner_class_types = {"features": Features}

        class CapitalFinancingPromotion(StripeObject):
            class Features(StripeObject):
                pass

            enabled: bool
            """
            Whether the embedded component is enabled.
            """
            features: Features
            _inner_class_types = {"features": Features}

        class PaymentDetails(StripeObject):
            class Features(StripeObject):
                capture_payments: bool
                """
                Whether to allow capturing and cancelling payment intents. This is `true` by default.
                """
                dispute_management: bool
                """
                Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.
                """
                refund_management: bool
                """
                Whether to allow sending refunds. This is `true` by default.
                """

            enabled: bool
            """
            Whether the embedded component is enabled.
            """
            features: Features
            _inner_class_types = {"features": Features}

        class Payments(StripeObject):
            class Features(StripeObject):
                capture_payments: bool
                """
                Whether to allow capturing and cancelling payment intents. This is `true` by default.
                """
                dispute_management: bool
                """
                Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.
                """
                refund_management: bool
                """
                Whether to allow sending refunds. This is `true` by default.
                """

            enabled: bool
            """
            Whether the embedded component is enabled.
            """
            features: Features
            _inner_class_types = {"features": Features}

        class Payouts(StripeObject):
            class Features(StripeObject):
                edit_payout_schedule: bool
                """
                Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
                """
                instant_payouts: bool
                """
                Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
                """
                standard_payouts: bool
                """
                Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
                """

            enabled: bool
            """
            Whether the embedded component is enabled.
            """
            features: Features
            _inner_class_types = {"features": Features}

        account_onboarding: AccountOnboarding
        capital_financing_promotion: Optional[CapitalFinancingPromotion]
        payment_details: PaymentDetails
        payments: Payments
        payouts: Payouts
        _inner_class_types = {
            "account_onboarding": AccountOnboarding,
            "capital_financing_promotion": CapitalFinancingPromotion,
            "payment_details": PaymentDetails,
            "payments": Payments,
            "payouts": Payouts,
        }

    class CreateParams(RequestOptions):
        account: str
        """
        The identifier of the account to create an Account Session for.
        """
        components: "AccountSession.CreateParamsComponents"
        """
        Each key of the dictionary represents an embedded component, and each embedded component maps to its configuration (e.g. whether it has been enabled or not).
        """
        expand: NotRequired["List[str]"]
        """
        Specifies which fields in the response should be expanded.
        """

    class CreateParamsComponents(TypedDict):
        account_onboarding: NotRequired[
            "AccountSession.CreateParamsComponentsAccountOnboarding"
        ]
        """
        Configuration for the account onboarding embedded component.
        """
        capital_financing_promotion: NotRequired[
            "AccountSession.CreateParamsComponentsCapitalFinancingPromotion"
        ]
        payment_details: NotRequired[
            "AccountSession.CreateParamsComponentsPaymentDetails"
        ]
        """
        Configuration for the payment details embedded component.
        """
        payments: NotRequired["AccountSession.CreateParamsComponentsPayments"]
        """
        Configuration for the payments embedded component.
        """
        payouts: NotRequired["AccountSession.CreateParamsComponentsPayouts"]
        """
        Configuration for the payouts embedded component.
        """

    class CreateParamsComponentsAccountOnboarding(TypedDict):
        enabled: bool
        """
        Whether the embedded component is enabled.
        """
        features: NotRequired[
            "AccountSession.CreateParamsComponentsAccountOnboardingFeatures"
        ]
        """
        The list of features enabled in the embedded component.
        """

    class CreateParamsComponentsAccountOnboardingFeatures(TypedDict):
        pass

    class CreateParamsComponentsCapitalFinancingPromotion(TypedDict):
        enabled: bool
        """
        Whether the embedded component is enabled.
        """
        features: NotRequired[
            "AccountSession.CreateParamsComponentsCapitalFinancingPromotionFeatures"
        ]
        """
        The list of features enabled in the embedded component.
        """

    class CreateParamsComponentsCapitalFinancingPromotionFeatures(TypedDict):
        pass

    class CreateParamsComponentsPaymentDetails(TypedDict):
        enabled: bool
        """
        Whether the embedded component is enabled.
        """
        features: NotRequired[
            "AccountSession.CreateParamsComponentsPaymentDetailsFeatures"
        ]
        """
        The list of features enabled in the embedded component.
        """

    class CreateParamsComponentsPaymentDetailsFeatures(TypedDict):
        capture_payments: NotRequired["bool"]
        """
        Whether to allow capturing and cancelling payment intents. This is `true` by default.
        """
        dispute_management: NotRequired["bool"]
        """
        Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.
        """
        refund_management: NotRequired["bool"]
        """
        Whether to allow sending refunds. This is `true` by default.
        """

    class CreateParamsComponentsPayments(TypedDict):
        enabled: bool
        """
        Whether the embedded component is enabled.
        """
        features: NotRequired[
            "AccountSession.CreateParamsComponentsPaymentsFeatures"
        ]
        """
        The list of features enabled in the embedded component.
        """

    class CreateParamsComponentsPaymentsFeatures(TypedDict):
        capture_payments: NotRequired["bool"]
        """
        Whether to allow capturing and cancelling payment intents. This is `true` by default.
        """
        dispute_management: NotRequired["bool"]
        """
        Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.
        """
        refund_management: NotRequired["bool"]
        """
        Whether to allow sending refunds. This is `true` by default.
        """

    class CreateParamsComponentsPayouts(TypedDict):
        enabled: bool
        """
        Whether the embedded component is enabled.
        """
        features: NotRequired[
            "AccountSession.CreateParamsComponentsPayoutsFeatures"
        ]
        """
        The list of features enabled in the embedded component.
        """

    class CreateParamsComponentsPayoutsFeatures(TypedDict):
        edit_payout_schedule: NotRequired["bool"]
        """
        Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
        """
        instant_payouts: NotRequired["bool"]
        """
        Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
        """
        standard_payouts: NotRequired["bool"]
        """
        Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
        """

    account: str
    """
    The ID of the account the AccountSession was created for
    """
    client_secret: str
    """
    The client secret of this AccountSession. Used on the client to set up secure access to the given `account`.

    The client secret can be used to provide access to `account` from your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret.

    Refer to our docs to [setup Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components) and learn about how `client_secret` should be handled.
    """
    components: Components
    expires_at: int
    """
    The timestamp at which this AccountSession will expire.
    """
    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["account_session"]
    """
    String representing the object's type. Objects of the same type share the same value.
    """

    @classmethod
    def create(
        cls, **params: Unpack["AccountSession.CreateParams"]
    ) -> "AccountSession":
        """
        Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.
        """
        return cast(
            "AccountSession",
            cls._static_request(
                "post",
                cls.class_url(),
                params=params,
            ),
        )

    @classmethod
    async def create_async(
        cls, **params: Unpack["AccountSession.CreateParams"]
    ) -> "AccountSession":
        """
        Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.
        """
        return cast(
            "AccountSession",
            await cls._static_request_async(
                "post",
                cls.class_url(),
                params=params,
            ),
        )

    _inner_class_types = {"components": Components}

1	# -- coding: utf-8 --
2	# File generated from our OpenAPI spec
3	from stripe._createable_api_resource import CreateableAPIResource	1✔
4	from stripe._request_options import RequestOptions	1✔
5	from stripe._stripe_object import StripeObject	1✔
6	from typing import ClassVar, List, Optional, cast	1✔
7	from typing_extensions import Literal, NotRequired, TypedDict, Unpack	1✔
8
9
10	class AccountSession(CreateableAPIResource["AccountSession"]):	1✔
11	"""
12	An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.
13
14	We recommend that you create an AccountSession each time you need to display an embedded component
15	to your user. Do not save AccountSessions to your database as they expire relatively
16	quickly, and cannot be used more than once.
17
18	Related guide: [Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components)
19	"""
20
21	OBJECT_NAME: ClassVar[Literal["account_session"]] = "account_session"	1✔
22
23	class Components(StripeObject):	1✔
24	class AccountOnboarding(StripeObject):	1✔
25	class Features(StripeObject):	1✔
26	pass	1✔
27
28	enabled: bool	1✔
29	"""	1✔
30	Whether the embedded component is enabled.
31	"""
32	features: Features	1✔
33	_inner_class_types = {"features": Features}	1✔
34
35	class CapitalFinancingPromotion(StripeObject):	1✔
36	class Features(StripeObject):	1✔
37	pass	1✔
38
39	enabled: bool	1✔
40	"""	1✔
41	Whether the embedded component is enabled.
42	"""
43	features: Features	1✔
44	_inner_class_types = {"features": Features}	1✔
45
46	class PaymentDetails(StripeObject):	1✔
47	class Features(StripeObject):	1✔
48	capture_payments: bool	1✔
49	"""	1✔
50	Whether to allow capturing and cancelling payment intents. This is `true` by default.
51	"""
52	dispute_management: bool	1✔
53	"""	1✔
54	Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.
55	"""
56	refund_management: bool	1✔
57	"""	1✔
58	Whether to allow sending refunds. This is `true` by default.
59	"""
60
61	enabled: bool	1✔
62	"""	1✔
63	Whether the embedded component is enabled.
64	"""
65	features: Features	1✔
66	_inner_class_types = {"features": Features}	1✔
67
68	class Payments(StripeObject):	1✔
69	class Features(StripeObject):	1✔
70	capture_payments: bool	1✔
71	"""	1✔
72	Whether to allow capturing and cancelling payment intents. This is `true` by default.
73	"""
74	dispute_management: bool	1✔
75	"""	1✔
76	Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.
77	"""
78	refund_management: bool	1✔
79	"""	1✔
80	Whether to allow sending refunds. This is `true` by default.
81	"""
82
83	enabled: bool	1✔
84	"""	1✔
85	Whether the embedded component is enabled.
86	"""
87	features: Features	1✔
88	_inner_class_types = {"features": Features}	1✔
89
90	class Payouts(StripeObject):	1✔
91	class Features(StripeObject):	1✔
92	edit_payout_schedule: bool	1✔
93	"""	1✔
94	Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
95	"""
96	instant_payouts: bool	1✔
97	"""	1✔
98	Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
99	"""
100	standard_payouts: bool	1✔
101	"""	1✔
102	Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
103	"""
104
105	enabled: bool	1✔
106	"""	1✔
107	Whether the embedded component is enabled.
108	"""
109	features: Features	1✔
110	_inner_class_types = {"features": Features}	1✔
111
112	account_onboarding: AccountOnboarding	1✔
113	capital_financing_promotion: Optional[CapitalFinancingPromotion]	1✔
114	payment_details: PaymentDetails	1✔
115	payments: Payments	1✔
116	payouts: Payouts	1✔
117	_inner_class_types = {	1✔
118	"account_onboarding": AccountOnboarding,
119	"capital_financing_promotion": CapitalFinancingPromotion,
120	"payment_details": PaymentDetails,
121	"payments": Payments,
122	"payouts": Payouts,
123	}
124
125	class CreateParams(RequestOptions):	1✔
126	account: str	1✔
127	"""	1✔
128	The identifier of the account to create an Account Session for.
129	"""
130	components: "AccountSession.CreateParamsComponents"	1✔
131	"""	1✔
132	Each key of the dictionary represents an embedded component, and each embedded component maps to its configuration (e.g. whether it has been enabled or not).
133	"""
134	expand: NotRequired["List[str]"]	1✔
135	"""	1✔
136	Specifies which fields in the response should be expanded.
137	"""
138
139	class CreateParamsComponents(TypedDict):	1✔
140	account_onboarding: NotRequired[	1✔
141	"AccountSession.CreateParamsComponentsAccountOnboarding"
142	]
143	"""	1✔
144	Configuration for the account onboarding embedded component.
145	"""
146	capital_financing_promotion: NotRequired[	1✔
147	"AccountSession.CreateParamsComponentsCapitalFinancingPromotion"
148	]
149	payment_details: NotRequired[	1✔
150	"AccountSession.CreateParamsComponentsPaymentDetails"
151	]
152	"""	1✔
153	Configuration for the payment details embedded component.
154	"""
155	payments: NotRequired["AccountSession.CreateParamsComponentsPayments"]	1✔
156	"""	1✔
157	Configuration for the payments embedded component.
158	"""
159	payouts: NotRequired["AccountSession.CreateParamsComponentsPayouts"]	1✔
160	"""	1✔
161	Configuration for the payouts embedded component.
162	"""
163
164	class CreateParamsComponentsAccountOnboarding(TypedDict):	1✔
165	enabled: bool	1✔
166	"""	1✔
167	Whether the embedded component is enabled.
168	"""
169	features: NotRequired[	1✔
170	"AccountSession.CreateParamsComponentsAccountOnboardingFeatures"
171	]
172	"""	1✔
173	The list of features enabled in the embedded component.
174	"""
175
176	class CreateParamsComponentsAccountOnboardingFeatures(TypedDict):	1✔
177	pass	1✔
178
179	class CreateParamsComponentsCapitalFinancingPromotion(TypedDict):	1✔
180	enabled: bool	1✔
181	"""	1✔
182	Whether the embedded component is enabled.
183	"""
184	features: NotRequired[	1✔
185	"AccountSession.CreateParamsComponentsCapitalFinancingPromotionFeatures"
186	]
187	"""	1✔
188	The list of features enabled in the embedded component.
189	"""
190
191	class CreateParamsComponentsCapitalFinancingPromotionFeatures(TypedDict):	1✔
192	pass	1✔
193
194	class CreateParamsComponentsPaymentDetails(TypedDict):	1✔
195	enabled: bool	1✔
196	"""	1✔
197	Whether the embedded component is enabled.
198	"""
199	features: NotRequired[	1✔
200	"AccountSession.CreateParamsComponentsPaymentDetailsFeatures"
201	]
202	"""	1✔
203	The list of features enabled in the embedded component.
204	"""
205
206	class CreateParamsComponentsPaymentDetailsFeatures(TypedDict):	1✔
207	capture_payments: NotRequired["bool"]	1✔
208	"""	1✔
209	Whether to allow capturing and cancelling payment intents. This is `true` by default.
210	"""
211	dispute_management: NotRequired["bool"]	1✔
212	"""	1✔
213	Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.
214	"""
215	refund_management: NotRequired["bool"]	1✔
216	"""	1✔
217	Whether to allow sending refunds. This is `true` by default.
218	"""
219
220	class CreateParamsComponentsPayments(TypedDict):	1✔
221	enabled: bool	1✔
222	"""	1✔
223	Whether the embedded component is enabled.
224	"""
225	features: NotRequired[	1✔
226	"AccountSession.CreateParamsComponentsPaymentsFeatures"
227	]
228	"""	1✔
229	The list of features enabled in the embedded component.
230	"""
231
232	class CreateParamsComponentsPaymentsFeatures(TypedDict):	1✔
233	capture_payments: NotRequired["bool"]	1✔
234	"""	1✔
235	Whether to allow capturing and cancelling payment intents. This is `true` by default.
236	"""
237	dispute_management: NotRequired["bool"]	1✔
238	"""	1✔
239	Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.
240	"""
241	refund_management: NotRequired["bool"]	1✔
242	"""	1✔
243	Whether to allow sending refunds. This is `true` by default.
244	"""
245
246	class CreateParamsComponentsPayouts(TypedDict):	1✔
247	enabled: bool	1✔
248	"""	1✔
249	Whether the embedded component is enabled.
250	"""
251	features: NotRequired[	1✔
252	"AccountSession.CreateParamsComponentsPayoutsFeatures"
253	]
254	"""	1✔
255	The list of features enabled in the embedded component.
256	"""
257
258	class CreateParamsComponentsPayoutsFeatures(TypedDict):	1✔
259	edit_payout_schedule: NotRequired["bool"]	1✔
260	"""	1✔
261	Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
262	"""
263	instant_payouts: NotRequired["bool"]	1✔
264	"""	1✔
265	Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
266	"""
267	standard_payouts: NotRequired["bool"]	1✔
268	"""	1✔
269	Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
270	"""
271
272	account: str	1✔
273	"""	1✔
274	The ID of the account the AccountSession was created for
275	"""
276	client_secret: str	1✔
277	"""	1✔
278	The client secret of this AccountSession. Used on the client to set up secure access to the given `account`.
279
280	The client secret can be used to provide access to `account` from your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret.
281
282	Refer to our docs to [setup Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components) and learn about how `client_secret` should be handled.
283	"""
284	components: Components	1✔
285	expires_at: int	1✔
286	"""	1✔
287	The timestamp at which this AccountSession will expire.
288	"""
289	livemode: bool	1✔
290	"""	1✔
291	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
292	"""
293	object: Literal["account_session"]	1✔
294	"""	1✔
295	String representing the object's type. Objects of the same type share the same value.
296	"""
297
298	@classmethod	1✔
299	def create(	1✔
300	cls, **params: Unpack["AccountSession.CreateParams"]
301	) -> "AccountSession":
302	"""
303	Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.
304	"""
UNCOV 305	return cast(	×
306	"AccountSession",
307	cls._static_request(
308	"post",
309	cls.class_url(),
310	params=params,
311	),
312	)
313
314	@classmethod	1✔
315	async def create_async(	1✔
316	cls, **params: Unpack["AccountSession.CreateParams"]
317	) -> "AccountSession":
318	"""
319	Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.
320	"""
UNCOV 321	return cast(	×
322	"AccountSession",
323	await cls._static_request_async(
324	"post",
325	cls.class_url(),
326	params=params,
327	),
328	)
329
330	_inner_class_types = {"components": Components}	1✔

stripe / stripe-python / 8138576110

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