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
|
# -*- 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._person import Person
from stripe._request_options import RequestOptions
from stripe.params._account_person_create_params import (
AccountPersonCreateParams,
)
from stripe.params._account_person_delete_params import (
AccountPersonDeleteParams,
)
from stripe.params._account_person_list_params import (
AccountPersonListParams,
)
from stripe.params._account_person_retrieve_params import (
AccountPersonRetrieveParams,
)
from stripe.params._account_person_update_params import (
AccountPersonUpdateParams,
)
class AccountPersonService(StripeService):
def delete(
self,
account: str,
person: str,
params: Optional["AccountPersonDeleteParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Person":
"""
Deletes an existing person's relationship to the account's legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
"""
return cast(
"Person",
self._request(
"delete",
"/v1/accounts/{account}/persons/{person}".format(
account=sanitize_id(account),
person=sanitize_id(person),
),
base_address="api",
params=params,
options=options,
),
)
async def delete_async(
self,
account: str,
person: str,
params: Optional["AccountPersonDeleteParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Person":
"""
Deletes an existing person's relationship to the account's legal entity. Any person with a relationship for an account can be deleted through the API, except if the person is the account_opener. If your integration is using the executive parameter, you cannot delete the only verified executive on file.
"""
return cast(
"Person",
await self._request_async(
"delete",
"/v1/accounts/{account}/persons/{person}".format(
account=sanitize_id(account),
person=sanitize_id(person),
),
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
account: str,
person: str,
params: Optional["AccountPersonRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Person":
"""
Retrieves an existing person.
"""
return cast(
"Person",
self._request(
"get",
"/v1/accounts/{account}/persons/{person}".format(
account=sanitize_id(account),
person=sanitize_id(person),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
account: str,
person: str,
params: Optional["AccountPersonRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Person":
"""
Retrieves an existing person.
"""
return cast(
"Person",
await self._request_async(
"get",
"/v1/accounts/{account}/persons/{person}".format(
account=sanitize_id(account),
person=sanitize_id(person),
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
account: str,
person: str,
params: Optional["AccountPersonUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Person":
"""
Updates an existing person.
"""
return cast(
"Person",
self._request(
"post",
"/v1/accounts/{account}/persons/{person}".format(
account=sanitize_id(account),
person=sanitize_id(person),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
account: str,
person: str,
params: Optional["AccountPersonUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Person":
"""
Updates an existing person.
"""
return cast(
"Person",
await self._request_async(
"post",
"/v1/accounts/{account}/persons/{person}".format(
account=sanitize_id(account),
person=sanitize_id(person),
),
base_address="api",
params=params,
options=options,
),
)
def list(
self,
account: str,
params: Optional["AccountPersonListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Person]":
"""
Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
"""
return cast(
"ListObject[Person]",
self._request(
"get",
"/v1/accounts/{account}/persons".format(
account=sanitize_id(account),
),
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
account: str,
params: Optional["AccountPersonListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Person]":
"""
Returns a list of people associated with the account's legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
"""
return cast(
"ListObject[Person]",
await self._request_async(
"get",
"/v1/accounts/{account}/persons".format(
account=sanitize_id(account),
),
base_address="api",
params=params,
options=options,
),
)
def create(
self,
account: str,
params: Optional["AccountPersonCreateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Person":
"""
Creates a new person.
"""
return cast(
"Person",
self._request(
"post",
"/v1/accounts/{account}/persons".format(
account=sanitize_id(account),
),
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
account: str,
params: Optional["AccountPersonCreateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Person":
"""
Creates a new person.
"""
return cast(
"Person",
await self._request_async(
"post",
"/v1/accounts/{account}/persons".format(
account=sanitize_id(account),
),
base_address="api",
params=params,
options=options,
),
)
|