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 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._createable_api_resource import CreateableAPIResource
from stripe._expandable_field import ExpandableField
from stripe._list_object import ListObject
from stripe._listable_api_resource import ListableAPIResource
from stripe._request_options import RequestOptions
from stripe._stripe_object import StripeObject
from stripe._test_helpers import APIResourceTestHelpers
from stripe._updateable_api_resource import UpdateableAPIResource
from stripe._util import class_method_variant, sanitize_id
from typing import ClassVar, Dict, List, Optional, cast, overload
from typing_extensions import (
Literal,
NotRequired,
Type,
TypedDict,
Unpack,
TYPE_CHECKING,
)
if TYPE_CHECKING:
from stripe._file import File
from stripe.issuing._physical_bundle import PhysicalBundle
class PersonalizationDesign(
CreateableAPIResource["PersonalizationDesign"],
ListableAPIResource["PersonalizationDesign"],
UpdateableAPIResource["PersonalizationDesign"],
):
"""
A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.
"""
OBJECT_NAME: ClassVar[Literal["issuing.personalization_design"]] = (
"issuing.personalization_design"
)
class CarrierText(StripeObject):
footer_body: Optional[str]
"""
The footer body text of the carrier letter.
"""
footer_title: Optional[str]
"""
The footer title text of the carrier letter.
"""
header_body: Optional[str]
"""
The header body text of the carrier letter.
"""
header_title: Optional[str]
"""
The header title text of the carrier letter.
"""
class Preferences(StripeObject):
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.
"""
is_platform_default: Optional[bool]
"""
Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist.
"""
class RejectionReasons(StripeObject):
card_logo: Optional[
List[
Literal[
"geographic_location",
"inappropriate",
"network_name",
"non_binary_image",
"non_fiat_currency",
"other",
"other_entity",
"promotional_material",
]
]
]
"""
The reason(s) the card logo was rejected.
"""
carrier_text: Optional[
List[
Literal[
"geographic_location",
"inappropriate",
"network_name",
"non_fiat_currency",
"other",
"other_entity",
"promotional_material",
]
]
]
"""
The reason(s) the carrier text was rejected.
"""
class ActivateParams(RequestOptions):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
class CreateParams(RequestOptions):
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[
"PersonalizationDesign.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[
"PersonalizationDesign.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 DeactivateParams(RequestOptions):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
class ListParams(RequestOptions):
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["PersonalizationDesign.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 ModifyParams(RequestOptions):
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['']|PersonalizationDesign.ModifyParamsCarrierText"
]
"""
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[
"PersonalizationDesign.ModifyParamsPreferences"
]
"""
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 ModifyParamsCarrierText(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 ModifyParamsPreferences(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 RejectParams(RequestOptions):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
rejection_reasons: "PersonalizationDesign.RejectParamsRejectionReasons"
"""
The reason(s) the personalization design was rejected.
"""
class RejectParamsRejectionReasons(TypedDict):
card_logo: NotRequired[
List[
Literal[
"geographic_location",
"inappropriate",
"network_name",
"non_binary_image",
"non_fiat_currency",
"other",
"other_entity",
"promotional_material",
]
]
]
"""
The reason(s) the card logo was rejected.
"""
carrier_text: NotRequired[
List[
Literal[
"geographic_location",
"inappropriate",
"network_name",
"non_fiat_currency",
"other",
"other_entity",
"promotional_material",
]
]
]
"""
The reason(s) the carrier text was rejected.
"""
class RetrieveParams(RequestOptions):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
card_logo: Optional[ExpandableField["File"]]
"""
The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`.
"""
carrier_text: Optional[CarrierText]
"""
Hash containing carrier text, for use with physical bundles that support carrier text.
"""
created: int
"""
Time at which the object was created. Measured in seconds since the Unix epoch.
"""
id: str
"""
Unique identifier for the object.
"""
livemode: bool
"""
Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
"""
lookup_key: Optional[str]
"""
A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters.
"""
metadata: 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.
"""
name: Optional[str]
"""
Friendly display name.
"""
object: Literal["issuing.personalization_design"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
physical_bundle: ExpandableField["PhysicalBundle"]
"""
The physical bundle object belonging to this personalization design.
"""
preferences: Preferences
rejection_reasons: RejectionReasons
status: Literal["active", "inactive", "rejected", "review"]
"""
Whether this personalization design can be used to create cards.
"""
@classmethod
def create(
cls, **params: Unpack["PersonalizationDesign.CreateParams"]
) -> "PersonalizationDesign":
"""
Creates a personalization design object.
"""
return cast(
"PersonalizationDesign",
cls._static_request(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
async def create_async(
cls, **params: Unpack["PersonalizationDesign.CreateParams"]
) -> "PersonalizationDesign":
"""
Creates a personalization design object.
"""
return cast(
"PersonalizationDesign",
await cls._static_request_async(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
def list(
cls, **params: Unpack["PersonalizationDesign.ListParams"]
) -> 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.
"""
result = cls._static_request(
"get",
cls.class_url(),
params=params,
)
if not isinstance(result, ListObject):
raise TypeError(
"Expected list object from API, got %s"
% (type(result).__name__)
)
return result
@classmethod
async def list_async(
cls, **params: Unpack["PersonalizationDesign.ListParams"]
) -> 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.
"""
result = await cls._static_request_async(
"get",
cls.class_url(),
params=params,
)
if not isinstance(result, ListObject):
raise TypeError(
"Expected list object from API, got %s"
% (type(result).__name__)
)
return result
@classmethod
def modify(
cls, id: str, **params: Unpack["PersonalizationDesign.ModifyParams"]
) -> "PersonalizationDesign":
"""
Updates a card personalization object.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return cast(
"PersonalizationDesign",
cls._static_request(
"post",
url,
params=params,
),
)
@classmethod
async def modify_async(
cls, id: str, **params: Unpack["PersonalizationDesign.ModifyParams"]
) -> "PersonalizationDesign":
"""
Updates a card personalization object.
"""
url = "%s/%s" % (cls.class_url(), sanitize_id(id))
return cast(
"PersonalizationDesign",
await cls._static_request_async(
"post",
url,
params=params,
),
)
@classmethod
def retrieve(
cls, id: str, **params: Unpack["PersonalizationDesign.RetrieveParams"]
) -> "PersonalizationDesign":
"""
Retrieves a personalization design object.
"""
instance = cls(id, **params)
instance.refresh()
return instance
@classmethod
async def retrieve_async(
cls, id: str, **params: Unpack["PersonalizationDesign.RetrieveParams"]
) -> "PersonalizationDesign":
"""
Retrieves a personalization design object.
"""
instance = cls(id, **params)
await instance.refresh_async()
return instance
class TestHelpers(APIResourceTestHelpers["PersonalizationDesign"]):
_resource_cls: Type["PersonalizationDesign"]
@classmethod
def _cls_activate(
cls,
personalization_design: str,
**params: Unpack["PersonalizationDesign.ActivateParams"],
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to active.
"""
return cast(
"PersonalizationDesign",
cls._static_request(
"post",
"/v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate".format(
personalization_design=sanitize_id(
personalization_design
)
),
params=params,
),
)
@overload
@staticmethod
def activate(
personalization_design: str,
**params: Unpack["PersonalizationDesign.ActivateParams"],
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to active.
"""
...
@overload
def activate(
self, **params: Unpack["PersonalizationDesign.ActivateParams"]
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to active.
"""
...
@class_method_variant("_cls_activate")
def activate( # pyright: ignore[reportGeneralTypeIssues]
self, **params: Unpack["PersonalizationDesign.ActivateParams"]
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to active.
"""
return cast(
"PersonalizationDesign",
self.resource._request(
"post",
"/v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate".format(
personalization_design=sanitize_id(
self.resource.get("id")
)
),
params=params,
),
)
@classmethod
async def _cls_activate_async(
cls,
personalization_design: str,
**params: Unpack["PersonalizationDesign.ActivateParams"],
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to active.
"""
return cast(
"PersonalizationDesign",
await cls._static_request_async(
"post",
"/v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate".format(
personalization_design=sanitize_id(
personalization_design
)
),
params=params,
),
)
@overload
@staticmethod
async def activate_async(
personalization_design: str,
**params: Unpack["PersonalizationDesign.ActivateParams"],
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to active.
"""
...
@overload
async def activate_async(
self, **params: Unpack["PersonalizationDesign.ActivateParams"]
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to active.
"""
...
@class_method_variant("_cls_activate_async")
async def activate_async( # pyright: ignore[reportGeneralTypeIssues]
self, **params: Unpack["PersonalizationDesign.ActivateParams"]
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to active.
"""
return cast(
"PersonalizationDesign",
await self.resource._request_async(
"post",
"/v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate".format(
personalization_design=sanitize_id(
self.resource.get("id")
)
),
params=params,
),
)
@classmethod
def _cls_deactivate(
cls,
personalization_design: str,
**params: Unpack["PersonalizationDesign.DeactivateParams"],
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to inactive.
"""
return cast(
"PersonalizationDesign",
cls._static_request(
"post",
"/v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate".format(
personalization_design=sanitize_id(
personalization_design
)
),
params=params,
),
)
@overload
@staticmethod
def deactivate(
personalization_design: str,
**params: Unpack["PersonalizationDesign.DeactivateParams"],
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to inactive.
"""
...
@overload
def deactivate(
self, **params: Unpack["PersonalizationDesign.DeactivateParams"]
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to inactive.
"""
...
@class_method_variant("_cls_deactivate")
def deactivate( # pyright: ignore[reportGeneralTypeIssues]
self, **params: Unpack["PersonalizationDesign.DeactivateParams"]
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to inactive.
"""
return cast(
"PersonalizationDesign",
self.resource._request(
"post",
"/v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate".format(
personalization_design=sanitize_id(
self.resource.get("id")
)
),
params=params,
),
)
@classmethod
async def _cls_deactivate_async(
cls,
personalization_design: str,
**params: Unpack["PersonalizationDesign.DeactivateParams"],
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to inactive.
"""
return cast(
"PersonalizationDesign",
await cls._static_request_async(
"post",
"/v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate".format(
personalization_design=sanitize_id(
personalization_design
)
),
params=params,
),
)
@overload
@staticmethod
async def deactivate_async(
personalization_design: str,
**params: Unpack["PersonalizationDesign.DeactivateParams"],
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to inactive.
"""
...
@overload
async def deactivate_async(
self, **params: Unpack["PersonalizationDesign.DeactivateParams"]
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to inactive.
"""
...
@class_method_variant("_cls_deactivate_async")
async def deactivate_async( # pyright: ignore[reportGeneralTypeIssues]
self, **params: Unpack["PersonalizationDesign.DeactivateParams"]
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to inactive.
"""
return cast(
"PersonalizationDesign",
await self.resource._request_async(
"post",
"/v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate".format(
personalization_design=sanitize_id(
self.resource.get("id")
)
),
params=params,
),
)
@classmethod
def _cls_reject(
cls,
personalization_design: str,
**params: Unpack["PersonalizationDesign.RejectParams"],
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to rejected.
"""
return cast(
"PersonalizationDesign",
cls._static_request(
"post",
"/v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject".format(
personalization_design=sanitize_id(
personalization_design
)
),
params=params,
),
)
@overload
@staticmethod
def reject(
personalization_design: str,
**params: Unpack["PersonalizationDesign.RejectParams"],
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to rejected.
"""
...
@overload
def reject(
self, **params: Unpack["PersonalizationDesign.RejectParams"]
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to rejected.
"""
...
@class_method_variant("_cls_reject")
def reject( # pyright: ignore[reportGeneralTypeIssues]
self, **params: Unpack["PersonalizationDesign.RejectParams"]
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to rejected.
"""
return cast(
"PersonalizationDesign",
self.resource._request(
"post",
"/v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject".format(
personalization_design=sanitize_id(
self.resource.get("id")
)
),
params=params,
),
)
@classmethod
async def _cls_reject_async(
cls,
personalization_design: str,
**params: Unpack["PersonalizationDesign.RejectParams"],
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to rejected.
"""
return cast(
"PersonalizationDesign",
await cls._static_request_async(
"post",
"/v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject".format(
personalization_design=sanitize_id(
personalization_design
)
),
params=params,
),
)
@overload
@staticmethod
async def reject_async(
personalization_design: str,
**params: Unpack["PersonalizationDesign.RejectParams"],
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to rejected.
"""
...
@overload
async def reject_async(
self, **params: Unpack["PersonalizationDesign.RejectParams"]
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to rejected.
"""
...
@class_method_variant("_cls_reject_async")
async def reject_async( # pyright: ignore[reportGeneralTypeIssues]
self, **params: Unpack["PersonalizationDesign.RejectParams"]
) -> "PersonalizationDesign":
"""
Updates the status of the specified testmode personalization design object to rejected.
"""
return cast(
"PersonalizationDesign",
await self.resource._request_async(
"post",
"/v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject".format(
personalization_design=sanitize_id(
self.resource.get("id")
)
),
params=params,
),
)
@property
def test_helpers(self):
return self.TestHelpers(self)
_inner_class_types = {
"carrier_text": CarrierText,
"preferences": Preferences,
"rejection_reasons": RejectionReasons,
}
PersonalizationDesign.TestHelpers._resource_cls = PersonalizationDesign
|