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
|
# -*- 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._account import Account
from stripe._bank_account import BankAccount
from stripe._card import Card
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe._source import Source
from stripe.params._customer_payment_source_create_params import (
CustomerPaymentSourceCreateParams,
)
from stripe.params._customer_payment_source_delete_params import (
CustomerPaymentSourceDeleteParams,
)
from stripe.params._customer_payment_source_list_params import (
CustomerPaymentSourceListParams,
)
from stripe.params._customer_payment_source_retrieve_params import (
CustomerPaymentSourceRetrieveParams,
)
from stripe.params._customer_payment_source_update_params import (
CustomerPaymentSourceUpdateParams,
)
from stripe.params._customer_payment_source_verify_params import (
CustomerPaymentSourceVerifyParams,
)
from typing import Union
class CustomerPaymentSourceService(StripeService):
def list(
self,
customer: str,
params: Optional["CustomerPaymentSourceListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Union[Account, BankAccount, Card, Source]]":
"""
List sources for a specified customer.
"""
return cast(
"ListObject[Union[Account, BankAccount, Card, Source]]",
self._request(
"get",
"/v1/customers/{customer}/sources".format(
customer=sanitize_id(customer),
),
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
customer: str,
params: Optional["CustomerPaymentSourceListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Union[Account, BankAccount, Card, Source]]":
"""
List sources for a specified customer.
"""
return cast(
"ListObject[Union[Account, BankAccount, Card, Source]]",
await self._request_async(
"get",
"/v1/customers/{customer}/sources".format(
customer=sanitize_id(customer),
),
base_address="api",
params=params,
options=options,
),
)
def create(
self,
customer: str,
params: "CustomerPaymentSourceCreateParams",
options: Optional["RequestOptions"] = None,
) -> "Union[Account, BankAccount, Card, Source]":
"""
When you create a new credit card, you must specify a customer or recipient on which to create it.
If the card's owner has no default card, then the new card will become the default.
However, if the owner already has a default, then it will not change.
To change the default, you should [update the customer](https://docs.stripe.com/docs/api#update_customer) to have a new default_source.
"""
return cast(
"Union[Account, BankAccount, Card, Source]",
self._request(
"post",
"/v1/customers/{customer}/sources".format(
customer=sanitize_id(customer),
),
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
customer: str,
params: "CustomerPaymentSourceCreateParams",
options: Optional["RequestOptions"] = None,
) -> "Union[Account, BankAccount, Card, Source]":
"""
When you create a new credit card, you must specify a customer or recipient on which to create it.
If the card's owner has no default card, then the new card will become the default.
However, if the owner already has a default, then it will not change.
To change the default, you should [update the customer](https://docs.stripe.com/docs/api#update_customer) to have a new default_source.
"""
return cast(
"Union[Account, BankAccount, Card, Source]",
await self._request_async(
"post",
"/v1/customers/{customer}/sources".format(
customer=sanitize_id(customer),
),
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
customer: str,
id: str,
params: Optional["CustomerPaymentSourceRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Union[Account, BankAccount, Card, Source]":
"""
Retrieve a specified source for a given customer.
"""
return cast(
"Union[Account, BankAccount, Card, Source]",
self._request(
"get",
"/v1/customers/{customer}/sources/{id}".format(
customer=sanitize_id(customer),
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
customer: str,
id: str,
params: Optional["CustomerPaymentSourceRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Union[Account, BankAccount, Card, Source]":
"""
Retrieve a specified source for a given customer.
"""
return cast(
"Union[Account, BankAccount, Card, Source]",
await self._request_async(
"get",
"/v1/customers/{customer}/sources/{id}".format(
customer=sanitize_id(customer),
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
customer: str,
id: str,
params: Optional["CustomerPaymentSourceUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Union[Account, BankAccount, Card, Source]":
"""
Update a specified source for a given customer.
"""
return cast(
"Union[Account, BankAccount, Card, Source]",
self._request(
"post",
"/v1/customers/{customer}/sources/{id}".format(
customer=sanitize_id(customer),
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
customer: str,
id: str,
params: Optional["CustomerPaymentSourceUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Union[Account, BankAccount, Card, Source]":
"""
Update a specified source for a given customer.
"""
return cast(
"Union[Account, BankAccount, Card, Source]",
await self._request_async(
"post",
"/v1/customers/{customer}/sources/{id}".format(
customer=sanitize_id(customer),
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
def delete(
self,
customer: str,
id: str,
params: Optional["CustomerPaymentSourceDeleteParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Union[Account, BankAccount, Card, Source]":
"""
Delete a specified source for a given customer.
"""
return cast(
"Union[Account, BankAccount, Card, Source]",
self._request(
"delete",
"/v1/customers/{customer}/sources/{id}".format(
customer=sanitize_id(customer),
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def delete_async(
self,
customer: str,
id: str,
params: Optional["CustomerPaymentSourceDeleteParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Union[Account, BankAccount, Card, Source]":
"""
Delete a specified source for a given customer.
"""
return cast(
"Union[Account, BankAccount, Card, Source]",
await self._request_async(
"delete",
"/v1/customers/{customer}/sources/{id}".format(
customer=sanitize_id(customer),
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
def verify(
self,
customer: str,
id: str,
params: Optional["CustomerPaymentSourceVerifyParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "BankAccount":
"""
Verify a specified bank account for a given customer.
"""
return cast(
"BankAccount",
self._request(
"post",
"/v1/customers/{customer}/sources/{id}/verify".format(
customer=sanitize_id(customer),
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
async def verify_async(
self,
customer: str,
id: str,
params: Optional["CustomerPaymentSourceVerifyParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "BankAccount":
"""
Verify a specified bank account for a given customer.
"""
return cast(
"BankAccount",
await self._request_async(
"post",
"/v1/customers/{customer}/sources/{id}/verify".format(
customer=sanitize_id(customer),
id=sanitize_id(id),
),
base_address="api",
params=params,
options=options,
),
)
|