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
|
# -*- coding: utf-8 -*-
# File generated from our OpenAPI spec
from stripe._list_object import ListObject
from stripe._request_options import RequestOptions
from stripe._stripe_service import StripeService
from stripe._util import sanitize_id
from stripe.forwarding._request import Request
from typing import Dict, List, cast
from typing_extensions import Literal, NotRequired, TypedDict
class RequestService(StripeService):
class CreateParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
metadata: NotRequired[Dict[str, str]]
"""
Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
"""
payment_method: str
"""
The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed.
"""
replacements: List[
Literal[
"card_cvc",
"card_expiry",
"card_number",
"cardholder_name",
"request_signature",
]
]
"""
The field kinds to be replaced in the forwarded request.
"""
request: "RequestService.CreateParamsRequest"
"""
The request body and headers to be sent to the destination endpoint.
"""
url: str
"""
The destination URL for the forwarded request. Must be supported by the config.
"""
class CreateParamsRequest(TypedDict):
body: NotRequired[str]
"""
The body payload to send to the destination endpoint.
"""
headers: NotRequired[List["RequestService.CreateParamsRequestHeader"]]
"""
The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included.
"""
class CreateParamsRequestHeader(TypedDict):
name: str
"""
The header name.
"""
value: str
"""
The header value.
"""
class ListParams(TypedDict):
created: NotRequired["RequestService.ListParamsCreated"]
"""
Similar to other List endpoints, filters results based on created timestamp. You can pass gt, gte, lt, and lte timestamp values.
"""
ending_before: NotRequired[str]
"""
A pagination cursor to fetch the previous page of the list. The value must be a ForwardingRequest ID.
"""
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
limit: NotRequired[int]
"""
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
"""
starting_after: NotRequired[str]
"""
A pagination cursor to fetch the next page of the list. The value must be a ForwardingRequest ID.
"""
class ListParamsCreated(TypedDict):
gt: NotRequired[int]
"""
Return results where the `created` field is greater than this value.
"""
gte: NotRequired[int]
"""
Return results where the `created` field is greater than or equal to this value.
"""
lt: NotRequired[int]
"""
Return results where the `created` field is less than this value.
"""
lte: NotRequired[int]
"""
Return results where the `created` field is less than or equal to this value.
"""
class RetrieveParams(TypedDict):
expand: NotRequired[List[str]]
"""
Specifies which fields in the response should be expanded.
"""
def list(
self,
params: "RequestService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[Request]:
"""
Lists all ForwardingRequest objects.
"""
return cast(
ListObject[Request],
self._request(
"get",
"/v1/forwarding/requests",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: "RequestService.ListParams" = {},
options: RequestOptions = {},
) -> ListObject[Request]:
"""
Lists all ForwardingRequest objects.
"""
return cast(
ListObject[Request],
await self._request_async(
"get",
"/v1/forwarding/requests",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: "RequestService.CreateParams",
options: RequestOptions = {},
) -> Request:
"""
Creates a ForwardingRequest object.
"""
return cast(
Request,
self._request(
"post",
"/v1/forwarding/requests",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: "RequestService.CreateParams",
options: RequestOptions = {},
) -> Request:
"""
Creates a ForwardingRequest object.
"""
return cast(
Request,
await self._request_async(
"post",
"/v1/forwarding/requests",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
id: str,
params: "RequestService.RetrieveParams" = {},
options: RequestOptions = {},
) -> Request:
"""
Retrieves a ForwardingRequest object.
"""
return cast(
Request,
self._request(
"get",
"/v1/forwarding/requests/{id}".format(id=sanitize_id(id)),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
id: str,
params: "RequestService.RetrieveParams" = {},
options: RequestOptions = {},
) -> Request:
"""
Retrieves a ForwardingRequest object.
"""
return cast(
Request,
await self._request_async(
"get",
"/v1/forwarding/requests/{id}".format(id=sanitize_id(id)),
base_address="api",
params=params,
options=options,
),
)
|
