8187231968

Committed 07 Mar 2024 11:15AM UTC coverage: 97.432% (+0.01%) from 97.422%

Build # 8187231968

Build Type

Pull #1267

github

Committed by

web-flow

Commit Message

Merge eed099359 into 9e67ba3da

Pull Request Pull Request #1267: Update generated code

Run Details

886 of 1330 branches covered (66.62%)

Branch coverage included in aggregate %.

75 of 75 new or added lines in 10 files covered. (100.0%)

1 existing line in 1 file now uncovered.

54631 of 55650 relevant lines covered (98.17%)

0.98 hits per line

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

99.28

/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, 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 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
        payment_details: PaymentDetails
        payments: Payments
        payouts: Payouts
        _inner_class_types = {
            "account_onboarding": AccountOnboarding,
            "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.
        """
        documents: NotRequired[
            "AccountSession.CreateParamsComponentsDocuments"
        ]
        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 CreateParamsComponentsDocuments(TypedDict):
        enabled: bool
        """
        Whether the embedded component is enabled.
        """
        features: NotRequired[
            "AccountSession.CreateParamsComponentsDocumentsFeatures"
        ]
        """
        The list of features enabled in the embedded component.
        """

    class CreateParamsComponentsDocumentsFeatures(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,
            ),
        )

    _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, 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 PaymentDetails(StripeObject):	1✔
36	class Features(StripeObject):	1✔
37	capture_payments: bool	1✔
38	"""	1✔
39	Whether to allow capturing and cancelling payment intents. This is `true` by default.
40	"""
41	dispute_management: bool	1✔
42	"""	1✔
43	Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.
44	"""
45	refund_management: bool	1✔
46	"""	1✔
47	Whether to allow sending refunds. This is `true` by default.
48	"""
49
50	enabled: bool	1✔
51	"""	1✔
52	Whether the embedded component is enabled.
53	"""
54	features: Features	1✔
55	_inner_class_types = {"features": Features}	1✔
56
57	class Payments(StripeObject):	1✔
58	class Features(StripeObject):	1✔
59	capture_payments: bool	1✔
60	"""	1✔
61	Whether to allow capturing and cancelling payment intents. This is `true` by default.
62	"""
63	dispute_management: bool	1✔
64	"""	1✔
65	Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.
66	"""
67	refund_management: bool	1✔
68	"""	1✔
69	Whether to allow sending refunds. This is `true` by default.
70	"""
71
72	enabled: bool	1✔
73	"""	1✔
74	Whether the embedded component is enabled.
75	"""
76	features: Features	1✔
77	_inner_class_types = {"features": Features}	1✔
78
79	class Payouts(StripeObject):	1✔
80	class Features(StripeObject):	1✔
81	edit_payout_schedule: bool	1✔
82	"""	1✔
83	Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
84	"""
85	instant_payouts: bool	1✔
86	"""	1✔
87	Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
88	"""
89	standard_payouts: bool	1✔
90	"""	1✔
91	Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
92	"""
93
94	enabled: bool	1✔
95	"""	1✔
96	Whether the embedded component is enabled.
97	"""
98	features: Features	1✔
99	_inner_class_types = {"features": Features}	1✔
100
101	account_onboarding: AccountOnboarding	1✔
102	payment_details: PaymentDetails	1✔
103	payments: Payments	1✔
104	payouts: Payouts	1✔
105	_inner_class_types = {	1✔
106	"account_onboarding": AccountOnboarding,
107	"payment_details": PaymentDetails,
108	"payments": Payments,
109	"payouts": Payouts,
110	}
111
112	class CreateParams(RequestOptions):	1✔
113	account: str	1✔
114	"""	1✔
115	The identifier of the account to create an Account Session for.
116	"""
117	components: "AccountSession.CreateParamsComponents"	1✔
118	"""	1✔
119	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).
120	"""
121	expand: NotRequired["List[str]"]	1✔
122	"""	1✔
123	Specifies which fields in the response should be expanded.
124	"""
125
126	class CreateParamsComponents(TypedDict):	1✔
127	account_onboarding: NotRequired[	1✔
128	"AccountSession.CreateParamsComponentsAccountOnboarding"
129	]
130	"""	1✔
131	Configuration for the account onboarding embedded component.
132	"""
133	documents: NotRequired[	1✔
134	"AccountSession.CreateParamsComponentsDocuments"
135	]
136	payment_details: NotRequired[	1✔
137	"AccountSession.CreateParamsComponentsPaymentDetails"
138	]
139	"""	1✔
140	Configuration for the payment details embedded component.
141	"""
142	payments: NotRequired["AccountSession.CreateParamsComponentsPayments"]	1✔
143	"""	1✔
144	Configuration for the payments embedded component.
145	"""
146	payouts: NotRequired["AccountSession.CreateParamsComponentsPayouts"]	1✔
147	"""	1✔
148	Configuration for the payouts embedded component.
149	"""
150
151	class CreateParamsComponentsAccountOnboarding(TypedDict):	1✔
152	enabled: bool	1✔
153	"""	1✔
154	Whether the embedded component is enabled.
155	"""
156	features: NotRequired[	1✔
157	"AccountSession.CreateParamsComponentsAccountOnboardingFeatures"
158	]
159	"""	1✔
160	The list of features enabled in the embedded component.
161	"""
162
163	class CreateParamsComponentsAccountOnboardingFeatures(TypedDict):	1✔
164	pass	1✔
165
166	class CreateParamsComponentsDocuments(TypedDict):	1✔
167	enabled: bool	1✔
168	"""	1✔
169	Whether the embedded component is enabled.
170	"""
171	features: NotRequired[	1✔
172	"AccountSession.CreateParamsComponentsDocumentsFeatures"
173	]
174	"""	1✔
175	The list of features enabled in the embedded component.
176	"""
177
178	class CreateParamsComponentsDocumentsFeatures(TypedDict):	1✔
179	pass	1✔
180
181	class CreateParamsComponentsPaymentDetails(TypedDict):	1✔
182	enabled: bool	1✔
183	"""	1✔
184	Whether the embedded component is enabled.
185	"""
186	features: NotRequired[	1✔
187	"AccountSession.CreateParamsComponentsPaymentDetailsFeatures"
188	]
189	"""	1✔
190	The list of features enabled in the embedded component.
191	"""
192
193	class CreateParamsComponentsPaymentDetailsFeatures(TypedDict):	1✔
194	capture_payments: NotRequired["bool"]	1✔
195	"""	1✔
196	Whether to allow capturing and cancelling payment intents. This is `true` by default.
197	"""
198	dispute_management: NotRequired["bool"]	1✔
199	"""	1✔
200	Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.
201	"""
202	refund_management: NotRequired["bool"]	1✔
203	"""	1✔
204	Whether to allow sending refunds. This is `true` by default.
205	"""
206
207	class CreateParamsComponentsPayments(TypedDict):	1✔
208	enabled: bool	1✔
209	"""	1✔
210	Whether the embedded component is enabled.
211	"""
212	features: NotRequired[	1✔
213	"AccountSession.CreateParamsComponentsPaymentsFeatures"
214	]
215	"""	1✔
216	The list of features enabled in the embedded component.
217	"""
218
219	class CreateParamsComponentsPaymentsFeatures(TypedDict):	1✔
220	capture_payments: NotRequired["bool"]	1✔
221	"""	1✔
222	Whether to allow capturing and cancelling payment intents. This is `true` by default.
223	"""
224	dispute_management: NotRequired["bool"]	1✔
225	"""	1✔
226	Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.
227	"""
228	refund_management: NotRequired["bool"]	1✔
229	"""	1✔
230	Whether to allow sending refunds. This is `true` by default.
231	"""
232
233	class CreateParamsComponentsPayouts(TypedDict):	1✔
234	enabled: bool	1✔
235	"""	1✔
236	Whether the embedded component is enabled.
237	"""
238	features: NotRequired[	1✔
239	"AccountSession.CreateParamsComponentsPayoutsFeatures"
240	]
241	"""	1✔
242	The list of features enabled in the embedded component.
243	"""
244
245	class CreateParamsComponentsPayoutsFeatures(TypedDict):	1✔
246	edit_payout_schedule: NotRequired["bool"]	1✔
247	"""	1✔
248	Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
249	"""
250	instant_payouts: NotRequired["bool"]	1✔
251	"""	1✔
252	Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
253	"""
254	standard_payouts: NotRequired["bool"]	1✔
255	"""	1✔
256	Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.
257	"""
258
259	account: str	1✔
260	"""	1✔
261	The ID of the account the AccountSession was created for
262	"""
263	client_secret: str	1✔
264	"""	1✔
265	The client secret of this AccountSession. Used on the client to set up secure access to the given `account`.
266
267	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.
268
269	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.
270	"""
271	components: Components	1✔
272	expires_at: int	1✔
273	"""	1✔
274	The timestamp at which this AccountSession will expire.
275	"""
276	livemode: bool	1✔
277	"""	1✔
278	Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
279	"""
280	object: Literal["account_session"]	1✔
281	"""	1✔
282	String representing the object's type. Objects of the same type share the same value.
283	"""
284
285	@classmethod	1✔
286	def create(	1✔
287	cls, **params: Unpack["AccountSession.CreateParams"]
288	) -> "AccountSession":
289	"""
290	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.
291	"""
UNCOV 292	return cast(	×
293	"AccountSession",
294	cls._static_request(
295	"post",
296	cls.class_url(),
297	params=params,
298	),
299	)
300
301	_inner_class_types = {"components": Components}	1✔

stripe / stripe-python / 8187231968

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