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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from typing import Optional, cast
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe.issuing._cardholder import Cardholder
from stripe.params.issuing._cardholder_create_params import (
CardholderCreateParams,
)
from stripe.params.issuing._cardholder_list_params import (
CardholderListParams,
)
from stripe.params.issuing._cardholder_retrieve_params import (
CardholderRetrieveParams,
)
from stripe.params.issuing._cardholder_update_params import (
CardholderUpdateParams,
)
class CardholderService(StripeService):
def list(
self,
params: Optional["CardholderListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Cardholder]":
"""
Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
"""
return cast(
"ListObject[Cardholder]",
self._request(
"get",
"/v1/issuing/cardholders",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["CardholderListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Cardholder]":
"""
Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
"""
return cast(
"ListObject[Cardholder]",
await self._request_async(
"get",
"/v1/issuing/cardholders",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: "CardholderCreateParams",
options: Optional["RequestOptions"] = None,
) -> "Cardholder":
"""
Creates a new Issuing Cardholder object that can be issued cards.
"""
return cast(
"Cardholder",
self._request(
"post",
"/v1/issuing/cardholders",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: "CardholderCreateParams",
options: Optional["RequestOptions"] = None,
) -> "Cardholder":
"""
Creates a new Issuing Cardholder object that can be issued cards.
"""
return cast(
"Cardholder",
await self._request_async(
"post",
"/v1/issuing/cardholders",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
cardholder: str,
params: Optional["CardholderRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Cardholder":
"""
Retrieves an Issuing Cardholder object.
"""
return cast(
"Cardholder",
self._request(
"get",
"/v1/issuing/cardholders/{cardholder}".format(
cardholder=sanitize_id(cardholder),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
cardholder: str,
params: Optional["CardholderRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Cardholder":
"""
Retrieves an Issuing Cardholder object.
"""
return cast(
"Cardholder",
await self._request_async(
"get",
"/v1/issuing/cardholders/{cardholder}".format(
cardholder=sanitize_id(cardholder),
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
cardholder: str,
params: Optional["CardholderUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Cardholder":
"""
Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
"""
return cast(
"Cardholder",
self._request(
"post",
"/v1/issuing/cardholders/{cardholder}".format(
cardholder=sanitize_id(cardholder),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
cardholder: str,
params: Optional["CardholderUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Cardholder":
"""
Updates the specified Issuing Cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
"""
return cast(
"Cardholder",
await self._request_async(
"post",
"/v1/issuing/cardholders/{cardholder}".format(
cardholder=sanitize_id(cardholder),
),
base_address="api",
params=params,
options=options,
),
)
|