8257066900

Committed 12 Mar 2024 11:34PM UTC coverage: 97.373% (-0.06%) from 97.433%

Build # 8257066900

Build Type

Pull #1269

github

Committed by

web-flow

Commit Message

Merge 357001983 into da0de819d

Pull Request Pull Request #1269: Update generated code

Run Details

889 of 1340 branches covered (66.34%)

Branch coverage included in aggregate %.

434 of 476 new or added lines in 18 files covered. (91.18%)

11 existing lines in 2 files now uncovered.

55071 of 56130 relevant lines covered (98.11%)

0.98 hits per line

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

96.04

/stripe/issuing/_personalization_design_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.issuing._personalization_design import PersonalizationDesign
from typing import Dict, List, cast
from typing_extensions import Literal, NotRequired, TypedDict


class PersonalizationDesignService(StripeService):
    class CreateParams(TypedDict):
        card_logo: NotRequired["str"]
        """
        The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.
        """
        carrier_text: NotRequired[
            "PersonalizationDesignService.CreateParamsCarrierText"
        ]
        """
        Hash containing carrier text, for use with physical bundles that support carrier text.
        """
        expand: NotRequired["List[str]"]
        """
        Specifies which fields in the response should be expanded.
        """
        lookup_key: NotRequired["str"]
        """
        A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
        """
        metadata: NotRequired["Dict[str, str]"]
        """
        Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        """
        name: NotRequired["str"]
        """
        Friendly display name.
        """
        physical_bundle: str
        """
        The physical bundle object belonging to this personalization design.
        """
        preferences: NotRequired[
            "PersonalizationDesignService.CreateParamsPreferences"
        ]
        """
        Information on whether this personalization design is used to create cards when one is not specified.
        """
        transfer_lookup_key: NotRequired["bool"]
        """
        If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.
        """

    class CreateParamsCarrierText(TypedDict):
        footer_body: NotRequired["Literal['']|str"]
        """
        The footer body text of the carrier letter.
        """
        footer_title: NotRequired["Literal['']|str"]
        """
        The footer title text of the carrier letter.
        """
        header_body: NotRequired["Literal['']|str"]
        """
        The header body text of the carrier letter.
        """
        header_title: NotRequired["Literal['']|str"]
        """
        The header title text of the carrier letter.
        """

    class CreateParamsPreferences(TypedDict):
        is_default: bool
        """
        Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.
        """

    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.
        """
        lookup_keys: NotRequired["List[str]"]
        """
        Only return personalization designs with the given lookup keys.
        """
        preferences: NotRequired[
            "PersonalizationDesignService.ListParamsPreferences"
        ]
        """
        Only return personalization designs with the given preferences.
        """
        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.
        """
        status: NotRequired[
            "Literal['active', 'inactive', 'rejected', 'review']"
        ]
        """
        Only return personalization designs with the given status.
        """

    class ListParamsPreferences(TypedDict):
        is_default: NotRequired["bool"]
        """
        Only return the personalization design that's set as the default. A connected account uses the Connect platform's default design if no personalization design is set as the default.
        """
        is_platform_default: NotRequired["bool"]
        """
        Only return the personalization design that is set as the Connect platform's default. This parameter is only applicable to connected accounts.
        """

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

    class UpdateParams(TypedDict):
        card_logo: NotRequired["Literal['']|str"]
        """
        The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.
        """
        carrier_text: NotRequired[
            "Literal['']|PersonalizationDesignService.UpdateParamsCarrierText"
        ]
        """
        Hash containing carrier text, for use with physical bundles that support carrier text.
        """
        expand: NotRequired["List[str]"]
        """
        Specifies which fields in the response should be expanded.
        """
        lookup_key: NotRequired["Literal['']|str"]
        """
        A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
        """
        metadata: NotRequired["Dict[str, str]"]
        """
        Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
        """
        name: NotRequired["Literal['']|str"]
        """
        Friendly display name. Providing an empty string will set the field to null.
        """
        physical_bundle: NotRequired["str"]
        """
        The physical bundle object belonging to this personalization design.
        """
        preferences: NotRequired[
            "PersonalizationDesignService.UpdateParamsPreferences"
        ]
        """
        Information on whether this personalization design is used to create cards when one is not specified.
        """
        transfer_lookup_key: NotRequired["bool"]
        """
        If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.
        """

    class UpdateParamsCarrierText(TypedDict):
        footer_body: NotRequired["Literal['']|str"]
        """
        The footer body text of the carrier letter.
        """
        footer_title: NotRequired["Literal['']|str"]
        """
        The footer title text of the carrier letter.
        """
        header_body: NotRequired["Literal['']|str"]
        """
        The header body text of the carrier letter.
        """
        header_title: NotRequired["Literal['']|str"]
        """
        The header title text of the carrier letter.
        """

    class UpdateParamsPreferences(TypedDict):
        is_default: bool
        """
        Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.
        """

    def list(
        self,
        params: "PersonalizationDesignService.ListParams" = {},
        options: RequestOptions = {},
    ) -> ListObject[PersonalizationDesign]:
        """
        Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
        """
        return cast(
            ListObject[PersonalizationDesign],
            self._request(
                "get",
                "/v1/issuing/personalization_designs",
                api_mode="V1",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    def create(
        self,
        params: "PersonalizationDesignService.CreateParams",
        options: RequestOptions = {},
    ) -> PersonalizationDesign:
        """
        Creates a personalization design object.
        """
        return cast(
            PersonalizationDesign,
            self._request(
                "post",
                "/v1/issuing/personalization_designs",
                api_mode="V1",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    def retrieve(
        self,
        personalization_design: str,
        params: "PersonalizationDesignService.RetrieveParams" = {},
        options: RequestOptions = {},
    ) -> PersonalizationDesign:
        """
        Retrieves a personalization design object.
        """
        return cast(
            PersonalizationDesign,
            self._request(
                "get",
                "/v1/issuing/personalization_designs/{personalization_design}".format(
                    personalization_design=sanitize_id(personalization_design),
                ),
                api_mode="V1",
                base_address="api",
                params=params,
                options=options,
            ),
        )

    def update(
        self,
        personalization_design: str,
        params: "PersonalizationDesignService.UpdateParams" = {},
        options: RequestOptions = {},
    ) -> PersonalizationDesign:
        """
        Updates a card personalization object.
        """
        return cast(
            PersonalizationDesign,
            self._request(
                "post",
                "/v1/issuing/personalization_designs/{personalization_design}".format(
                    personalization_design=sanitize_id(personalization_design),
                ),
                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.issuing._personalization_design import PersonalizationDesign	1✔
8	from typing import Dict, List, cast	1✔
9	from typing_extensions import Literal, NotRequired, TypedDict	1✔
10
11
12	class PersonalizationDesignService(StripeService):	1✔
13	class CreateParams(TypedDict):	1✔
14	card_logo: NotRequired["str"]	1✔
15	"""	1✔
16	The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.
17	"""
18	carrier_text: NotRequired[	1✔
19	"PersonalizationDesignService.CreateParamsCarrierText"
20	]
21	"""	1✔
22	Hash containing carrier text, for use with physical bundles that support carrier text.
23	"""
24	expand: NotRequired["List[str]"]	1✔
25	"""	1✔
26	Specifies which fields in the response should be expanded.
27	"""
28	lookup_key: NotRequired["str"]	1✔
29	"""	1✔
30	A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
31	"""
32	metadata: NotRequired["Dict[str, str]"]	1✔
33	"""	1✔
34	Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
35	"""
36	name: NotRequired["str"]	1✔
37	"""	1✔
38	Friendly display name.
39	"""
40	physical_bundle: str	1✔
41	"""	1✔
42	The physical bundle object belonging to this personalization design.
43	"""
44	preferences: NotRequired[	1✔
45	"PersonalizationDesignService.CreateParamsPreferences"
46	]
47	"""	1✔
48	Information on whether this personalization design is used to create cards when one is not specified.
49	"""
50	transfer_lookup_key: NotRequired["bool"]	1✔
51	"""	1✔
52	If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.
53	"""
54
55	class CreateParamsCarrierText(TypedDict):	1✔
56	footer_body: NotRequired["Literal['']\|str"]	1✔
57	"""	1✔
58	The footer body text of the carrier letter.
59	"""
60	footer_title: NotRequired["Literal['']\|str"]	1✔
61	"""	1✔
62	The footer title text of the carrier letter.
63	"""
64	header_body: NotRequired["Literal['']\|str"]	1✔
65	"""	1✔
66	The header body text of the carrier letter.
67	"""
68	header_title: NotRequired["Literal['']\|str"]	1✔
69	"""	1✔
70	The header title text of the carrier letter.
71	"""
72
73	class CreateParamsPreferences(TypedDict):	1✔
74	is_default: bool	1✔
75	"""	1✔
76	Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.
77	"""
78
79	class ListParams(TypedDict):	1✔
80	ending_before: NotRequired["str"]	1✔
81	"""	1✔
82	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.
83	"""
84	expand: NotRequired["List[str]"]	1✔
85	"""	1✔
86	Specifies which fields in the response should be expanded.
87	"""
88	limit: NotRequired["int"]	1✔
89	"""	1✔
90	A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
91	"""
92	lookup_keys: NotRequired["List[str]"]	1✔
93	"""	1✔
94	Only return personalization designs with the given lookup keys.
95	"""
96	preferences: NotRequired[	1✔
97	"PersonalizationDesignService.ListParamsPreferences"
98	]
99	"""	1✔
100	Only return personalization designs with the given preferences.
101	"""
102	starting_after: NotRequired["str"]	1✔
103	"""	1✔
104	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.
105	"""
106	status: NotRequired[	1✔
107	"Literal['active', 'inactive', 'rejected', 'review']"
108	]
109	"""	1✔
110	Only return personalization designs with the given status.
111	"""
112
113	class ListParamsPreferences(TypedDict):	1✔
114	is_default: NotRequired["bool"]	1✔
115	"""	1✔
116	Only return the personalization design that's set as the default. A connected account uses the Connect platform's default design if no personalization design is set as the default.
117	"""
118	is_platform_default: NotRequired["bool"]	1✔
119	"""	1✔
120	Only return the personalization design that is set as the Connect platform's default. This parameter is only applicable to connected accounts.
121	"""
122
123	class RetrieveParams(TypedDict):	1✔
124	expand: NotRequired["List[str]"]	1✔
125	"""	1✔
126	Specifies which fields in the response should be expanded.
127	"""
128
129	class UpdateParams(TypedDict):	1✔
130	card_logo: NotRequired["Literal['']\|str"]	1✔
131	"""	1✔
132	The file for the card logo, for use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.
133	"""
134	carrier_text: NotRequired[	1✔
135	"Literal['']\|PersonalizationDesignService.UpdateParamsCarrierText"
136	]
137	"""	1✔
138	Hash containing carrier text, for use with physical bundles that support carrier text.
139	"""
140	expand: NotRequired["List[str]"]	1✔
141	"""	1✔
142	Specifies which fields in the response should be expanded.
143	"""
144	lookup_key: NotRequired["Literal['']\|str"]	1✔
145	"""	1✔
146	A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
147	"""
148	metadata: NotRequired["Dict[str, str]"]	1✔
149	"""	1✔
150	Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
151	"""
152	name: NotRequired["Literal['']\|str"]	1✔
153	"""	1✔
154	Friendly display name. Providing an empty string will set the field to null.
155	"""
156	physical_bundle: NotRequired["str"]	1✔
157	"""	1✔
158	The physical bundle object belonging to this personalization design.
159	"""
160	preferences: NotRequired[	1✔
161	"PersonalizationDesignService.UpdateParamsPreferences"
162	]
163	"""	1✔
164	Information on whether this personalization design is used to create cards when one is not specified.
165	"""
166	transfer_lookup_key: NotRequired["bool"]	1✔
167	"""	1✔
168	If set to true, will atomically remove the lookup key from the existing personalization design, and assign it to this personalization design.
169	"""
170
171	class UpdateParamsCarrierText(TypedDict):	1✔
172	footer_body: NotRequired["Literal['']\|str"]	1✔
173	"""	1✔
174	The footer body text of the carrier letter.
175	"""
176	footer_title: NotRequired["Literal['']\|str"]	1✔
177	"""	1✔
178	The footer title text of the carrier letter.
179	"""
180	header_body: NotRequired["Literal['']\|str"]	1✔
181	"""	1✔
182	The header body text of the carrier letter.
183	"""
184	header_title: NotRequired["Literal['']\|str"]	1✔
185	"""	1✔
186	The header title text of the carrier letter.
187	"""
188
189	class UpdateParamsPreferences(TypedDict):	1✔
190	is_default: bool	1✔
191	"""	1✔
192	Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design.
193	"""
194
195	def list(	1✔
196	self,
197	params: "PersonalizationDesignService.ListParams" = {},
198	options: RequestOptions = {},
199	) -> ListObject[PersonalizationDesign]:
200	"""
201	Returns a list of personalization design objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
202	"""
NEW 203	return cast(	×
204	ListObject[PersonalizationDesign],
205	self._request(
206	"get",
207	"/v1/issuing/personalization_designs",
208	api_mode="V1",
209	base_address="api",
210	params=params,
211	options=options,
212	),
213	)
214
215	def create(	1✔
216	self,
217	params: "PersonalizationDesignService.CreateParams",
218	options: RequestOptions = {},
219	) -> PersonalizationDesign:
220	"""
221	Creates a personalization design object.
222	"""
NEW 223	return cast(	×
224	PersonalizationDesign,
225	self._request(
226	"post",
227	"/v1/issuing/personalization_designs",
228	api_mode="V1",
229	base_address="api",
230	params=params,
231	options=options,
232	),
233	)
234
235	def retrieve(	1✔
236	self,
237	personalization_design: str,
238	params: "PersonalizationDesignService.RetrieveParams" = {},
239	options: RequestOptions = {},
240	) -> PersonalizationDesign:
241	"""
242	Retrieves a personalization design object.
243	"""
NEW 244	return cast(	×
245	PersonalizationDesign,
246	self._request(
247	"get",
248	"/v1/issuing/personalization_designs/{personalization_design}".format(
249	personalization_design=sanitize_id(personalization_design),
250	),
251	api_mode="V1",
252	base_address="api",
253	params=params,
254	options=options,
255	),
256	)
257
258	def update(	1✔
259	self,
260	personalization_design: str,
261	params: "PersonalizationDesignService.UpdateParams" = {},
262	options: RequestOptions = {},
263	) -> PersonalizationDesign:
264	"""
265	Updates a card personalization object.
266	"""
NEW 267	return cast(	×
268	PersonalizationDesign,
269	self._request(
270	"post",
271	"/v1/issuing/personalization_designs/{personalization_design}".format(
272	personalization_design=sanitize_id(personalization_design),
273	),
274	api_mode="V1",
275	base_address="api",
276	params=params,
277	options=options,
278	),
279	)

stripe / stripe-python / 8257066900

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