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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._createable_api_resource import CreateableAPIResource
from typing import ClassVar, Optional, cast
from typing_extensions import Literal, Unpack, TYPE_CHECKING
if TYPE_CHECKING:
from stripe.params.terminal._connection_token_create_params import (
ConnectionTokenCreateParams,
)
class ConnectionToken(CreateableAPIResource["ConnectionToken"]):
"""
A Connection Token is used by the Stripe Terminal SDK to connect to a reader.
Related guide: [Fleet management](https://docs.stripe.com/terminal/fleet/locations)
"""
OBJECT_NAME: ClassVar[Literal["terminal.connection_token"]] = (
"terminal.connection_token"
)
location: Optional[str]
"""
The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens).
"""
object: Literal["terminal.connection_token"]
"""
String representing the object's type. Objects of the same type share the same value.
"""
secret: str
"""
Your application should pass this token to the Stripe Terminal SDK.
"""
@classmethod
def create(
cls, **params: Unpack["ConnectionTokenCreateParams"]
) -> "ConnectionToken":
"""
To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.
"""
return cast(
"ConnectionToken",
cls._static_request(
"post",
cls.class_url(),
params=params,
),
)
@classmethod
async def create_async(
cls, **params: Unpack["ConnectionTokenCreateParams"]
) -> "ConnectionToken":
"""
To connect to a reader the Stripe Terminal SDK needs to retrieve a short-lived connection token from Stripe, proxied through your server. On your backend, add an endpoint that creates and returns a connection token.
"""
return cast(
"ConnectionToken",
await cls._static_request_async(
"post",
cls.class_url(),
params=params,
),
)
|
