webflow 0.1.0b1__tar.gz

webflow-0.1.0b1/PKG-INFO

@@ -0,0 +1,193 @@
+Metadata-Version: 2.1
+Name: webflow
+Version: 0.1.0b1
+Summary: 
+Requires-Python: >=3.7,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: pydantic (>=1.9.2,<2.5.0)
+Description-Content-Type: text/markdown
+
+# Webflow Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
+
+The Webflow Python Library provides convenient access to the Webflow API from 
+applications written in Python. The library includes type definitions for all 
+request and response fields, and offers both synchronous and asynchronous clients powered by httpx.
+
+## Documentation
+
+API reference documentation is available [here](https://developers.webflow.com/reference/designer-api-reference).
+
+## Installation
+
+Add this dependency to your project's build file:
+
+```bash
+pip install webflow
+# or
+poetry add webflow
+```
+
+## Usage
+Simply import `Webflow` and start making calls to our API. 
+
+```python
+from webflow.client import Webflow
+
+client = Webflow(
+  client_id="YOUR_CLIENT_ID",
+  client_secret="YOUR_CLIENT_SECRET",
+  code="YOUR_AUTHORIZATION_CODE"
+)
+site = client.sites.get("site-id")
+```
+
+## Async Client
+The SDK also exports an async client so that you can make non-blocking
+calls to our API. 
+
+```python
+from webflow.client import AsyncWebflow
+
+client = AsyncWebflow(
+  client_id="YOUR_CLIENT_ID",
+  client_secret="YOUR_CLIENT_SECRET", 
+  code="YOUR_AUTHORIZATION_CODE"
+)
+
+async def main() -> None:
+    site = await client.sites.get("site-id")
+    print("Received site", site)
+
+asyncio.run(main())
+```
+
+## OAuth
+
+To implement OAuth, you'll need a registred Webflow App.
+
+### Step 1: Authorize URL 
+
+The first step in OAuth is to generate an authorization url. Use this URL 
+to fetch your authorization code. See the [docs](https://docs.developers.webflow.com/v1.0.0/docs/oauth#user-authorization)
+for more details. 
+
+```python
+from webflow.oauth import authorize_url
+from webflow import OauthScope
+
+url = webflow.authorize_url({
+  client_id = "[CLIENT ID]",
+  scope = OauthScope.ReadUsers, # or [OauthScope.ReadUsers, OauthScope.WriteUsers]
+  state = "1234567890", # optional
+  redirect_uri = "https://my.server.com/oauth/callback", # optional
+});
+
+print(url)
+```
+
+### Step 2: Instantiate the client
+Pass in your `client_id`, `client_secret`, `authorization_code` when instantiating 
+the client. Our SDK handles generating an access token and passing that to every endpoint. 
+
+```python
+from webflow.client import Webflow
+
+client = Webflow(
+  client_id="YOUR_CLIENT_ID",
+  client_secret="YOUR_CLIENT_SECRET",
+  code="YOUR_AUTHORIZATION_CODE",
+  redirect_uri = "https://my.server.com/oauth/callback", # optional
+)
+```
+
+If you want to generate an access token yourself, simply import the 
+`get_access_token` function. 
+
+```python
+from webflow.oauth import get_access_token
+
+access_token = get_access_token(
+  client_id="YOUR_CLIENT_ID", 
+  client_secret="YOUR_CLIENT_SECRET", 
+  code="YOUR_AUTHORIZATION_CODE"
+  )
+```
+
+## Webflow Module
+All of the models are nested within the Webflow module. Let Intellisense 
+guide you! 
+
+![Alt text](assets/module.png)
+
+## Exception Handling
+All errors thrown by the SDK will be sublcasses of [`ApiError`](./src/webflow/core/api_error.py).
+
+```python
+import webflow
+
+try:
+  client.sites.get(...)
+except webflow.core.ApiError as e: # Handle all errors
+  print(e.status_code)
+  print(e.body)
+except webflow.BadRequestError as e: # Handle specific error
+  print(e.status_code)
+  print(e.body)
+```
+
+## Advanced
+
+### Timeouts
+By default requests time out after 60 seconds. You can configure this with a 
+timeout option, which accepts a float.
+
+```python
+from webflow.client import Webflow
+
+client = Webflow(
+    # 20 seconds
+    timeout=20.0,
+)
+```
+
+### Custom HTTP client
+You can override the httpx client to customize it for your use case. Some common usecases 
+include support for proxies and transports.
+
+```python
+import httpx
+
+from webflow.client import Webflow
+
+client = Webflow(
+    http_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Beta Status
+
+This SDK is in beta, and there may be breaking changes between versions without a major 
+version update. Therefore, we recommend pinning the package version to a specific version. 
+This way, you can install the same version each time without breaking changes.
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically. 
+Additions made directly to this library would have to be moved over to our generation code, 
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+ a proof of concept, but know that we will not be able to merge it as-is. We suggest opening 
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!
+

webflow-0.1.0b1/README.md

@@ -0,0 +1,177 @@
+# Webflow Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
+
+The Webflow Python Library provides convenient access to the Webflow API from 
+applications written in Python. The library includes type definitions for all 
+request and response fields, and offers both synchronous and asynchronous clients powered by httpx.
+
+## Documentation
+
+API reference documentation is available [here](https://developers.webflow.com/reference/designer-api-reference).
+
+## Installation
+
+Add this dependency to your project's build file:
+
+```bash
+pip install webflow
+# or
+poetry add webflow
+```
+
+## Usage
+Simply import `Webflow` and start making calls to our API. 
+
+```python
+from webflow.client import Webflow
+
+client = Webflow(
+  client_id="YOUR_CLIENT_ID",
+  client_secret="YOUR_CLIENT_SECRET",
+  code="YOUR_AUTHORIZATION_CODE"
+)
+site = client.sites.get("site-id")
+```
+
+## Async Client
+The SDK also exports an async client so that you can make non-blocking
+calls to our API. 
+
+```python
+from webflow.client import AsyncWebflow
+
+client = AsyncWebflow(
+  client_id="YOUR_CLIENT_ID",
+  client_secret="YOUR_CLIENT_SECRET", 
+  code="YOUR_AUTHORIZATION_CODE"
+)
+
+async def main() -> None:
+    site = await client.sites.get("site-id")
+    print("Received site", site)
+
+asyncio.run(main())
+```
+
+## OAuth
+
+To implement OAuth, you'll need a registred Webflow App.
+
+### Step 1: Authorize URL 
+
+The first step in OAuth is to generate an authorization url. Use this URL 
+to fetch your authorization code. See the [docs](https://docs.developers.webflow.com/v1.0.0/docs/oauth#user-authorization)
+for more details. 
+
+```python
+from webflow.oauth import authorize_url
+from webflow import OauthScope
+
+url = webflow.authorize_url({
+  client_id = "[CLIENT ID]",
+  scope = OauthScope.ReadUsers, # or [OauthScope.ReadUsers, OauthScope.WriteUsers]
+  state = "1234567890", # optional
+  redirect_uri = "https://my.server.com/oauth/callback", # optional
+});
+
+print(url)
+```
+
+### Step 2: Instantiate the client
+Pass in your `client_id`, `client_secret`, `authorization_code` when instantiating 
+the client. Our SDK handles generating an access token and passing that to every endpoint. 
+
+```python
+from webflow.client import Webflow
+
+client = Webflow(
+  client_id="YOUR_CLIENT_ID",
+  client_secret="YOUR_CLIENT_SECRET",
+  code="YOUR_AUTHORIZATION_CODE",
+  redirect_uri = "https://my.server.com/oauth/callback", # optional
+)
+```
+
+If you want to generate an access token yourself, simply import the 
+`get_access_token` function. 
+
+```python
+from webflow.oauth import get_access_token
+
+access_token = get_access_token(
+  client_id="YOUR_CLIENT_ID", 
+  client_secret="YOUR_CLIENT_SECRET", 
+  code="YOUR_AUTHORIZATION_CODE"
+  )
+```
+
+## Webflow Module
+All of the models are nested within the Webflow module. Let Intellisense 
+guide you! 
+
+![Alt text](assets/module.png)
+
+## Exception Handling
+All errors thrown by the SDK will be sublcasses of [`ApiError`](./src/webflow/core/api_error.py).
+
+```python
+import webflow
+
+try:
+  client.sites.get(...)
+except webflow.core.ApiError as e: # Handle all errors
+  print(e.status_code)
+  print(e.body)
+except webflow.BadRequestError as e: # Handle specific error
+  print(e.status_code)
+  print(e.body)
+```
+
+## Advanced
+
+### Timeouts
+By default requests time out after 60 seconds. You can configure this with a 
+timeout option, which accepts a float.
+
+```python
+from webflow.client import Webflow
+
+client = Webflow(
+    # 20 seconds
+    timeout=20.0,
+)
+```
+
+### Custom HTTP client
+You can override the httpx client to customize it for your use case. Some common usecases 
+include support for proxies and transports.
+
+```python
+import httpx
+
+from webflow.client import Webflow
+
+client = Webflow(
+    http_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Beta Status
+
+This SDK is in beta, and there may be breaking changes between versions without a major 
+version update. Therefore, we recommend pinning the package version to a specific version. 
+This way, you can install the same version each time without breaking changes.
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically. 
+Additions made directly to this library would have to be moved over to our generation code, 
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+ a proof of concept, but know that we will not be able to merge it as-is. We suggest opening 
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

webflow-0.1.0b1/pyproject.toml

@@ -0,0 +1,22 @@
+[tool.poetry]
+name = "webflow"
+version = "0.1.0b1"
+description = ""
+readme = "README.md"
+authors = []
+packages = [
+    { include = "webflow", from = "src"}
+]
+
+[tool.poetry.dependencies]
+python = "^3.7"
+httpx = ">=0.21.2"
+pydantic = ">= 1.9.2, < 2.5.0"
+
+[tool.poetry.dev-dependencies]
+mypy = "0.971"
+pytest = "^7.4.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

webflow-0.1.0b1/src/webflow/__init__.py

@@ -0,0 +1,313 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .types import (
+    AccessGroup,
+    AccessGroupList,
+    Application,
+    Asset,
+    AssetFolder,
+    AssetFolderList,
+    AssetUpload,
+    AssetUploadUploadDetails,
+    AssetVariant,
+    Assets,
+    Authorization,
+    AuthorizationAuthorization,
+    AuthorizationAuthorizationAuthorizedTo,
+    AuthorizedUser,
+    Collection,
+    CollectionItem,
+    CollectionItemFieldData,
+    CollectionItemList,
+    CollectionItemListPagination,
+    CollectionItemRemoved,
+    CollectionList,
+    CollectionListArrayItem,
+    CustomCodeBlock,
+    CustomCodeBlockType,
+    CustomCodeResponse,
+    Domain,
+    DuplicateUserEmail,
+    EcommerceSettings,
+    Error,
+    ErrorDetailsItem,
+    Field,
+    FieldType,
+    Fields,
+    Form,
+    FormField,
+    FormFieldValue,
+    FormFieldValueType,
+    FormList,
+    FormResponseSettings,
+    FormSubmission,
+    FormSubmissionList,
+    FormSubmissionTrigger,
+    FormSubmissionTriggerPayload,
+    InvalidDomain,
+    InventoryItem,
+    InventoryItemInventoryType,
+    ListCustomCodeBlocks,
+    MissingScopes,
+    NoDomains,
+    OauthScope,
+    Order,
+    OrderAddress,
+    OrderAddressJapanType,
+    OrderAddressType,
+    OrderCustomerInfo,
+    OrderDisputeLastStatus,
+    OrderDownloadFilesItem,
+    OrderList,
+    OrderMetadata,
+    OrderPrice,
+    OrderPurchasedItem,
+    OrderPurchasedItemVariantImage,
+    OrderPurchasedItemVariantImageFile,
+    OrderPurchasedItemVariantImageFileVariantsItem,
+    OrderStatus,
+    OrderTotals,
+    OrderTotalsExtrasItem,
+    OrderTotalsExtrasItemType,
+    Page,
+    PageCreatedWebhook,
+    PageDeletedWebhook,
+    PageList,
+    PageMetadataUpdatedWebhook,
+    PageOpenGraph,
+    PageSeo,
+    PageSeoGraphData,
+    PageSeoGraphDataOpenGraph,
+    PageSeoGraphDataSeo,
+    Pagination,
+    PaypalDetails,
+    Product,
+    ProductAndSkUs,
+    ProductAndSkUsList,
+    ProductFieldData,
+    PublishStatus,
+    PublishedItems,
+    PublishedSite,
+    RegisteredScriptList,
+    RemovedItems,
+    ScriptApply,
+    ScriptApplyList,
+    ScriptApplyLocation,
+    Site,
+    SiteActivityLogItem,
+    SiteActivityLogItemResourceOperation,
+    SiteActivityLogResponse,
+    SitePublish,
+    SitePublishPayload,
+    Sites,
+    Sku,
+    SkuFieldData,
+    SkuFieldDataPrice,
+    SkuPropertyList,
+    SkuPropertyListEnumItem,
+    SkuValueList,
+    StripeCard,
+    StripeCardBrand,
+    StripeCardExpires,
+    StripeDetails,
+    TriggerType,
+    User,
+    UserAccessGroupsItem,
+    UserAccessGroupsItemType,
+    UserData,
+    UserDataData,
+    UserLimitReached,
+    UserList,
+    UserStatus,
+    UserWebhookPayload,
+    UserWebhookPayloadTriggerType,
+    UsersNotEnabled,
+    Webhook,
+    WebhookList,
+)
+from .errors import (
+    BadRequestError,
+    ConflictError,
+    ForbiddenError,
+    InternalServerError,
+    NotFoundError,
+    TooManyRequestsError,
+    UnauthorizedError,
+)
+from .resources import (
+    AccessGroupsListRequestSort,
+    InventoryUpdateRequestInventoryType,
+    OrdersListRequestStatus,
+    OrdersRefundRequestReason,
+    ProductsCreateSkuResponse,
+    UsersListRequestSort,
+    access_groups,
+    assets,
+    collections,
+    ecommerce,
+    forms,
+    inventory,
+    orders,
+    pages,
+    products,
+    scripts,
+    sites,
+    token,
+    users,
+    webhooks,
+)
+from .environment import WebflowEnvironment
+
+__all__ = [
+    "AccessGroup",
+    "AccessGroupList",
+    "AccessGroupsListRequestSort",
+    "Application",
+    "Asset",
+    "AssetFolder",
+    "AssetFolderList",
+    "AssetUpload",
+    "AssetUploadUploadDetails",
+    "AssetVariant",
+    "Assets",
+    "Authorization",
+    "AuthorizationAuthorization",
+    "AuthorizationAuthorizationAuthorizedTo",
+    "AuthorizedUser",
+    "BadRequestError",
+    "Collection",
+    "CollectionItem",
+    "CollectionItemFieldData",
+    "CollectionItemList",
+    "CollectionItemListPagination",
+    "CollectionItemRemoved",
+    "CollectionList",
+    "CollectionListArrayItem",
+    "ConflictError",
+    "CustomCodeBlock",
+    "CustomCodeBlockType",
+    "CustomCodeResponse",
+    "Domain",
+    "DuplicateUserEmail",
+    "EcommerceSettings",
+    "Error",
+    "ErrorDetailsItem",
+    "Field",
+    "FieldType",
+    "Fields",
+    "ForbiddenError",
+    "Form",
+    "FormField",
+    "FormFieldValue",
+    "FormFieldValueType",
+    "FormList",
+    "FormResponseSettings",
+    "FormSubmission",
+    "FormSubmissionList",
+    "FormSubmissionTrigger",
+    "FormSubmissionTriggerPayload",
+    "InternalServerError",
+    "InvalidDomain",
+    "InventoryItem",
+    "InventoryItemInventoryType",
+    "InventoryUpdateRequestInventoryType",
+    "ListCustomCodeBlocks",
+    "MissingScopes",
+    "NoDomains",
+    "NotFoundError",
+    "OauthScope",
+    "Order",
+    "OrderAddress",
+    "OrderAddressJapanType",
+    "OrderAddressType",
+    "OrderCustomerInfo",
+    "OrderDisputeLastStatus",
+    "OrderDownloadFilesItem",
+    "OrderList",
+    "OrderMetadata",
+    "OrderPrice",
+    "OrderPurchasedItem",
+    "OrderPurchasedItemVariantImage",
+    "OrderPurchasedItemVariantImageFile",
+    "OrderPurchasedItemVariantImageFileVariantsItem",
+    "OrderStatus",
+    "OrderTotals",
+    "OrderTotalsExtrasItem",
+    "OrderTotalsExtrasItemType",
+    "OrdersListRequestStatus",
+    "OrdersRefundRequestReason",
+    "Page",
+    "PageCreatedWebhook",
+    "PageDeletedWebhook",
+    "PageList",
+    "PageMetadataUpdatedWebhook",
+    "PageOpenGraph",
+    "PageSeo",
+    "PageSeoGraphData",
+    "PageSeoGraphDataOpenGraph",
+    "PageSeoGraphDataSeo",
+    "Pagination",
+    "PaypalDetails",
+    "Product",
+    "ProductAndSkUs",
+    "ProductAndSkUsList",
+    "ProductFieldData",
+    "ProductsCreateSkuResponse",
+    "PublishStatus",
+    "PublishedItems",
+    "PublishedSite",
+    "RegisteredScriptList",
+    "RemovedItems",
+    "ScriptApply",
+    "ScriptApplyList",
+    "ScriptApplyLocation",
+    "Site",
+    "SiteActivityLogItem",
+    "SiteActivityLogItemResourceOperation",
+    "SiteActivityLogResponse",
+    "SitePublish",
+    "SitePublishPayload",
+    "Sites",
+    "Sku",
+    "SkuFieldData",
+    "SkuFieldDataPrice",
+    "SkuPropertyList",
+    "SkuPropertyListEnumItem",
+    "SkuValueList",
+    "StripeCard",
+    "StripeCardBrand",
+    "StripeCardExpires",
+    "StripeDetails",
+    "TooManyRequestsError",
+    "TriggerType",
+    "UnauthorizedError",
+    "User",
+    "UserAccessGroupsItem",
+    "UserAccessGroupsItemType",
+    "UserData",
+    "UserDataData",
+    "UserLimitReached",
+    "UserList",
+    "UserStatus",
+    "UserWebhookPayload",
+    "UserWebhookPayloadTriggerType",
+    "UsersListRequestSort",
+    "UsersNotEnabled",
+    "WebflowEnvironment",
+    "Webhook",
+    "WebhookList",
+    "access_groups",
+    "assets",
+    "collections",
+    "ecommerce",
+    "forms",
+    "inventory",
+    "orders",
+    "pages",
+    "products",
+    "scripts",
+    "sites",
+    "token",
+    "users",
+    "webhooks",
+]