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
|
# -*- 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 importlib import import_module
from typing_extensions import TYPE_CHECKING
if TYPE_CHECKING:
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe.checkout._session import Session
from stripe.checkout._session_line_item_service import (
SessionLineItemService,
)
from stripe.params.checkout._session_create_params import (
SessionCreateParams,
)
from stripe.params.checkout._session_expire_params import (
SessionExpireParams,
)
from stripe.params.checkout._session_list_params import SessionListParams
from stripe.params.checkout._session_retrieve_params import (
SessionRetrieveParams,
)
from stripe.params.checkout._session_update_params import (
SessionUpdateParams,
)
_subservices = {
"line_items": [
"stripe.checkout._session_line_item_service",
"SessionLineItemService",
],
}
class SessionService(StripeService):
line_items: "SessionLineItemService"
def __init__(self, requestor):
super().__init__(requestor)
def __getattr__(self, name):
try:
import_from, service = _subservices[name]
service_class = getattr(
import_module(import_from),
service,
)
setattr(
self,
name,
service_class(self._requestor),
)
return getattr(self, name)
except KeyError:
raise AttributeError()
def list(
self,
params: Optional["SessionListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Session]":
"""
Returns a list of Checkout Sessions.
"""
return cast(
"ListObject[Session]",
self._request(
"get",
"/v1/checkout/sessions",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["SessionListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Session]":
"""
Returns a list of Checkout Sessions.
"""
return cast(
"ListObject[Session]",
await self._request_async(
"get",
"/v1/checkout/sessions",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: Optional["SessionCreateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Session":
"""
Creates a Checkout Session object.
"""
return cast(
"Session",
self._request(
"post",
"/v1/checkout/sessions",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: Optional["SessionCreateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Session":
"""
Creates a Checkout Session object.
"""
return cast(
"Session",
await self._request_async(
"post",
"/v1/checkout/sessions",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
session: str,
params: Optional["SessionRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Session":
"""
Retrieves a Checkout Session object.
"""
return cast(
"Session",
self._request(
"get",
"/v1/checkout/sessions/{session}".format(
session=sanitize_id(session),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
session: str,
params: Optional["SessionRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Session":
"""
Retrieves a Checkout Session object.
"""
return cast(
"Session",
await self._request_async(
"get",
"/v1/checkout/sessions/{session}".format(
session=sanitize_id(session),
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
session: str,
params: Optional["SessionUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Session":
"""
Updates a Checkout Session object.
Related guide: [Dynamically update Checkout](https://docs.stripe.com/payments/checkout/dynamic-updates)
"""
return cast(
"Session",
self._request(
"post",
"/v1/checkout/sessions/{session}".format(
session=sanitize_id(session),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
session: str,
params: Optional["SessionUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Session":
"""
Updates a Checkout Session object.
Related guide: [Dynamically update Checkout](https://docs.stripe.com/payments/checkout/dynamic-updates)
"""
return cast(
"Session",
await self._request_async(
"post",
"/v1/checkout/sessions/{session}".format(
session=sanitize_id(session),
),
base_address="api",
params=params,
options=options,
),
)
def expire(
self,
session: str,
params: Optional["SessionExpireParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Session":
"""
A Checkout Session can be expired when it is in one of these statuses: open
After it expires, a customer can't complete a Checkout Session and customers loading the Checkout Session see a message saying the Checkout Session is expired.
"""
return cast(
"Session",
self._request(
"post",
"/v1/checkout/sessions/{session}/expire".format(
session=sanitize_id(session),
),
base_address="api",
params=params,
options=options,
),
)
async def expire_async(
self,
session: str,
params: Optional["SessionExpireParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Session":
"""
A Checkout Session can be expired when it is in one of these statuses: open
After it expires, a customer can't complete a Checkout Session and customers loading the Checkout Session see a message saying the Checkout Session is expired.
"""
return cast(
"Session",
await self._request_async(
"post",
"/v1/checkout/sessions/{session}/expire".format(
session=sanitize_id(session),
),
base_address="api",
params=params,
options=options,
),
)
|