-
Notifications
You must be signed in to change notification settings - Fork 11
Expand file tree
/
Copy pathclient.py
More file actions
414 lines (322 loc) · 15.9 KB
/
Copy pathclient.py
File metadata and controls
414 lines (322 loc) · 15.9 KB
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
# This file was auto-generated by Fern from our API Definition.
from __future__ import annotations
import typing
import httpx
from .core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
from .core.logging import LogConfig, Logger
from .environment import WebflowEnvironment
if typing.TYPE_CHECKING:
from .resources.assets.client import AssetsClient, AsyncAssetsClient
from .resources.collections.client import AsyncCollectionsClient, CollectionsClient
from .resources.components.client import AsyncComponentsClient, ComponentsClient
from .resources.ecommerce.client import AsyncEcommerceClient, EcommerceClient
from .resources.forms.client import AsyncFormsClient, FormsClient
from .resources.inventory.client import AsyncInventoryClient, InventoryClient
from .resources.orders.client import AsyncOrdersClient, OrdersClient
from .resources.pages.client import AsyncPagesClient, PagesClient
from .resources.products.client import AsyncProductsClient, ProductsClient
from .resources.scripts.client import AsyncScriptsClient, ScriptsClient
from .resources.sites.client import AsyncSitesClient, SitesClient
from .resources.token.client import AsyncTokenClient, TokenClient
from .resources.webhooks.client import AsyncWebhooksClient, WebhooksClient
from .resources.workspaces.client import AsyncWorkspacesClient, WorkspacesClient
class Webflow:
"""
Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
Parameters
----------
environment : WebflowEnvironment
The environment to use for requests from the client. from .environment import WebflowEnvironment
Defaults to WebflowEnvironment.DATA_API
access_token : typing.Union[str, typing.Callable[[], str]]
headers : typing.Optional[typing.Dict[str, str]]
Additional headers to send with every request.
timeout : typing.Optional[float]
The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
follow_redirects : typing.Optional[bool]
Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
httpx_client : typing.Optional[httpx.Client]
The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
logging : typing.Optional[typing.Union[LogConfig, Logger]]
Configure logging for the SDK. Accepts a LogConfig dict with 'level' (debug/info/warn/error), 'logger' (custom logger implementation), and 'silent' (boolean, defaults to True) fields. You can also pass a pre-configured Logger instance.
Examples
--------
from webflow import Webflow
client = Webflow(
access_token="YOUR_ACCESS_TOKEN",
)
"""
def __init__(
self,
*,
environment: WebflowEnvironment = WebflowEnvironment.DATA_API,
access_token: typing.Union[str, typing.Callable[[], str]],
headers: typing.Optional[typing.Dict[str, str]] = None,
timeout: typing.Optional[float] = None,
follow_redirects: typing.Optional[bool] = True,
httpx_client: typing.Optional[httpx.Client] = None,
logging: typing.Optional[typing.Union[LogConfig, Logger]] = None,
):
_defaulted_timeout = (
timeout if timeout is not None else 60 if httpx_client is None else httpx_client.timeout.read
)
self._client_wrapper = SyncClientWrapper(
environment=environment,
access_token=access_token,
headers=headers,
httpx_client=httpx_client
if httpx_client is not None
else httpx.Client(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
if follow_redirects is not None
else httpx.Client(timeout=_defaulted_timeout),
timeout=_defaulted_timeout,
logging=logging,
)
self._token: typing.Optional[TokenClient] = None
self._sites: typing.Optional[SitesClient] = None
self._collections: typing.Optional[CollectionsClient] = None
self._pages: typing.Optional[PagesClient] = None
self._components: typing.Optional[ComponentsClient] = None
self._scripts: typing.Optional[ScriptsClient] = None
self._assets: typing.Optional[AssetsClient] = None
self._webhooks: typing.Optional[WebhooksClient] = None
self._forms: typing.Optional[FormsClient] = None
self._products: typing.Optional[ProductsClient] = None
self._orders: typing.Optional[OrdersClient] = None
self._inventory: typing.Optional[InventoryClient] = None
self._ecommerce: typing.Optional[EcommerceClient] = None
self._workspaces: typing.Optional[WorkspacesClient] = None
@property
def token(self):
if self._token is None:
from .resources.token.client import TokenClient # noqa: E402
self._token = TokenClient(client_wrapper=self._client_wrapper)
return self._token
@property
def sites(self):
if self._sites is None:
from .resources.sites.client import SitesClient # noqa: E402
self._sites = SitesClient(client_wrapper=self._client_wrapper)
return self._sites
@property
def collections(self):
if self._collections is None:
from .resources.collections.client import CollectionsClient # noqa: E402
self._collections = CollectionsClient(client_wrapper=self._client_wrapper)
return self._collections
@property
def pages(self):
if self._pages is None:
from .resources.pages.client import PagesClient # noqa: E402
self._pages = PagesClient(client_wrapper=self._client_wrapper)
return self._pages
@property
def components(self):
if self._components is None:
from .resources.components.client import ComponentsClient # noqa: E402
self._components = ComponentsClient(client_wrapper=self._client_wrapper)
return self._components
@property
def scripts(self):
if self._scripts is None:
from .resources.scripts.client import ScriptsClient # noqa: E402
self._scripts = ScriptsClient(client_wrapper=self._client_wrapper)
return self._scripts
@property
def assets(self):
if self._assets is None:
from .resources.assets.client import AssetsClient # noqa: E402
self._assets = AssetsClient(client_wrapper=self._client_wrapper)
return self._assets
@property
def webhooks(self):
if self._webhooks is None:
from .resources.webhooks.client import WebhooksClient # noqa: E402
self._webhooks = WebhooksClient(client_wrapper=self._client_wrapper)
return self._webhooks
@property
def forms(self):
if self._forms is None:
from .resources.forms.client import FormsClient # noqa: E402
self._forms = FormsClient(client_wrapper=self._client_wrapper)
return self._forms
@property
def products(self):
if self._products is None:
from .resources.products.client import ProductsClient # noqa: E402
self._products = ProductsClient(client_wrapper=self._client_wrapper)
return self._products
@property
def orders(self):
if self._orders is None:
from .resources.orders.client import OrdersClient # noqa: E402
self._orders = OrdersClient(client_wrapper=self._client_wrapper)
return self._orders
@property
def inventory(self):
if self._inventory is None:
from .resources.inventory.client import InventoryClient # noqa: E402
self._inventory = InventoryClient(client_wrapper=self._client_wrapper)
return self._inventory
@property
def ecommerce(self):
if self._ecommerce is None:
from .resources.ecommerce.client import EcommerceClient # noqa: E402
self._ecommerce = EcommerceClient(client_wrapper=self._client_wrapper)
return self._ecommerce
@property
def workspaces(self):
if self._workspaces is None:
from .resources.workspaces.client import WorkspacesClient # noqa: E402
self._workspaces = WorkspacesClient(client_wrapper=self._client_wrapper)
return self._workspaces
class AsyncWebflow:
"""
Use this class to access the different functions within the SDK. You can instantiate any number of clients with different configuration that will propagate to these functions.
Parameters
----------
environment : WebflowEnvironment
The environment to use for requests from the client. from .environment import WebflowEnvironment
Defaults to WebflowEnvironment.DATA_API
access_token : typing.Union[str, typing.Callable[[], str]]
headers : typing.Optional[typing.Dict[str, str]]
Additional headers to send with every request.
timeout : typing.Optional[float]
The timeout to be used, in seconds, for requests. By default the timeout is 60 seconds, unless a custom httpx client is used, in which case this default is not enforced.
follow_redirects : typing.Optional[bool]
Whether the default httpx client follows redirects or not, this is irrelevant if a custom httpx client is passed in.
httpx_client : typing.Optional[httpx.AsyncClient]
The httpx client to use for making requests, a preconfigured client is used by default, however this is useful should you want to pass in any custom httpx configuration.
logging : typing.Optional[typing.Union[LogConfig, Logger]]
Configure logging for the SDK. Accepts a LogConfig dict with 'level' (debug/info/warn/error), 'logger' (custom logger implementation), and 'silent' (boolean, defaults to True) fields. You can also pass a pre-configured Logger instance.
Examples
--------
from webflow import AsyncWebflow
client = AsyncWebflow(
access_token="YOUR_ACCESS_TOKEN",
)
"""
def __init__(
self,
*,
environment: WebflowEnvironment = WebflowEnvironment.DATA_API,
access_token: typing.Union[str, typing.Callable[[], str]],
headers: typing.Optional[typing.Dict[str, str]] = None,
timeout: typing.Optional[float] = None,
follow_redirects: typing.Optional[bool] = True,
httpx_client: typing.Optional[httpx.AsyncClient] = None,
logging: typing.Optional[typing.Union[LogConfig, Logger]] = None,
):
_defaulted_timeout = (
timeout if timeout is not None else 60 if httpx_client is None else httpx_client.timeout.read
)
self._client_wrapper = AsyncClientWrapper(
environment=environment,
access_token=access_token,
headers=headers,
httpx_client=httpx_client
if httpx_client is not None
else httpx.AsyncClient(timeout=_defaulted_timeout, follow_redirects=follow_redirects)
if follow_redirects is not None
else httpx.AsyncClient(timeout=_defaulted_timeout),
timeout=_defaulted_timeout,
logging=logging,
)
self._token: typing.Optional[AsyncTokenClient] = None
self._sites: typing.Optional[AsyncSitesClient] = None
self._collections: typing.Optional[AsyncCollectionsClient] = None
self._pages: typing.Optional[AsyncPagesClient] = None
self._components: typing.Optional[AsyncComponentsClient] = None
self._scripts: typing.Optional[AsyncScriptsClient] = None
self._assets: typing.Optional[AsyncAssetsClient] = None
self._webhooks: typing.Optional[AsyncWebhooksClient] = None
self._forms: typing.Optional[AsyncFormsClient] = None
self._products: typing.Optional[AsyncProductsClient] = None
self._orders: typing.Optional[AsyncOrdersClient] = None
self._inventory: typing.Optional[AsyncInventoryClient] = None
self._ecommerce: typing.Optional[AsyncEcommerceClient] = None
self._workspaces: typing.Optional[AsyncWorkspacesClient] = None
@property
def token(self):
if self._token is None:
from .resources.token.client import AsyncTokenClient # noqa: E402
self._token = AsyncTokenClient(client_wrapper=self._client_wrapper)
return self._token
@property
def sites(self):
if self._sites is None:
from .resources.sites.client import AsyncSitesClient # noqa: E402
self._sites = AsyncSitesClient(client_wrapper=self._client_wrapper)
return self._sites
@property
def collections(self):
if self._collections is None:
from .resources.collections.client import AsyncCollectionsClient # noqa: E402
self._collections = AsyncCollectionsClient(client_wrapper=self._client_wrapper)
return self._collections
@property
def pages(self):
if self._pages is None:
from .resources.pages.client import AsyncPagesClient # noqa: E402
self._pages = AsyncPagesClient(client_wrapper=self._client_wrapper)
return self._pages
@property
def components(self):
if self._components is None:
from .resources.components.client import AsyncComponentsClient # noqa: E402
self._components = AsyncComponentsClient(client_wrapper=self._client_wrapper)
return self._components
@property
def scripts(self):
if self._scripts is None:
from .resources.scripts.client import AsyncScriptsClient # noqa: E402
self._scripts = AsyncScriptsClient(client_wrapper=self._client_wrapper)
return self._scripts
@property
def assets(self):
if self._assets is None:
from .resources.assets.client import AsyncAssetsClient # noqa: E402
self._assets = AsyncAssetsClient(client_wrapper=self._client_wrapper)
return self._assets
@property
def webhooks(self):
if self._webhooks is None:
from .resources.webhooks.client import AsyncWebhooksClient # noqa: E402
self._webhooks = AsyncWebhooksClient(client_wrapper=self._client_wrapper)
return self._webhooks
@property
def forms(self):
if self._forms is None:
from .resources.forms.client import AsyncFormsClient # noqa: E402
self._forms = AsyncFormsClient(client_wrapper=self._client_wrapper)
return self._forms
@property
def products(self):
if self._products is None:
from .resources.products.client import AsyncProductsClient # noqa: E402
self._products = AsyncProductsClient(client_wrapper=self._client_wrapper)
return self._products
@property
def orders(self):
if self._orders is None:
from .resources.orders.client import AsyncOrdersClient # noqa: E402
self._orders = AsyncOrdersClient(client_wrapper=self._client_wrapper)
return self._orders
@property
def inventory(self):
if self._inventory is None:
from .resources.inventory.client import AsyncInventoryClient # noqa: E402
self._inventory = AsyncInventoryClient(client_wrapper=self._client_wrapper)
return self._inventory
@property
def ecommerce(self):
if self._ecommerce is None:
from .resources.ecommerce.client import AsyncEcommerceClient # noqa: E402
self._ecommerce = AsyncEcommerceClient(client_wrapper=self._client_wrapper)
return self._ecommerce
@property
def workspaces(self):
if self._workspaces is None:
from .resources.workspaces.client import AsyncWorkspacesClient # noqa: E402
self._workspaces = AsyncWorkspacesClient(client_wrapper=self._client_wrapper)
return self._workspaces