1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357
|
# -*- 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",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
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],
await self._request_async(
"get",
"/v1/issuing/personalization_designs",
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",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: "PersonalizationDesignService.CreateParams",
options: RequestOptions = {},
) -> PersonalizationDesign:
"""
Creates a personalization design object.
"""
return cast(
PersonalizationDesign,
await self._request_async(
"post",
"/v1/issuing/personalization_designs",
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),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
personalization_design: str,
params: "PersonalizationDesignService.RetrieveParams" = {},
options: RequestOptions = {},
) -> PersonalizationDesign:
"""
Retrieves a personalization design object.
"""
return cast(
PersonalizationDesign,
await self._request_async(
"get",
"/v1/issuing/personalization_designs/{personalization_design}".format(
personalization_design=sanitize_id(personalization_design),
),
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),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
personalization_design: str,
params: "PersonalizationDesignService.UpdateParams" = {},
options: RequestOptions = {},
) -> PersonalizationDesign:
"""
Updates a card personalization object.
"""
return cast(
PersonalizationDesign,
await self._request_async(
"post",
"/v1/issuing/personalization_designs/{personalization_design}".format(
personalization_design=sanitize_id(personalization_design),
),
base_address="api",
params=params,
options=options,
),
)
|