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
|
# -*- 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.params.terminal._reader_cancel_action_params import (
ReaderCancelActionParams,
)
from stripe.params.terminal._reader_collect_inputs_params import (
ReaderCollectInputsParams,
)
from stripe.params.terminal._reader_collect_payment_method_params import (
ReaderCollectPaymentMethodParams,
)
from stripe.params.terminal._reader_confirm_payment_intent_params import (
ReaderConfirmPaymentIntentParams,
)
from stripe.params.terminal._reader_create_params import ReaderCreateParams
from stripe.params.terminal._reader_delete_params import ReaderDeleteParams
from stripe.params.terminal._reader_list_params import ReaderListParams
from stripe.params.terminal._reader_process_payment_intent_params import (
ReaderProcessPaymentIntentParams,
)
from stripe.params.terminal._reader_process_setup_intent_params import (
ReaderProcessSetupIntentParams,
)
from stripe.params.terminal._reader_refund_payment_params import (
ReaderRefundPaymentParams,
)
from stripe.params.terminal._reader_retrieve_params import (
ReaderRetrieveParams,
)
from stripe.params.terminal._reader_set_reader_display_params import (
ReaderSetReaderDisplayParams,
)
from stripe.params.terminal._reader_update_params import ReaderUpdateParams
from stripe.terminal._reader import Reader
class ReaderService(StripeService):
def delete(
self,
reader: str,
params: Optional["ReaderDeleteParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Deletes a Reader object.
"""
return cast(
"Reader",
self._request(
"delete",
"/v1/terminal/readers/{reader}".format(
reader=sanitize_id(reader),
),
base_address="api",
params=params,
options=options,
),
)
async def delete_async(
self,
reader: str,
params: Optional["ReaderDeleteParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Deletes a Reader object.
"""
return cast(
"Reader",
await self._request_async(
"delete",
"/v1/terminal/readers/{reader}".format(
reader=sanitize_id(reader),
),
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
reader: str,
params: Optional["ReaderRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Retrieves a Reader object.
"""
return cast(
"Reader",
self._request(
"get",
"/v1/terminal/readers/{reader}".format(
reader=sanitize_id(reader),
),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
reader: str,
params: Optional["ReaderRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Retrieves a Reader object.
"""
return cast(
"Reader",
await self._request_async(
"get",
"/v1/terminal/readers/{reader}".format(
reader=sanitize_id(reader),
),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
reader: str,
params: Optional["ReaderUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
"""
return cast(
"Reader",
self._request(
"post",
"/v1/terminal/readers/{reader}".format(
reader=sanitize_id(reader),
),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
reader: str,
params: Optional["ReaderUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Updates a Reader object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
"""
return cast(
"Reader",
await self._request_async(
"post",
"/v1/terminal/readers/{reader}".format(
reader=sanitize_id(reader),
),
base_address="api",
params=params,
options=options,
),
)
def list(
self,
params: Optional["ReaderListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Reader]":
"""
Returns a list of Reader objects.
"""
return cast(
"ListObject[Reader]",
self._request(
"get",
"/v1/terminal/readers",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["ReaderListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Reader]":
"""
Returns a list of Reader objects.
"""
return cast(
"ListObject[Reader]",
await self._request_async(
"get",
"/v1/terminal/readers",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: "ReaderCreateParams",
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Creates a new Reader object.
"""
return cast(
"Reader",
self._request(
"post",
"/v1/terminal/readers",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: "ReaderCreateParams",
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Creates a new Reader object.
"""
return cast(
"Reader",
await self._request_async(
"post",
"/v1/terminal/readers",
base_address="api",
params=params,
options=options,
),
)
def cancel_action(
self,
reader: str,
params: Optional["ReaderCancelActionParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Cancels the current reader action. See [Programmatic Cancellation](https://docs.stripe.com/docs/terminal/payments/collect-card-payment?terminal-sdk-platform=server-driven#programmatic-cancellation) for more details.
"""
return cast(
"Reader",
self._request(
"post",
"/v1/terminal/readers/{reader}/cancel_action".format(
reader=sanitize_id(reader),
),
base_address="api",
params=params,
options=options,
),
)
async def cancel_action_async(
self,
reader: str,
params: Optional["ReaderCancelActionParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Cancels the current reader action. See [Programmatic Cancellation](https://docs.stripe.com/docs/terminal/payments/collect-card-payment?terminal-sdk-platform=server-driven#programmatic-cancellation) for more details.
"""
return cast(
"Reader",
await self._request_async(
"post",
"/v1/terminal/readers/{reader}/cancel_action".format(
reader=sanitize_id(reader),
),
base_address="api",
params=params,
options=options,
),
)
def collect_inputs(
self,
reader: str,
params: "ReaderCollectInputsParams",
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Initiates an [input collection flow](https://docs.stripe.com/docs/terminal/features/collect-inputs) on a Reader to display input forms and collect information from your customers.
"""
return cast(
"Reader",
self._request(
"post",
"/v1/terminal/readers/{reader}/collect_inputs".format(
reader=sanitize_id(reader),
),
base_address="api",
params=params,
options=options,
),
)
async def collect_inputs_async(
self,
reader: str,
params: "ReaderCollectInputsParams",
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Initiates an [input collection flow](https://docs.stripe.com/docs/terminal/features/collect-inputs) on a Reader to display input forms and collect information from your customers.
"""
return cast(
"Reader",
await self._request_async(
"post",
"/v1/terminal/readers/{reader}/collect_inputs".format(
reader=sanitize_id(reader),
),
base_address="api",
params=params,
options=options,
),
)
def collect_payment_method(
self,
reader: str,
params: "ReaderCollectPaymentMethodParams",
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation. See [Collecting a Payment method](https://docs.stripe.com/docs/terminal/payments/collect-card-payment?terminal-sdk-platform=server-driven&process=inspect#collect-a-paymentmethod) for more details.
"""
return cast(
"Reader",
self._request(
"post",
"/v1/terminal/readers/{reader}/collect_payment_method".format(
reader=sanitize_id(reader),
),
base_address="api",
params=params,
options=options,
),
)
async def collect_payment_method_async(
self,
reader: str,
params: "ReaderCollectPaymentMethodParams",
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Initiates a payment flow on a Reader and updates the PaymentIntent with card details before manual confirmation. See [Collecting a Payment method](https://docs.stripe.com/docs/terminal/payments/collect-card-payment?terminal-sdk-platform=server-driven&process=inspect#collect-a-paymentmethod) for more details.
"""
return cast(
"Reader",
await self._request_async(
"post",
"/v1/terminal/readers/{reader}/collect_payment_method".format(
reader=sanitize_id(reader),
),
base_address="api",
params=params,
options=options,
),
)
def confirm_payment_intent(
self,
reader: str,
params: "ReaderConfirmPaymentIntentParams",
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Finalizes a payment on a Reader. See [Confirming a Payment](https://docs.stripe.com/docs/terminal/payments/collect-card-payment?terminal-sdk-platform=server-driven&process=inspect#confirm-the-paymentintent) for more details.
"""
return cast(
"Reader",
self._request(
"post",
"/v1/terminal/readers/{reader}/confirm_payment_intent".format(
reader=sanitize_id(reader),
),
base_address="api",
params=params,
options=options,
),
)
async def confirm_payment_intent_async(
self,
reader: str,
params: "ReaderConfirmPaymentIntentParams",
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Finalizes a payment on a Reader. See [Confirming a Payment](https://docs.stripe.com/docs/terminal/payments/collect-card-payment?terminal-sdk-platform=server-driven&process=inspect#confirm-the-paymentintent) for more details.
"""
return cast(
"Reader",
await self._request_async(
"post",
"/v1/terminal/readers/{reader}/confirm_payment_intent".format(
reader=sanitize_id(reader),
),
base_address="api",
params=params,
options=options,
),
)
def process_payment_intent(
self,
reader: str,
params: "ReaderProcessPaymentIntentParams",
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Initiates a payment flow on a Reader. See [process the payment](https://docs.stripe.com/docs/terminal/payments/collect-card-payment?terminal-sdk-platform=server-driven&process=immediately#process-payment) for more details.
"""
return cast(
"Reader",
self._request(
"post",
"/v1/terminal/readers/{reader}/process_payment_intent".format(
reader=sanitize_id(reader),
),
base_address="api",
params=params,
options=options,
),
)
async def process_payment_intent_async(
self,
reader: str,
params: "ReaderProcessPaymentIntentParams",
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Initiates a payment flow on a Reader. See [process the payment](https://docs.stripe.com/docs/terminal/payments/collect-card-payment?terminal-sdk-platform=server-driven&process=immediately#process-payment) for more details.
"""
return cast(
"Reader",
await self._request_async(
"post",
"/v1/terminal/readers/{reader}/process_payment_intent".format(
reader=sanitize_id(reader),
),
base_address="api",
params=params,
options=options,
),
)
def process_setup_intent(
self,
reader: str,
params: "ReaderProcessSetupIntentParams",
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Initiates a SetupIntent flow on a Reader. See [Save directly without charging](https://docs.stripe.com/docs/terminal/features/saving-payment-details/save-directly) for more details.
"""
return cast(
"Reader",
self._request(
"post",
"/v1/terminal/readers/{reader}/process_setup_intent".format(
reader=sanitize_id(reader),
),
base_address="api",
params=params,
options=options,
),
)
async def process_setup_intent_async(
self,
reader: str,
params: "ReaderProcessSetupIntentParams",
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Initiates a SetupIntent flow on a Reader. See [Save directly without charging](https://docs.stripe.com/docs/terminal/features/saving-payment-details/save-directly) for more details.
"""
return cast(
"Reader",
await self._request_async(
"post",
"/v1/terminal/readers/{reader}/process_setup_intent".format(
reader=sanitize_id(reader),
),
base_address="api",
params=params,
options=options,
),
)
def refund_payment(
self,
reader: str,
params: Optional["ReaderRefundPaymentParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Initiates an in-person refund on a Reader. See [Refund an Interac Payment](https://docs.stripe.com/docs/terminal/payments/regional?integration-country=CA#refund-an-interac-payment) for more details.
"""
return cast(
"Reader",
self._request(
"post",
"/v1/terminal/readers/{reader}/refund_payment".format(
reader=sanitize_id(reader),
),
base_address="api",
params=params,
options=options,
),
)
async def refund_payment_async(
self,
reader: str,
params: Optional["ReaderRefundPaymentParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Initiates an in-person refund on a Reader. See [Refund an Interac Payment](https://docs.stripe.com/docs/terminal/payments/regional?integration-country=CA#refund-an-interac-payment) for more details.
"""
return cast(
"Reader",
await self._request_async(
"post",
"/v1/terminal/readers/{reader}/refund_payment".format(
reader=sanitize_id(reader),
),
base_address="api",
params=params,
options=options,
),
)
def set_reader_display(
self,
reader: str,
params: "ReaderSetReaderDisplayParams",
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Sets the reader display to show [cart details](https://docs.stripe.com/docs/terminal/features/display).
"""
return cast(
"Reader",
self._request(
"post",
"/v1/terminal/readers/{reader}/set_reader_display".format(
reader=sanitize_id(reader),
),
base_address="api",
params=params,
options=options,
),
)
async def set_reader_display_async(
self,
reader: str,
params: "ReaderSetReaderDisplayParams",
options: Optional["RequestOptions"] = None,
) -> "Reader":
"""
Sets the reader display to show [cart details](https://docs.stripe.com/docs/terminal/features/display).
"""
return cast(
"Reader",
await self._request_async(
"post",
"/v1/terminal/readers/{reader}/set_reader_display".format(
reader=sanitize_id(reader),
),
base_address="api",
params=params,
options=options,
),
)
|