9766731422

Committed 02 Jul 2024 07:16PM UTC coverage: 96.445% (-0.02%) from 96.465%

Build # 9766731422

Build Type

Pull #1355

github

Committed by

web-flow

Commit Message

Merge 48bddd56b into 61b6c61d8

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

Run Details

1338 of 2023 branches covered (66.14%)

Branch coverage included in aggregate %.

162 of 180 new or added lines in 22 files covered. (90.0%)

1 existing line in 1 file now uncovered.

83763 of 86215 relevant lines covered (97.16%)

0.97 hits per line

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

85.71

/stripe/financial_connections/_institution_service.py

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


class InstitutionService(StripeService):
    class ListParams(TypedDict):
        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.
        """

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

    def list(
        self,
        params: "InstitutionService.ListParams" = {},
        options: RequestOptions = {},
    ) -> ListObject[Institution]:
        """
        Returns a list of Financial Connections Institution objects.
        """
        return cast(
            ListObject[Institution],
            self._request(
                "get",
                "/v1/financial_connections/institutions",
                api_mode="V1",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    async def list_async(
        self,
        params: "InstitutionService.ListParams" = {},
        options: RequestOptions = {},
    ) -> ListObject[Institution]:
        """
        Returns a list of Financial Connections Institution objects.
        """
        return cast(
            ListObject[Institution],
            await self._request_async(
                "get",
                "/v1/financial_connections/institutions",
                api_mode="V1",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    def retrieve(
        self,
        institution: str,
        params: "InstitutionService.RetrieveParams" = {},
        options: RequestOptions = {},
    ) -> Institution:
        """
        Retrieves the details of a Financial Connections Institution.
        """
        return cast(
            Institution,
            self._request(
                "get",
                "/v1/financial_connections/institutions/{institution}".format(
                    institution=sanitize_id(institution),
                ),
                api_mode="V1",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    async def retrieve_async(
        self,
        institution: str,
        params: "InstitutionService.RetrieveParams" = {},
        options: RequestOptions = {},
    ) -> Institution:
        """
        Retrieves the details of a Financial Connections Institution.
        """
        return cast(
            Institution,
            await self._request_async(
                "get",
                "/v1/financial_connections/institutions/{institution}".format(
                    institution=sanitize_id(institution),
                ),
                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._request_options import RequestOptions	1✔
5	from stripe._stripe_service import StripeService	1✔
6	from stripe._util import sanitize_id	1✔
7	from stripe.financial_connections._institution import Institution	1✔
8	from typing import List, cast	1✔
9	from typing_extensions import NotRequired, TypedDict	1✔
10
11
12	class InstitutionService(StripeService):	1✔
13	class ListParams(TypedDict):	1✔
14	ending_before: NotRequired[str]	1✔
15	"""	1✔
16	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.
17	"""
18	expand: NotRequired[List[str]]	1✔
19	"""	1✔
20	Specifies which fields in the response should be expanded.
21	"""
22	limit: NotRequired[int]	1✔
23	"""	1✔
24	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
25	"""
26	starting_after: NotRequired[str]	1✔
27	"""	1✔
28	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.
29	"""
30
31	class RetrieveParams(TypedDict):	1✔
32	expand: NotRequired[List[str]]	1✔
33	"""	1✔
34	Specifies which fields in the response should be expanded.
35	"""
36
37	def list(	1✔
38	self,
39	params: "InstitutionService.ListParams" = {},
40	options: RequestOptions = {},
41	) -> ListObject[Institution]:
42	"""
43	Returns a list of Financial Connections Institution objects.
44	"""
NEW 45	return cast(	×
46	ListObject[Institution],
47	self._request(
48	"get",
49	"/v1/financial_connections/institutions",
50	api_mode="V1",
51	base_address="api",
52	params=params,
53	options=options,
54	),
55	)
56
57	async def list_async(	1✔
58	self,
59	params: "InstitutionService.ListParams" = {},
60	options: RequestOptions = {},
61	) -> ListObject[Institution]:
62	"""
63	Returns a list of Financial Connections Institution objects.
64	"""
NEW 65	return cast(	×
66	ListObject[Institution],
67	await self._request_async(
68	"get",
69	"/v1/financial_connections/institutions",
70	api_mode="V1",
71	base_address="api",
72	params=params,
73	options=options,
74	),
75	)
76
77	def retrieve(	1✔
78	self,
79	institution: str,
80	params: "InstitutionService.RetrieveParams" = {},
81	options: RequestOptions = {},
82	) -> Institution:
83	"""
84	Retrieves the details of a Financial Connections Institution.
85	"""
NEW 86	return cast(	×
87	Institution,
88	self._request(
89	"get",
90	"/v1/financial_connections/institutions/{institution}".format(
91	institution=sanitize_id(institution),
92	),
93	api_mode="V1",
94	base_address="api",
95	params=params,
96	options=options,
97	),
98	)
99
100	async def retrieve_async(	1✔
101	self,
102	institution: str,
103	params: "InstitutionService.RetrieveParams" = {},
104	options: RequestOptions = {},
105	) -> Institution:
106	"""
107	Retrieves the details of a Financial Connections Institution.
108	"""
NEW 109	return cast(	×
110	Institution,
111	await self._request_async(
112	"get",
113	"/v1/financial_connections/institutions/{institution}".format(
114	institution=sanitize_id(institution),
115	),
116	api_mode="V1",
117	base_address="api",
118	params=params,
119	options=options,
120	),
121	)

stripe / stripe-python / 9766731422

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