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
|
# -*- 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.climate._order import Order
from stripe.params.climate._order_cancel_params import OrderCancelParams
from stripe.params.climate._order_create_params import OrderCreateParams
from stripe.params.climate._order_list_params import OrderListParams
from stripe.params.climate._order_retrieve_params import (
OrderRetrieveParams,
)
from stripe.params.climate._order_update_params import OrderUpdateParams
class OrderService(StripeService):
def list(
self,
params: Optional["OrderListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Order]":
"""
Lists all Climate order objects. The orders are returned sorted by creation date, with the
most recently created orders appearing first.
"""
return cast(
"ListObject[Order]",
self._request(
"get",
"/v1/climate/orders",
base_address="api",
params=params,
options=options,
),
)
async def list_async(
self,
params: Optional["OrderListParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "ListObject[Order]":
"""
Lists all Climate order objects. The orders are returned sorted by creation date, with the
most recently created orders appearing first.
"""
return cast(
"ListObject[Order]",
await self._request_async(
"get",
"/v1/climate/orders",
base_address="api",
params=params,
options=options,
),
)
def create(
self,
params: "OrderCreateParams",
options: Optional["RequestOptions"] = None,
) -> "Order":
"""
Creates a Climate order object for a given Climate product. The order will be processed immediately
after creation and payment will be deducted your Stripe balance.
"""
return cast(
"Order",
self._request(
"post",
"/v1/climate/orders",
base_address="api",
params=params,
options=options,
),
)
async def create_async(
self,
params: "OrderCreateParams",
options: Optional["RequestOptions"] = None,
) -> "Order":
"""
Creates a Climate order object for a given Climate product. The order will be processed immediately
after creation and payment will be deducted your Stripe balance.
"""
return cast(
"Order",
await self._request_async(
"post",
"/v1/climate/orders",
base_address="api",
params=params,
options=options,
),
)
def retrieve(
self,
order: str,
params: Optional["OrderRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Order":
"""
Retrieves the details of a Climate order object with the given ID.
"""
return cast(
"Order",
self._request(
"get",
"/v1/climate/orders/{order}".format(order=sanitize_id(order)),
base_address="api",
params=params,
options=options,
),
)
async def retrieve_async(
self,
order: str,
params: Optional["OrderRetrieveParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Order":
"""
Retrieves the details of a Climate order object with the given ID.
"""
return cast(
"Order",
await self._request_async(
"get",
"/v1/climate/orders/{order}".format(order=sanitize_id(order)),
base_address="api",
params=params,
options=options,
),
)
def update(
self,
order: str,
params: Optional["OrderUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Order":
"""
Updates the specified order by setting the values of the parameters passed.
"""
return cast(
"Order",
self._request(
"post",
"/v1/climate/orders/{order}".format(order=sanitize_id(order)),
base_address="api",
params=params,
options=options,
),
)
async def update_async(
self,
order: str,
params: Optional["OrderUpdateParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Order":
"""
Updates the specified order by setting the values of the parameters passed.
"""
return cast(
"Order",
await self._request_async(
"post",
"/v1/climate/orders/{order}".format(order=sanitize_id(order)),
base_address="api",
params=params,
options=options,
),
)
def cancel(
self,
order: str,
params: Optional["OrderCancelParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Order":
"""
Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the
reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier
might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe
provides 90 days advance notice and refunds the amount_total.
"""
return cast(
"Order",
self._request(
"post",
"/v1/climate/orders/{order}/cancel".format(
order=sanitize_id(order),
),
base_address="api",
params=params,
options=options,
),
)
async def cancel_async(
self,
order: str,
params: Optional["OrderCancelParams"] = None,
options: Optional["RequestOptions"] = None,
) -> "Order":
"""
Cancels a Climate order. You can cancel an order within 24 hours of creation. Stripe refunds the
reservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier
might cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe
provides 90 days advance notice and refunds the amount_total.
"""
return cast(
"Order",
await self._request_async(
"post",
"/v1/climate/orders/{order}/cancel".format(
order=sanitize_id(order),
),
base_address="api",
params=params,
options=options,
),
)
|
