diff --git a/.fern/metadata.json b/.fern/metadata.json new file mode 100644 index 0000000..44a2882 --- /dev/null +++ b/.fern/metadata.json @@ -0,0 +1,14 @@ +{ + "cliVersion": "4.22.0", + "generatorName": "fernapi/fern-python-sdk", + "generatorVersion": "4.63.4", + "generatorConfig": { + "client_class_name": "Webflow", + "improved_imports": false, + "pydantic_config": { + "use_str_enums": false + } + }, + "originGitCommit": "3ad89f5558f1774e8535f034a87bfe8c2fdfcd50", + "sdkVersion": "2.0.0" +} \ No newline at end of file diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index d396980..bab604b 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -1,16 +1,20 @@ name: ci - on: [push] + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: false + jobs: compile: - runs-on: ubuntu-24.04 + runs-on: ubuntu-latest steps: - name: Checkout repo - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Set up python uses: actions/setup-python@v4 with: - python-version: 3.8 + python-version: 3.9 - name: Bootstrap poetry run: | curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1 @@ -19,36 +23,34 @@ jobs: - name: Compile run: poetry run mypy . test: - runs-on: ubuntu-24.04 + runs-on: ubuntu-latest steps: - name: Checkout repo - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Set up python uses: actions/setup-python@v4 with: - python-version: 3.8 + python-version: 3.9 - name: Bootstrap poetry run: | curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1 - name: Install dependencies run: poetry install - - name: Install Fern - run: npm install -g fern-api - name: Test - run: fern test --command "poetry run pytest -rP ./tests/custom/" + run: poetry run pytest -rP -n auto . publish: needs: [compile, test] if: github.event_name == 'push' && contains(github.ref, 'refs/tags/') - runs-on: ubuntu-24.04 + runs-on: ubuntu-latest steps: - name: Checkout repo - uses: actions/checkout@v3 + uses: actions/checkout@v4 - name: Set up python uses: actions/setup-python@v4 with: - python-version: 3.8 + python-version: 3.9 - name: Bootstrap poetry run: | curl -sSL https://install.python-poetry.org | python - -y --version 1.5.1 diff --git a/.gitignore b/.gitignore index 0da665f..d2e4ca8 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,5 @@ -dist/ .mypy_cache/ +.ruff_cache/ __pycache__/ +dist/ poetry.toml -.ruff_cache/ diff --git a/.mock/definition/__package__.yml b/.mock/definition/__package__.yml deleted file mode 100644 index db84636..0000000 --- a/.mock/definition/__package__.yml +++ /dev/null @@ -1,2894 +0,0 @@ -errors: - UnauthorizedError: - status-code: 401 - type: Error - docs: >- - Provided access token is invalid or does not have access to requested - resource - examples: - - value: - code: not_authorized - message: Request not authorized - ForbiddenError: - status-code: 403 - type: unknown - docs: Provided access token is valid, but is missing the required scopes. - examples: - - value: - code: missing_scopes - message: >- - OAuthForbidden: You are missing the following scopes - - components:write - - value: - key: value - - value: - code: forbidden - message: User is not authorized to perform this action - BadRequestError: - status-code: 400 - type: unknown - docs: Request body was incorrectly formatted. - examples: - - value: - code: bad_request - message: 'Bad Request: Request is malformed' - - value: - key: value - - value: - code: validation_error - message: 'Validation Error: Provided ID is invalid' - NotFoundError: - status-code: 404 - type: Error - docs: Requested resource not found - examples: - - value: - code: resource_not_found - message: 'Requested resource not found: The site cannot be found' - TooManyRequestsError: - status-code: 429 - type: Error - docs: >- - The rate limit of the provided access_token has been reached. Please have - your application respect the X-RateLimit-Remaining header we include on - API responses. - examples: - - value: - code: too_many_requests - message: Too many requests - InternalServerError: - status-code: 500 - type: Error - docs: We had a problem with our server. Try again later. - examples: - - value: - code: internal_error - message: An Internal Error occurred - ConflictError: - status-code: 409 - type: unknown - docs: Site is published to multiple domains at different times - examples: - - value: - message: '''Site is published to multiple domains at different times' - - value: - code: custom_code_max_registered_scripts - message: The maximum number of registered scripts has been reached. - - value: - code: forms_require_republish - message: To access this feature, the site needs to be republished. - - value: - key: value - - value: - code: ecommerce_not_enabled - message: Ecommerce is not yet initialized -types: - ForbiddenErrorBody: - discriminated: false - union: - - InvalidScopes - - UsersNotEnabled - source: - openapi: ../../../openapi/referenced-specs/v2.yml - BadRequestErrorBody: - discriminated: false - union: - - InvalidDomain - - NoDomains - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ConflictErrorBody: - discriminated: false - union: - - DuplicateUserEmail - - UserLimitReached - source: - openapi: ../../../openapi/referenced-specs/v2.yml - AuthorizedUser: - properties: - id: - type: optional - docs: The unique ID of the user - email: - type: optional - docs: The user's email address - validation: - format: email - firstName: - type: optional - docs: The user's first name - lastName: - type: optional - docs: The user's last name - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ErrorCode: - enum: - - bad_request - - collection_not_found - - conflict - - duplicate_collection - - duplicate_user_email - - ecommerce_not_enabled - - forbidden - - forms_require_republish - - incompatible_webhook_filter - - internal_error - - invalid_auth_version - - invalid_credentials - - invalid_domain - - invalid_user_email - - item_not_found - - missing_scopes - - no_domains - - not_authorized - - not_enterprise_plan_site - - not_enterprise_plan_workspace - - order_not_found - - resource_not_found - - too_many_requests - - unsupported_version - - unsupported_webhook_trigger_type - - user_limit_reached - - user_not_found - - users_not_enabled - - validation_error - docs: Error code - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - Error: - properties: - code: - type: optional - docs: Error code - message: - type: optional - docs: Error message - externalReference: - type: optional - docs: Link to more information - details: - type: optional> - docs: Array of errors - source: - openapi: ../../../openapi/referenced-specs/v2.yml - Application: unknown - AuthorizationAuthorizationAuthorizedTo: - properties: - siteIds: - type: optional> - docs: Array of Sites this app is authorized to - workspaceIds: - type: optional> - docs: Array of Workspaces this app is authorized to - userIds: - type: optional> - docs: Array of Users this app is authorized to - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - AuthorizationAuthorization: - docs: The Authorization object - properties: - id: - type: optional - docs: The unique ID of the Authorization instance - createdOn: - type: optional - docs: The date the Authorization was created - lastUsed: - type: optional - docs: The date the Authorization was last used - grantType: - type: optional - docs: The grant type of the Authorization - rateLimit: - type: optional - docs: The default rate limit for the Authorization (requests/min) - scope: - type: optional - docs: Comma separted list of OAuth scopes corresponding to the Authorization - authorizedTo: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - Authorization: - properties: - authorization: - type: optional - docs: The Authorization object - application: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - Domain: - properties: - id: - type: string - docs: Unique identifier for the Domain - url: - type: optional - docs: The registered Domain name - lastPublished: - type: optional - docs: The date the custom domain was last published to - source: - openapi: ../../../openapi/referenced-specs/v2.yml - Locale: - properties: - id: - type: optional - docs: The unique identifier for the locale. - cmsLocaleId: - type: optional - docs: A CMS-specific identifier for the locale. - enabled: - type: optional - docs: Indicates if the locale is enabled. - displayName: - type: optional - docs: The display name of the locale, typically in English. - displayImageId: - type: optional - docs: An optional ID for an image associated with the locale, nullable. - redirect: - type: optional - docs: Determines if requests should redirect to the locale's subdirectory. - subdirectory: - type: optional - docs: The subdirectory path for the locale, used in URLs. - tag: - type: optional - docs: >- - A tag or code representing the locale, often following a standard - format like 'en-US'. - source: - openapi: ../../../openapi/referenced-specs/v2.yml - Locales: - properties: - primary: - type: optional - docs: The primary locale for the site or application. - secondary: - type: optional> - docs: A list of secondary locales available for the site or application. - source: - openapi: ../../../openapi/referenced-specs/v2.yml - SiteDataCollectionType: - enum: - - always - - optOut - - disabled - docs: The type of data collection enabled for the site. - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - Site: - properties: - id: - type: string - docs: Unique identifier for the Site - workspaceId: - type: optional - docs: Unique identifier for the Workspace - createdOn: - type: optional - docs: Date the Site was created - displayName: - type: optional - docs: Name given to Site - shortName: - type: optional - docs: Slugified version of name - lastPublished: - type: optional - docs: Date the Site was last published - lastUpdated: - type: optional - docs: Date the Site was last updated - previewUrl: - type: optional - docs: URL of a generated image for the given Site - validation: - format: uri - timeZone: - type: optional - docs: Site timezone set under Site Settings - parentFolderId: - type: optional - docs: The ID of the parent folder the Site exists in - customDomains: optional> - locales: optional - dataCollectionEnabled: - type: optional - docs: Indicates if data collection is enabled for the site. - dataCollectionType: - type: optional - docs: The type of data collection enabled for the site. - source: - openapi: ../../../openapi/referenced-specs/v2.yml - InvalidScopes: unknown - NotEnterprisePlanWorkspace: unknown - Sites: - properties: - sites: optional> - source: - openapi: ../../../openapi/referenced-specs/v2.yml - NotEnterprisePlanSite: unknown - Domains: - properties: - customDomains: optional> - source: - openapi: ../../../openapi/referenced-specs/v2.yml - InvalidDomain: unknown - NoDomains: unknown - Redirect: - docs: A single redirection rule, specifying a source URL and a destination URL. - properties: - id: - type: optional - docs: The ID of the specific redirect rule - fromUrl: - type: optional - docs: The source URL path that will be redirected. - toUrl: - type: optional - docs: The target URL path where the user or client will be redirected. - source: - openapi: ../../../openapi/referenced-specs/v2.yml - Pagination: - docs: Pagination object - properties: - limit: - type: optional - docs: The limit used for pagination - offset: - type: optional - docs: The offset used for pagination - total: - type: optional - docs: The total number of records - source: - openapi: ../../../openapi/referenced-specs/v2.yml - Redirects: - docs: Site redirects response - properties: - redirects: - type: optional> - docs: List of redirects for a given site - pagination: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - SitePlanId: - enum: - - value: hosting-basic-v3 - name: HostingBasicV3 - - value: hosting-cms-v3 - name: HostingCmsV3 - - value: hosting-business-v3 - name: HostingBusinessV3 - - value: hosting-ecommerce-standard-v2 - name: HostingEcommerceStandardV2 - - value: hosting-ecommerce-plus-v2 - name: HostingEcommercePlusV2 - - value: hosting-ecommerce-advanced-v2 - name: HostingEcommerceAdvancedV2 - - value: hosting-basic-v4 - name: HostingBasicV4 - - value: hosting-cms-v4 - name: HostingCmsV4 - - value: hosting-business-v4 - name: HostingBusinessV4 - - value: hosting-ecommerce-standard-v3 - name: HostingEcommerceStandardV3 - - value: hosting-ecommerce-plus-v3 - name: HostingEcommercePlusV3 - - value: hosting-ecommerce-advanced-v3 - name: HostingEcommerceAdvancedV3 - docs: ID of the hosting plan. - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - SitePlanName: - enum: - - value: Basic Hosting - name: BasicHosting - - value: CMS Hosting - name: CmsHosting - - value: Business Hosting - name: BusinessHosting - - value: ECommerce Standard Hosting - name: ECommerceStandardHosting - - value: ECommerce Plus Hosting - name: ECommercePlusHosting - - value: ECommerce Advanced Hosting - name: ECommerceAdvancedHosting - docs: Name of the hosting plan. - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - SitePlan: - properties: - id: - type: optional - docs: ID of the hosting plan. - name: - type: optional - docs: Name of the hosting plan. - pricingInfo: - type: optional - docs: URL for more information about Webflow hosting plan pricing. - source: - openapi: ../../../openapi/referenced-specs/v2.yml - SiteActivityLogItemEvent: - enum: - - styles_modified - - site_published - - ix2_modified_on_page - - page_dom_modified - - cms_item - - backup_created - - page_custom_code_modified - - symbols_modified - - variable_modified - - variables_modified - - cms_collection - - page_settings_modified - - page_settings_custom_code_modified - - ix2_modified_on_component - - ix2_modified_on_class - - site_custom_code_modified - - page_duplicated - - secondary_locale_page_content_modified - - page_renamed - - page_created - - page_deleted - - site_unpublished - - backup_restored - - locale_added - - branch_created - - locale_display_name_updated - - locale_subdirectory_updated - - branch_merged - - locale_tag_updated - - branch_deleted - - locale_enabled - - locale_removed - - locale_disabled - - library_shared - - library_unshared - - library_installed - - library_uninstalled - - library_update_shared - - library_update_accepted - - branch_review_created - - branch_review_approved - - branch_review_canceled - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - SiteActivityLogItemResourceOperation: - enum: - - CREATED - - MODIFIED - - PUBLISHED - - UNPUBLISHED - - DELETED - - GROUP_REORDERED - - GROUP_CREATED - - GROUP_DELETED - - REORDERED - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - SiteActivityLogItemUser: - properties: - id: optional - displayName: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - SiteActivityLogItem: - properties: - id: optional - createdOn: optional - lastUpdated: optional - event: optional - resourceOperation: optional - user: optional - resourceId: optional - resourceName: optional - newValue: optional - previousValue: optional - payload: optional> - source: - openapi: ../../../openapi/referenced-specs/v2.yml - SiteActivityLogResponse: - properties: - items: optional> - pagination: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - CollectionListArrayItem: - docs: A collection object - properties: - id: - type: string - docs: Unique identifier for a Collection - displayName: - type: optional - docs: Name given to the Collection - singularName: - type: optional - docs: >- - The name of one Item in Collection (e.g. ”Blog Post” if the Collection - is called “Blog Posts”) - slug: - type: optional - docs: Slug of Collection in Site URL structure - createdOn: - type: optional - docs: The date the collection was created - lastUpdated: - type: optional - docs: The date the collection was last updated - source: - openapi: ../../../openapi/referenced-specs/v2.yml - CollectionList: - properties: - collections: - type: optional> - docs: An array of Collections - source: - openapi: ../../../openapi/referenced-specs/v2.yml - FieldType: - enum: - - Color - - DateTime - - Email - - ExtFileRef - - Image - - Link - - MultiImage - - Number - - Phone - - PlainText - - RichText - - Switch - - Video - docs: Choose these appropriate field type for your collection data - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - Field: - docs: The details of a field in a collection - properties: - id: - type: string - docs: Unique identifier for a Field - isRequired: - type: boolean - docs: define whether a field is required in a collection - isEditable: - type: optional - docs: Define whether the field is editable - type: - type: FieldType - docs: Choose these appropriate field type for your collection data - slug: - type: optional - docs: >- - Slug of Field in Site URL structure. Slugs should be all lowercase - with no spaces. Any spaces will be converted to "-." - displayName: - type: string - docs: The name of a field - helpText: - type: optional - docs: Additional text to help anyone filling out this field - source: - openapi: ../../../openapi/referenced-specs/v2.yml - Collection: - docs: A collection object - properties: - id: - type: string - docs: Unique identifier for a Collection - displayName: - type: optional - docs: Name given to the Collection - singularName: - type: optional - docs: >- - The name of one Item in Collection (e.g. ”Blog Post” if the Collection - is called “Blog Posts”) - slug: - type: optional - docs: Slug of Collection in Site URL structure - createdOn: - type: optional - docs: The date the collection was created - lastUpdated: - type: optional - docs: The date the collection was last updated - fields: - docs: The list of fields in the Collection - type: list - source: - openapi: ../../../openapi/referenced-specs/v2.yml - CollectionItemFieldData: - properties: - name: - type: string - docs: Name of the Item - slug: - type: string - docs: >- - URL structure of the Item in your site. Note: Updates to an item slug - will break all links referencing the old slug. - extra-properties: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - CollectionItem: - docs: > - A Collection Item represents a single entry in your collection. Each item - includes: - - - - **System metadata** - Automatically managed fields like IDs and - timestamp
- - - **Status flags** - Controls for managing content state: `isDraft`, - `isArchived `
- - - **Content fields** - Stored in `fieldData`. Each item needs a `name` and - `slug`, and may include additional fields matching your collection's - schema definition. - properties: - id: - type: optional - docs: Unique identifier for the Item - cmsLocaleId: - type: optional - docs: Identifier for the locale of the CMS item - lastPublished: - type: optional - docs: The date the item was last published - lastUpdated: - type: optional - docs: The date the item was last updated - createdOn: - type: optional - docs: The date the item was created - isArchived: - type: optional - docs: Boolean determining if the Item is set to archived - default: false - isDraft: - type: optional - docs: Boolean determining if the Item is set to draft - default: false - fieldData: CollectionItemFieldData - source: - openapi: ../../../openapi/referenced-specs/v2.yml - CollectionItemListPagination: - properties: - limit: - type: optional - docs: The limit specified in the request - default: 100 - offset: - type: optional - docs: The offset specified for pagination - default: 0 - total: - type: optional - docs: Total number of items in the collection - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - CollectionItemList: - docs: Results from collection items list - properties: - items: - type: optional> - docs: List of Items within the collection - pagination: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - CollectionItemPostSingleFieldData: - properties: - name: - type: string - docs: Name of the Item - slug: - type: string - docs: >- - URL structure of the Item in your site. Note: Updates to an item slug - will break all links referencing the old slug. - extra-properties: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - CollectionItemPostSingle: - docs: > - A Collection Item represents a single entry in your collection. Each item - includes: - - - - **System metadata** - Automatically managed fields like IDs and - timestamp
- - - **Status flags** - Controls for managing content state: `isDraft`, - `isArchived `
- - - **Content fields** - Stored in `fieldData`. Each item needs a `name` and - `slug`, and may include additional fields matching your collection's - schema definition. - properties: - id: - type: optional - docs: Unique identifier for the Item - cmsLocaleId: - type: optional - docs: Identifier for the locale of the CMS item - lastPublished: - type: optional - docs: The date the item was last published - lastUpdated: - type: optional - docs: The date the item was last updated - createdOn: - type: optional - docs: The date the item was created - isArchived: - type: optional - docs: Boolean determining if the Item is in an archived state. - default: false - isDraft: - type: optional - docs: Boolean determining if the Item is in a draft state. - default: false - fieldData: CollectionItemPostSingleFieldData - source: - openapi: ../../../openapi/referenced-specs/v2.yml - CollectionItemWithIdInputFieldData: - properties: - name: - type: optional - docs: Name of the Item - slug: - type: optional - docs: >- - URL structure of the Item in your site. Note: Updates to an item slug - will break all links referencing the old slug. - extra-properties: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - CollectionItemWithIdInput: - docs: > - The fields that define the schema for a given Item are based on the - Collection that Item belongs to. Beyond the user defined fields, there are - a handful of additional fields that are automatically created for all - items - properties: - id: - type: string - docs: Unique identifier for the Item - cmsLocaleId: - type: optional - docs: Identifier for the locale of the CMS item - lastPublished: - type: optional - docs: The date the item was last published - lastUpdated: - type: optional - docs: The date the item was last updated - createdOn: - type: optional - docs: The date the item was created - isArchived: - type: optional - docs: Boolean determining if the Item is set to archived - isDraft: - type: optional - docs: Boolean determining if the Item is set to draft - fieldData: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - CollectionItemListNoPagination: - docs: Results from collection items list - properties: - items: - type: optional> - docs: List of Items within the collection - source: - openapi: ../../../openapi/referenced-specs/v2.yml - BulkCollectionItemFieldData: - properties: - name: - type: optional - docs: Name of the Item - slug: - type: optional - docs: >- - URL structure of the Item in your site. Note: Updates to an item slug - will break all links referencing the old slug. - extra-properties: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - BulkCollectionItem: - docs: > - The fields that define the schema for a given Item are based on the - Collection that Item belongs to. Beyond the user defined fields, there are - a handful of additional fields that are automatically created for all - items - properties: - id: - type: string - docs: Unique identifier for the Item - cmsLocaleIds: - type: optional> - docs: Array of identifiers for the locales where the item will be created - lastPublished: - type: optional - docs: The date the item was last published - lastUpdated: - type: optional - docs: The date the item was last updated - createdOn: - type: optional - docs: The date the item was created - isArchived: - type: optional - docs: Boolean determining if the Item is set to archived - default: false - isDraft: - type: optional - docs: Boolean determining if the Item is set to draft - default: false - fieldData: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - CollectionItemPatchSingleFieldData: - properties: - name: - type: optional - docs: Name of the Item - slug: - type: optional - docs: >- - URL structure of the Item in your site. Note: Updates to an item slug - will break all links referencing the old slug. - extra-properties: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - CollectionItemPatchSingle: - docs: > - The fields that define the schema for a given Item are based on the - Collection that Item belongs to. Beyond the user defined fields, there are - a handful of additional fields that are automatically created for all - items - properties: - id: - type: optional - docs: Unique identifier for the Item - cmsLocaleId: - type: optional - docs: Identifier for the locale of the CMS item - lastPublished: - type: optional - docs: The date the item was last published - lastUpdated: - type: optional - docs: The date the item was last updated - createdOn: - type: optional - docs: The date the item was created - isArchived: - type: optional - docs: Boolean determining if the Item is set to archived - isDraft: - type: optional - docs: Boolean determining if the Item is set to draft - fieldData: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - PageSeo: - docs: SEO-related fields for the Page - properties: - title: - type: optional - docs: The Page title shown in search engine results - description: - type: optional - docs: The Page description shown in search engine results - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - PageOpenGraph: - docs: Open Graph fields for the Page - properties: - title: - type: optional - docs: The title supplied to Open Graph annotations - titleCopied: - type: optional - docs: Indicates the Open Graph title was copied from the SEO title - default: true - description: - type: optional - docs: The description supplied to Open Graph annotations - descriptionCopied: - type: optional - docs: >- - Indicates the Open Graph description was copied from the SEO - description - default: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - Page: - docs: The Page object - properties: - id: - type: string - docs: Unique identifier for the Page - siteId: - type: optional - docs: Unique identifier for the Site - title: - type: optional - docs: Title of the Page - slug: - type: optional - docs: slug of the Page (derived from title) - parentId: - type: optional - docs: Identifier of the parent folder - collectionId: - type: optional - docs: >- - Unique identifier for a linked Collection, value will be null if the - Page is not part of a Collection. - createdOn: - type: optional - docs: The date the Page was created - lastUpdated: - type: optional - docs: The date the Page was most recently updated - archived: - type: optional - docs: Whether the Page has been archived - default: false - draft: - type: optional - docs: Whether the Page is a draft - default: false - canBranch: - type: optional - docs: >- - Indicates whether the Page supports [Page - Branching](https://university.webflow.com/lesson/page-branching) - default: false - isBranch: - type: optional - docs: >- - Indicates whether the Page is a Branch of another Page [Page - Branching](https://university.webflow.com/lesson/page-branching) - default: false - isMembersOnly: - type: optional - docs: >- - Indicates whether the Page is restricted by [Memberships - Controls](https://university.webflow.com/lesson/webflow-memberships-overview#how-to-manage-page-restrictions) - default: false - seo: - type: optional - docs: SEO-related fields for the Page - openGraph: - type: optional - docs: Open Graph fields for the Page - localeId: - type: optional - docs: Unique ID of the page locale - publishedPath: - type: optional - docs: Relative path of the published page URL - source: - openapi: ../../../openapi/referenced-specs/v2.yml - PageList: - docs: The Page object - properties: - pages: optional> - pagination: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - TextNodeText: - properties: - html: - type: optional - docs: The HTML content of the text node. - text: - type: optional - docs: The raw text content of the text node. - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - TextNode: - docs: > - Represents text content within the DOM. It contains both the raw text and - its HTML representation. Additional attributes can be associated with the - text for styling or other purposes. - properties: - id: - type: optional - docs: Node UUID - text: optional - attributes: - type: optional> - docs: The custom attributes of the node - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ImageNodeImage: - properties: - alt: optional - assetId: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - ImageNode: - docs: > - Represents an image within the DOM. It contains details about the image, - such as its alternative text (alt) for accessibility and an asset - identifier for fetching the actual image resource. Additional attributes - can be associated with the image for styling or other purposes. - properties: - id: - type: optional - docs: Node UUID - image: optional - attributes: - type: optional> - docs: The custom attributes of the node - source: - openapi: ../../../openapi/referenced-specs/v2.yml - Text: - properties: - html: - type: optional - docs: The HTML content of the text node. - text: - type: optional - docs: The raw text content of the text node. - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ComponentPropertyType: - enum: - - value: Plain Text - name: PlainText - - value: Rich Text - name: RichText - - value: Alt Text - name: AltText - docs: The type of the property. - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ComponentProperty: - docs: > - Represents a property of a component instance in the DOM. A property - contains a list of both the raw text and the HTML representation, allowing - for flexibility in rendering and processing. Additional attributes can be - associated with the text for styling or other purposes. - properties: - propertyId: - type: optional - docs: The ID of the property. - type: - type: optional - docs: The type of the property. - label: - type: optional - docs: The label of the property in the UI. - text: - type: optional - docs: >- - Represents text content within the DOM. It contains both the raw text - and its HTML representation. - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ComponentNode: - docs: > - Represents a component instance within the DOM. It contains details about - the component instance, such as its type and properties. - properties: - id: - type: optional - docs: Node UUID - componentId: - type: optional - docs: Component ID - propertyOverrides: - type: optional> - docs: List of component properties with overrides for a component instance. - source: - openapi: ../../../openapi/referenced-specs/v2.yml - Node: - discriminant: type - base-properties: {} - docs: > - A generic representation of a content element within the Document Object - Model (DOM). Each node has a unique identifier and a specific type that - determines its content structure and attributes. - union: - text: TextNode - image: ImageNode - component-instance: ComponentNode - source: - openapi: ../../../openapi/referenced-specs/v2.yml - Dom: - docs: > - The DOM (Document Object Model) schema represents the content structure of - a web page or component. It captures various content nodes along with - their associated attributes. Each node has a unique identifier and can be - of different types like text, image or component-instance. The schema also - provides pagination details for scenarios where the content nodes are too - many to be fetched in a single request. - properties: - pageId: - type: optional - docs: Page ID - nodes: optional> - pagination: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - TextNodeWrite: - docs: Update a text node - properties: - nodeId: - type: string - docs: Node UUID - text: - type: string - docs: >- - HTML content of the node, including the HTML tag. The HTML tags must - be the same as what's returned from the Get Content endpoint. - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem: - properties: - propertyId: - type: string - docs: The ID of the property. - text: - type: string - docs: > - The new string or HTML value used to override the component instance - property value. - - The provided value must be compatible with the type of the component - instance property. - - For example, attempting to override a single-line plain-text property - with a multi-line - - value will result in an error. - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - ComponentInstanceNodePropertyOverridesWrite: - docs: Update text property overrides of a component instance - properties: - nodeId: - type: string - docs: Node UUID - propertyOverrides: - docs: >- - A list of component instance properties to override within the - specified secondary locale. - type: list - source: - openapi: ../../../openapi/referenced-specs/v2.yml - Component: - docs: The Component object - properties: - id: - type: string - docs: Unique identifier for the Component - name: - type: optional - docs: Component Name - group: - type: optional - docs: The group that the component belongs to - description: - type: optional - docs: Component Description - readonly: - type: optional - docs: >- - Indicates whether the component is read-only. Components that cannot - be updated within this Site are set to readonly. Workspace Libraries - are a good example. - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ComponentList: - docs: List of Components on a site. - properties: - components: optional> - pagination: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ComponentDom: - docs: > - The Component DOM schema represents the content structure of a component. - Similar to Page DOM, it captures various content nodes and their - associated attributes, but specifically for a component's structure. Each - node has a unique identifier and can contain text, images, or nested - component instances. - properties: - componentId: - type: optional - docs: Component ID - nodes: optional> - pagination: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ComponentProperties: - docs: > - The Component Properties schema represents a list of properties that store - text content. Each property has a unique identifier and can be of - different types like plain text or rich text. The schema also provides - pagination details for scenarios where there more properties than the - limit. - properties: - componentId: - type: optional - docs: Component ID - properties: optional> - pagination: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ScriptApplyLocation: - enum: - - header - - footer - docs: >- - Location of the script, either in the header or footer of the published - site - default: header - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ScriptApply: - properties: - id: - type: string - docs: ID of the registered custom code script - location: - type: ScriptApplyLocation - docs: >- - Location of the script, either in the header or footer of the - published site - default: header - version: - type: string - docs: Semantic Version String for the registered script *e.g. 0.0.1* - attributes: - type: optional> - docs: >- - Developer-specified key/value pairs to be applied as attributes to the - script - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ScriptApplyList: - properties: - scripts: - type: optional> - docs: A list of scripts applied to a Site or a Page - lastUpdated: - type: optional - docs: Date when the Site's scripts were last updated - createdOn: - type: optional - docs: Date when the Site's scripts were created - source: - openapi: ../../../openapi/referenced-specs/v2.yml - CustomCodeHostedResponse: - docs: Registered custom code for application - properties: - id: - type: optional - docs: Human readable id, derived from the user-specified display name - canCopy: - type: optional - docs: >- - Define whether the script can be copied on site duplication and - transfer - default: false - displayName: - type: optional - docs: >- - User-facing name for the script. Must be between 1 and 50 alphanumeric - characters - hostedLocation: - type: optional - docs: URI for an externally hosted script location - integrityHash: - type: optional - docs: >- - Sub-Resource Integrity Hash. Only required for externally hosted - scripts (passed via hostedLocation) - createdOn: - type: optional - docs: Timestamp when the script version was created - lastUpdated: - type: optional - docs: Timestamp when the script version was last updated - version: - type: optional - docs: A Semantic Version (SemVer) string, denoting the version of the script - source: - openapi: ../../../openapi/referenced-specs/v2.yml - RegisteredScriptList: - docs: A list of scripts registered to the site - properties: - registeredScripts: optional> - source: - openapi: ../../../openapi/referenced-specs/v2.yml - CustomCodeInlineResponse: - docs: Registered custom code for application - properties: - id: - type: optional - docs: Human readable id, derived from the user-specified display name - canCopy: - type: optional - docs: >- - Define whether the script can be copied on site duplication and - transfer - default: false - displayName: - type: optional - docs: >- - User-facing name for the script. Must be between 1 and 50 alphanumeric - characters - hostedLocation: - type: optional - docs: URI for an externally hosted script location - integrityHash: - type: optional - docs: >- - Sub-Resource Integrity Hash. Only required for externally hosted - scripts (passed via hostedLocation) - createdOn: - type: optional - docs: Timestamp when the script version was created - lastUpdated: - type: optional - docs: Timestamp when the script version was last updated - version: - type: optional - docs: A Semantic Version (SemVer) string, denoting the version of the script - source: - openapi: ../../../openapi/referenced-specs/v2.yml - Scripts: - docs: A list of scripts applied to a Site or a Page - type: list - CustomCodeBlockType: - enum: - - page - - site - docs: Whether the Custom Code script is applied at the Site-level or Page-level - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - CustomCodeBlock: - docs: A specific instance of Custom Code applied to a Site or Page - properties: - siteId: - type: optional - docs: The Site ID where the custom code was applied - pageId: - type: optional - docs: The Page ID (if applied at Page-level) - type: - type: optional - docs: >- - Whether the Custom Code script is applied at the Site-level or - Page-level - scripts: optional - createdOn: - type: optional - docs: The date the Block was created - lastUpdated: - type: optional - docs: The date the Block was most recently updated - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ListCustomCodeBlocks: - docs: Custom Code Blocks corresponding to where scripts were applied - properties: - blocks: optional> - pagination: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - AssetVariant: - properties: - hostedUrl: - type: optional - docs: URL of where the asset variant is hosted - validation: - format: uri - originalFileName: - type: optional - docs: Original file name of the variant - displayName: - type: optional - docs: Display name of the variant - format: - type: optional - docs: format of the variant - width: - type: optional - docs: Width in pixels - height: - type: optional - docs: Height in pixels - quality: - type: optional - docs: Value between 0 and 100 representing the image quality - error: - type: optional - docs: Any associated validation errors - source: - openapi: ../../../openapi/referenced-specs/v2.yml - Asset: - properties: - id: - type: optional - docs: Unique identifier for this asset - contentType: - type: optional - docs: File format type - size: - type: optional - docs: size in bytes - siteId: - type: optional - docs: Unique identifier for the site that hosts this asset - hostedUrl: - type: optional - docs: Link to the asset - validation: - format: uri - originalFileName: - type: optional - docs: Original file name at the time of upload - displayName: - type: optional - docs: Display name of the asset - lastUpdated: - type: optional - docs: Date the asset metadata was last updated - createdOn: - type: optional - docs: Date the asset metadata was created - variants: optional> - altText: - type: optional - docs: The visual description of the asset - source: - openapi: ../../../openapi/referenced-specs/v2.yml - Assets: - docs: A list of assets - properties: - assets: optional> - source: - openapi: ../../../openapi/referenced-specs/v2.yml - AssetUploadUploadDetails: - docs: Metadata for uploading the asset binary - properties: - acl: optional - bucket: optional - X-Amz-Algorithm: optional - X-Amz-Credential: optional - X-Amz-Date: optional - key: optional - Policy: optional - X-Amz-Signature: optional - success_action_status: optional - content-type: optional - Cache-Control: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - AssetUpload: - properties: - uploadDetails: - type: optional - docs: Metadata for uploading the asset binary - contentType: optional - id: optional - parentFolder: - type: optional - docs: Parent folder for the asset - uploadUrl: - type: optional - validation: - format: uri - assetUrl: - type: optional - docs: S3 link to the asset - validation: - format: uri - hostedUrl: - type: optional - docs: Represents the link to the asset - validation: - format: uri - originalFileName: - type: optional - docs: >- - Original file name when uploaded. If not specified at time of upload, - it may be extracted from the raw file name - createdOn: - type: optional - docs: Date the asset metadata was created - lastUpdated: - type: optional - docs: Date the asset metadata was last updated - source: - openapi: ../../../openapi/referenced-specs/v2.yml - AssetFolder: - docs: Asset Folder details - properties: - id: - type: optional - docs: Unique identifier for the Asset Folder - displayName: - type: optional - docs: User visible name for the Asset Folder - parentFolder: - type: optional - docs: Pointer to parent Asset Folder (or null if root) - assets: - type: optional> - docs: Array of Asset instances in the folder - siteId: - type: optional - docs: The unique ID of the site the Asset Folder belongs to - createdOn: - type: optional - docs: Date that the Asset Folder was created on - lastUpdated: - type: optional - docs: Date that the Asset Folder was last updated on - source: - openapi: ../../../openapi/referenced-specs/v2.yml - AssetFolderList: - docs: The Asset Folders object - properties: - assetFolders: - type: optional> - docs: A list of Asset folders - pagination: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - TriggerType: - enum: - - form_submission - - site_publish - - page_created - - page_metadata_updated - - page_deleted - - ecomm_new_order - - ecomm_order_changed - - ecomm_inventory_changed - - user_account_added - - user_account_updated - - user_account_deleted - - collection_item_created - - collection_item_changed - - collection_item_deleted - - collection_item_unpublished - docs: > - * `form_submission` - Sends the [form_submission](#form_submission) event - - * `site_publish` - Sends a [site_publish](#site_publish) event - - * `page_created` - Send the [page_created](#page_created) event - - * `page_metadata_updated` - Sends the - [page_metadata_updated](#page_metadata_updated) event - - * `page_deleted` - Sends the [page_deleted](#page_deleted) event - - * `ecomm_new_order` - Sends the new [ecomm_new_order](#ecomm_new_order) - event - - * `ecomm_order_changed` - Sends the - [ecomm_order_changed](#ecomm_order_changed) event - - * `ecomm_inventory_changed` - Sends the - [ecomm_inventory_changed](#ecomm_inventory_changed) event - - * `user_account_added` - Sends the - [user_account_added](#user_account_added) event - - * `user_account_updated` - Sends the - [user_account_updated](#user_account_updated) event - - * `user_account_deleted` - Sends the - [user_account_deleted](#user_account_deleted) event - - * `collection_item_created` - Sends the - [collection_item_created](#collection_item_created) event - - * `collection_item_changed` - Sends the - [collection_item_changed](#collection_item_changed) event - - * `collection_item_deleted` - Sends the - [collection_item_deleted](#collection_item_deleted) event - - * `collection_item_unpublished` - Sends the - [collection_item_unpublished](#collection_item_unpublished) event - source: - openapi: ../../../openapi/referenced-specs/v2.yml - WebhookFilter: - docs: >- - Only supported for the `form_submission` trigger type. Filter for the form - you want Webhooks to be sent for. - properties: - name: - type: optional - docs: The name of the form you'd like to recieve notifications for. - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - Webhook: - properties: - id: - type: optional - docs: Unique identifier for the Webhook registration - triggerType: optional - url: - type: optional - docs: URL to send the Webhook payload to - workspaceId: - type: optional - docs: Unique identifier for the Workspace the Webhook is registered in - siteId: - type: optional - docs: Unique identifier for the Site the Webhook is registered in - filter: - type: optional - docs: >- - Only supported for the `form_submission` trigger type. Filter for the - form you want Webhooks to be sent for. - lastTriggered: - type: optional - docs: Date the Webhook instance was last triggered - createdOn: - type: optional - docs: Date the Webhook registration was created - source: - openapi: ../../../openapi/referenced-specs/v2.yml - WebhookList: - properties: - pagination: optional - webhooks: optional> - source: - openapi: ../../../openapi/referenced-specs/v2.yml - FormFieldValueType: - enum: - - Plain - - Email - - Password - - Phone - - Number - docs: The field type - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - FormFieldValue: - docs: An object containing field info for a specific fieldID. - properties: - displayName: - type: optional - docs: The field name displayed on the site - type: - type: optional - docs: The field type - placeholder: - type: optional - docs: The placeholder text for the field - userVisible: - type: optional - docs: Whether the field is visible to the user - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - FormField: - type: map - docs: A collection of form fields with additional properties. - FormResponseSettings: - docs: Settings for form responses - properties: - redirectUrl: - type: optional - docs: The url or path to redirect the user to after form submission - redirectMethod: - type: optional - docs: The HTTP request method to use for the redirectUrl (eg. POST or GET) - redirectAction: - type: optional - docs: The action to take after form submission - sendEmailConfirmation: - type: optional - docs: Whether to send an email confirmation to the user - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - Form: - docs: A Webflow form - properties: - displayName: - type: optional - docs: The Form name displayed on the site - createdOn: - type: optional - docs: Date that the Form was created on - lastUpdated: - type: optional - docs: Date that the Form was last updated on - fields: - type: optional - docs: A collection of form field objects - responseSettings: - type: optional - docs: Settings for form responses - id: - type: optional - docs: The unique ID for the Form - siteId: - type: optional - docs: The unique ID of the Site the Form belongs to - siteDomainId: - type: optional - docs: The unique ID corresponding to the site's Domain name - pageId: - type: optional - docs: The unique ID for the Page on which the Form is placed - pageName: - type: optional - docs: The user-visible name of the Page where the Form is placed - formElementId: - type: optional - docs: The unique ID of the Form element - workspaceId: - type: optional - docs: The unique ID of the Workspace the Site belongs to - source: - openapi: ../../../openapi/referenced-specs/v2.yml - FormList: - properties: - forms: optional> - pagination: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - FormSubmission: - properties: - id: - type: optional - docs: The unique ID of the Form submission - displayName: - type: optional - docs: The Form name displayed on the site - siteId: - type: optional - docs: The unique ID of the Site the Form belongs to - workspaceId: - type: optional - docs: The unique ID of the Workspace the Site belongs to - dateSubmitted: - type: optional - docs: Date that the Form was submitted on - formResponse: - type: optional> - docs: The data submitted in the Form - source: - openapi: ../../../openapi/referenced-specs/v2.yml - FormSubmissionList: - properties: - formSubmissions: optional> - pagination: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - UserDataData: - properties: - name: - type: optional - docs: | - The name of the user - email: - type: optional - docs: | - The email address of the user - accept-privacy: - type: optional - docs: | - Boolean indicating if the user has accepted the privacy policy - accept-communications: - type: optional - docs: | - Boolean indicating if the user has accepted to receive communications - additionalProperties: - type: optional - docs: Custom user attributes - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - UserData: - docs: An object containing the User's basic info and custom fields - properties: - data: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - UserStatus: - enum: - - invited - - verified - - unverified - docs: The status of the user - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - UserAccessGroupsItemType: - enum: - - admin - - ecommerce - docs: | - The type of access group based on how it was assigned to the user. - * `admin` - Assigned to the user via API or in the designer - * `ecommerce` - Assigned to the user via an ecommerce purchase - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - UserAccessGroupsItem: - docs: Access group slugs and types - properties: - slug: - type: optional - docs: Access group identifier for APIs - type: - type: optional - docs: | - The type of access group based on how it was assigned to the user. - * `admin` - Assigned to the user via API or in the designer - * `ecommerce` - Assigned to the user via an ecommerce purchase - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - User: - docs: > - The fields that define the schema for a given Item are based on the - Collection that Item belongs to. Beyond the user defined fields, there are - a handful of additional fields that are automatically created for all - items - properties: - id: - type: optional - docs: Unique identifier for the User - isEmailVerified: - type: optional - docs: Shows whether the user has verified their email address - lastUpdated: - type: optional - docs: The timestamp the user was updated - invitedOn: - type: optional - docs: The timestamp the user was invited - createdOn: - type: optional - docs: The timestamp the user was created - lastLogin: - type: optional - docs: The timestamp the user was logged in - status: - type: optional - docs: The status of the user - accessGroups: - type: optional> - docs: Access groups the user belongs to - data: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - UserList: - docs: The list users results - properties: - count: - type: optional - docs: Number of users returned - limit: - type: optional - docs: The limit specified in the request - default: 10 - offset: - type: optional - docs: The offset specified for pagination - default: 0 - total: - type: optional - docs: Total number of users in the collection - users: - type: optional> - docs: List of Users for a Site - source: - openapi: ../../../openapi/referenced-specs/v2.yml - UsersNotEnabled: unknown - DuplicateUserEmail: unknown - UserLimitReached: unknown - AccessGroup: - properties: - id: - type: optional - docs: Unique identifier for the Access Group - name: - type: optional - docs: Name of the the Access Group - shortId: - type: optional - docs: >- - Shortened unique identifier based on name, optimized for its use in - the user’s JWT - slug: - type: optional - docs: >- - Shortened unique identifier based on name, optimized for human - readability and public API use - createdOn: - type: optional - docs: The date the Access Group was created - source: - openapi: ../../../openapi/referenced-specs/v2.yml - AccessGroupList: - docs: The list access groups results - properties: - count: - type: optional - docs: Number of access groups returned - limit: - type: optional - docs: The limit specified in the request - default: 10 - offset: - type: optional - docs: The offset specified for pagination - default: 0 - total: - type: optional - docs: Total number of access groups in the collection - accessGroups: - type: optional> - docs: List of Site Access Groups - source: - openapi: ../../../openapi/referenced-specs/v2.yml - SkuPropertyListEnumItem: - docs: Enumerated Product variants/Options for the SKU - properties: - id: - type: string - docs: Unique identifier for a Product variant/Option - name: - type: string - docs: Name of the Product variant/Option - slug: - type: string - docs: Slug for the Product variant/Option in the Site URL structure - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - SkuPropertyList: - docs: A variant/option type for a SKU - properties: - id: - type: string - docs: Unique identifier for a collection of Product Variants - name: - type: string - docs: Name of the collection of Product Variants - enum: - docs: >- - The individual Product variants that are contained within the - collection - type: list - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ProductFieldDataTaxCategory: - enum: - - value: standard-taxable - name: StandardTaxable - - value: standard-exempt - name: StandardExempt - - value: books-religious - name: BooksReligious - - value: books-textbook - name: BooksTextbook - - clothing - - value: clothing-swimwear - name: ClothingSwimwear - - value: digital-goods - name: DigitalGoods - - value: digital-service - name: DigitalService - - value: drugs-non-prescription - name: DrugsNonPrescription - - value: drugs-prescription - name: DrugsPrescription - - value: food-bottled-water - name: FoodBottledWater - - value: food-candy - name: FoodCandy - - value: food-groceries - name: FoodGroceries - - value: food-prepared - name: FoodPrepared - - value: food-soda - name: FoodSoda - - value: food-supplements - name: FoodSupplements - - value: magazine-individual - name: MagazineIndividual - - value: magazine-subscription - name: MagazineSubscription - - value: service-admission - name: ServiceAdmission - - value: service-advertising - name: ServiceAdvertising - - value: service-dry-cleaning - name: ServiceDryCleaning - - value: service-hairdressing - name: ServiceHairdressing - - value: service-installation - name: ServiceInstallation - - value: service-miscellaneous - name: ServiceMiscellaneous - - value: service-parking - name: ServiceParking - - value: service-printing - name: ServicePrinting - - value: service-professional - name: ServiceProfessional - - value: service-repair - name: ServiceRepair - - value: service-training - name: ServiceTraining - docs: Product tax class - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ProductFieldDataEcProductType: - enum: - - ff42fee0113744f693a764e3431a9cc2 - - f22027db68002190aef89a4a2b7ac8a1 - - c599e43b1a1c34d5a323aedf75d3adf6 - - b6ccc1830db4b1babeb06a9ac5f6dd76 - docs: >- - Product - types. Enums reflect the following values in order: Physical, Digital, - Service, Advanced" - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ProductFieldData: - docs: >- - Contains content-specific details for a product, covering both standard - (e.g., title, description) and custom fields tailored to the product - setup. - properties: - name: - type: optional - docs: Name of the Product - slug: - type: optional - docs: URL structure of the Product in your site. - description: - type: optional - docs: A description of your product - shippable: - type: optional - docs: Boolean determining if the Product is shippable - sku-properties: - type: optional> - docs: Variant types to include in SKUs - categories: - type: optional> - docs: The categories your product belongs to. - tax-category: - type: optional - docs: Product tax class - default-sku: - type: optional - docs: The default SKU associated with this product. - ec-product-type: - type: optional - docs: >- - Product - types. Enums reflect the following values in order: Physical, - Digital, Service, Advanced" - source: - openapi: ../../../openapi/referenced-specs/v2.yml - Product: - docs: The Product object - properties: - id: - type: optional - docs: Unique identifier for the Product - cmsLocaleId: - type: optional - docs: Identifier for the locale of the CMS item - lastPublished: - type: optional - docs: The date the Product was last published - lastUpdated: - type: optional - docs: The date the Product was last updated - createdOn: - type: optional - docs: The date the Product was created - isArchived: - type: optional - docs: Boolean determining if the Product is set to archived - default: false - isDraft: - type: optional - docs: Boolean determining if the Product is set to draft - default: false - fieldData: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - SkuValueList: - type: map - docs: > - A dictionary that maps a SKU property to a SKU value. The key of the - dictionary is the SKU property ID, and the value is the SKU value ID. - SkuFieldDataPrice: - docs: price of SKU - properties: - value: - type: optional - docs: Price of SKU - unit: - type: optional - docs: Currency of Item - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - SkuFieldDataCompareAtPrice: - docs: comparison price of SKU - properties: - value: - type: optional - docs: Price of SKU - unit: - type: optional - docs: Currency of Item - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - SkuFieldDataEcSkuBillingMethod: - enum: - - value: one-time - name: OneTime - - subscription - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - SkuFieldDataEcSkuSubscriptionPlanInterval: - enum: - - day - - week - - month - - year - docs: Interval of subscription renewal - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - SkuFieldDataEcSkuSubscriptionPlanPlansItemStatus: - enum: - - active - - inactive - - canceled - docs: The status of the plan - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - SkuFieldDataEcSkuSubscriptionPlanPlansItem: - properties: - platform: - type: optional> - docs: The platform of the subscription plan - id: - type: optional - docs: The unique identifier of the plan - status: - type: optional - docs: The status of the plan - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - SkuFieldDataEcSkuSubscriptionPlan: - properties: - interval: - type: optional - docs: Interval of subscription renewal - frequency: - type: optional - docs: Frequncy of billing within interval - trial: - type: optional - docs: Number of days of a trial - plans: optional> - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - SkuFieldData: - docs: Standard and Custom fields for a SKU - properties: - sku-values: optional - name: - type: string - docs: Name of the Product - slug: - type: string - docs: URL structure of the Product in your site. - price: - type: SkuFieldDataPrice - docs: price of SKU - compare-at-price: - type: optional - docs: comparison price of SKU - ec-sku-billing-method: optional - ec-sku-subscription-plan: optional - track-inventory: - type: optional - docs: >- - A boolean indicating whether inventory for this product should be - tracked. - default: false - quantity: - type: optional - docs: Quantity of SKU that will be tracked as items are ordered. - source: - openapi: ../../../openapi/referenced-specs/v2.yml - Sku: - docs: The SKU object - properties: - id: - type: optional - docs: Unique identifier for the Product - cmsLocaleId: - type: optional - docs: Identifier for the locale of the CMS item - lastPublished: - type: optional - docs: The date the Product was last published - lastUpdated: - type: optional - docs: The date the Product was last updated - createdOn: - type: optional - docs: The date the Product was created - fieldData: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ProductAndSkUs: - docs: A product and its SKUs. - properties: - product: optional - skus: - type: optional> - docs: A list of SKU Objects - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ProductAndSkUsList: - docs: Results from product list - properties: - items: - type: optional> - docs: >- - List of Item objects within the Collection. Contains product and skus - keys for each Item - pagination: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - PublishStatus: - enum: - - staging - - live - docs: Indicate whether your Product should be set as "staging" or "live" - default: staging - source: - openapi: ../../../openapi/referenced-specs/v2.yml - OrderPrice: - properties: - unit: - type: optional - docs: The three-letter ISO currency code - value: - type: optional - docs: The numeric value in the base unit of the currency - string: - type: optional - docs: The user-facing string representation of the amount - source: - openapi: ../../../openapi/referenced-specs/v2.yml - OrderAddressType: - enum: - - shipping - - billing - docs: The type of the order address (billing or shipping) - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - OrderAddressJapanType: - enum: - - kana - - kanji - docs: >- - Represents a Japan-only address format. This field will only appear on - orders placed from Japan. - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - OrderAddress: - docs: A customer address - properties: - type: - type: optional - docs: The type of the order address (billing or shipping) - japanType: - type: optional - docs: >- - Represents a Japan-only address format. This field will only appear on - orders placed from Japan. - addressee: - type: optional - docs: Display name on the address - line1: - type: optional - docs: The first line of the address - line2: - type: optional - docs: The second line of the address - city: - type: optional - docs: The city of the address. - state: - type: optional - docs: The state or province of the address - country: - type: optional - docs: The country of the address - postalCode: - type: optional - docs: The postal code of the address - source: - openapi: ../../../openapi/referenced-specs/v2.yml - OrderPurchasedItemVariantImageFileVariantsItem: - properties: - url: - type: optional - docs: The hosted location for the Variant's image - validation: - format: uri - originalFileName: optional - size: - type: optional - docs: The image size in bytes - width: - type: optional - docs: The image width in pixels - height: - type: optional - docs: The image height in pixels - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - OrderPurchasedItemVariantImageFile: - properties: - size: - type: optional - docs: The image size in bytes - originalFileName: - type: optional - docs: the original name of the image - createdOn: - type: optional - docs: The creation timestamp of the image - contentType: - type: optional - docs: The MIME type of the image - width: - type: optional - docs: The image width in pixels - height: - type: optional - docs: The image height in pixels - variants: - type: optional> - docs: Variants of the supplied image - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - OrderPurchasedItemVariantImage: - properties: - url: - type: optional - docs: The hosted location for the Variant's image - validation: - format: uri - file: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - OrderPurchasedItem: - docs: An Item that was purchased - properties: - count: - type: optional - docs: Number of Item purchased. - rowTotal: - type: optional - docs: The total for the row - productId: - type: optional - docs: The unique identifier for the Product - productName: - type: optional - docs: User-facing name of the Product - productSlug: - type: optional - docs: Slug for the Product - variantId: - type: optional - docs: Identifier for the Product Variant (SKU) - variantName: - type: optional - docs: User-facing name of the Product Variant (SKU) - variantSlug: - type: optional - docs: Slug for the Product Variant (SKU) - variantSKU: - type: optional - docs: The user-defined custom SKU of the Product Variant (SKU) - variantImage: optional - variantPrice: - type: optional - docs: The price corresponding to the variant - weight: - type: optional - docs: The physical weight of the variant if provided, or null - width: - type: optional - docs: The physical width of the variant if provided, or null - height: - type: optional - docs: The physical height of the variant if provided, or null - length: - type: optional - docs: The physical length of the variant if provided, or null - source: - openapi: ../../../openapi/referenced-specs/v2.yml - StripeDetails: - docs: >- - An object with various Stripe IDs, useful for linking into the stripe - dashboard. - properties: - subscriptionId: - type: optional - docs: Stripe-generated identifier for the Subscription - paymentMethod: - type: optional - docs: Stripe-generated identifier for the PaymentMethod used - paymentIntentId: - type: optional - docs: Stripe-generated identifier for the PaymentIntent, or null - customerId: - type: optional - docs: Stripe-generated customer identifier, or null - chargeId: - type: optional - docs: Stripe-generated charge identifier, or null - disputeId: - type: optional - docs: Stripe-generated dispute identifier, or null - refundId: - type: optional - docs: Stripe-generated refund identifier, or null - refundReason: - type: optional - docs: Stripe-generated refund reason, or null - source: - openapi: ../../../openapi/referenced-specs/v2.yml - StripeCardBrand: - enum: - - Visa - - value: American Express - name: AmericanExpress - - MasterCard - - Discover - - JCB - - value: Diners Club - name: DinersClub - - Unknown - docs: The card's brand (ie. credit card network) - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - StripeCardExpires: - docs: The card's expiration date. - properties: - year: - type: optional - docs: Year that the card expires - month: - type: optional - docs: Month that the card expires - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - StripeCard: - docs: > - Details on the card used to fulfill this order, if this order was - finalized with Stripe. - properties: - last4: - type: optional - docs: The last 4 digits on the card as a string - brand: - type: optional - docs: The card's brand (ie. credit card network) - ownerName: - type: optional - docs: The name on the card. - expires: - type: optional - docs: The card's expiration date. - source: - openapi: ../../../openapi/referenced-specs/v2.yml - PaypalDetails: - properties: - orderId: - type: optional - docs: PayPal order identifier - payerId: - type: optional - docs: PayPal payer identifier - captureId: - type: optional - docs: PayPal capture identifier - refundId: - type: optional - docs: PayPal refund identifier - refundReason: - type: optional - docs: PayPal-issued reason for the refund - disputeId: - type: optional - docs: PayPal dispute identifier - source: - openapi: ../../../openapi/referenced-specs/v2.yml - OrderStatus: - enum: - - pending - - unfulfilled - - fulfilled - - disputed - - value: dispute-lost - name: DisputeLost - - refunded - docs: | - The status of the Order - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - OrderDisputeLastStatus: - enum: - - warning_needs_response - - warning_under_review - - warning_closed - - needs_response - - under_review - - charge_refunded - - won - - lost - docs: > - If an order was disputed by the customer, then this key will be set with - the [dispute's status](https://stripe.com/docs/api#dispute_object-status). - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - OrderCustomerInfo: - docs: An object with the keys `fullName` and `email`. - properties: - fullName: - type: optional - docs: The full name of the Customer - email: - type: optional - docs: The Customer's email address - validation: - format: email - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - OrderMetadata: - properties: - isBuyNow: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - OrderTotalsExtrasItemType: - enum: - - discount - - value: discount-shipping - name: DiscountShipping - - shipping - - tax - docs: The type of extra item this is. - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - OrderTotalsExtrasItem: - docs: Extra order items, includes discounts, shipping, and taxes. - properties: - type: - type: optional - docs: The type of extra item this is. - name: - type: optional - docs: A human-readable (but English) name for this extra charge. - description: - type: optional - docs: A human-readable (but English) description of this extra charge. - price: - type: optional - docs: The price for the item - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - OrderTotals: - docs: An object describing various pricing totals - properties: - subtotal: - type: optional - docs: The subtotal price - extras: - type: optional> - docs: An array of extra items, includes discounts, shipping, and taxes. - total: - type: optional - docs: The total price - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - OrderDownloadFilesItem: - properties: - id: - type: optional - docs: The unique identifier for the downloadable file - name: - type: optional - docs: The user-facing name for the downloadable file - url: - type: optional - docs: The hosted location for the downloadable file - validation: - format: uri - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - Order: - properties: - orderId: - type: optional - docs: | - The order ID. Will usually be 6 hex characters, but can also be 9 - hex characters if the site has a very large number of Orders. - Randomly assigned. - status: - type: optional - docs: | - The status of the Order - comment: - type: optional - docs: >- - A comment string for this Order, which is editable by API user (not - used by Webflow). - orderComment: - type: optional - docs: A comment that the customer left when making their Order - acceptedOn: - type: optional - docs: The ISO8601 timestamp that an Order was placed. - fulfilledOn: - type: optional - docs: > - When an Order is marked as 'fulfilled', this field represents the - timestamp of the fulfillment in ISO8601 format. Otherwise, it is null. - refundedOn: - type: optional - docs: >- - When an Order is marked as 'refunded', this field represents the - timestamp of the fulfillment in ISO8601 format. Otherwise, it is null. - disputedOn: - type: optional - docs: > - When an Order is marked as 'disputed', this field represents the - timestamp of the fulfillment in ISO8601 format. Otherwise, it is null. - disputeUpdatedOn: - type: optional - docs: > - If an Order has been disputed by the customer, this key will be set to - the ISO8601 timestamp of the last update received. If the Order is not - disputed, the key will be null. - disputeLastStatus: - type: optional - docs: > - If an order was disputed by the customer, then this key will be set - with the [dispute's - status](https://stripe.com/docs/api#dispute_object-status). - customerPaid: - type: optional - docs: The total paid by the customer - netAmount: - type: optional - docs: The net amount after application fees - applicationFee: - type: optional - docs: The application fee assessed by the platform - allAddresses: - type: optional> - docs: All addresses provided by the customer during the ordering flow. - shippingAddress: - type: optional - docs: The shipping address - billingAddress: - type: optional - docs: The billing address - shippingProvider: - type: optional - docs: > - A string editable by the API user to note the shipping provider used - (not used by Webflow). - shippingTracking: - type: optional - docs: > - A string editable by the API user to note the shipping tracking number - for the order (not used by Webflow). - shippingTrackingURL: - type: optional - validation: - format: uri - customerInfo: - type: optional - docs: An object with the keys `fullName` and `email`. - purchasedItems: - type: optional> - docs: An array of all things that the Customer purchased. - purchasedItemsCount: - type: optional - docs: The sum of all 'count' fields in 'purchasedItems'. - stripeDetails: optional - stripeCard: optional - paypalDetails: optional - customData: - type: optional>> - docs: > - An array of additional inputs for custom order data gathering. Each - object in the array represents an input with a name, and a textInput, - textArea, or checkbox value. - metadata: optional - isCustomerDeleted: - type: optional - docs: > - A boolean indicating whether the customer has been deleted from the - site. - isShippingRequired: - type: optional - docs: > - A boolean indicating whether the order contains one or more purchased - items that require shipping. - hasDownloads: - type: optional - docs: > - A boolean indicating whether the order contains one or more purchased - items that are downloadable. - paymentProcessor: - type: optional - docs: | - A string indicating the payment processor used for this order. - totals: - type: optional - docs: An object describing various pricing totals - downloadFiles: - type: optional> - docs: An array of downloadable file objects. - source: - openapi: ../../../openapi/referenced-specs/v2.yml - OrderList: - docs: Results from order list - properties: - orders: - type: optional> - docs: List of orders - pagination: optional - source: - openapi: ../../../openapi/referenced-specs/v2.yml - InventoryItemInventoryType: - enum: - - infinite - - finite - docs: infinite or finite - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - InventoryItem: - docs: The availabile inventory for an item - properties: - id: - type: optional - docs: Unique identifier for a SKU item - quantity: - type: optional - docs: >- - Total quantity of items remaining in inventory (if inventoryType is - finite) - inventoryType: - type: optional - docs: infinite or finite - source: - openapi: ../../../openapi/referenced-specs/v2.yml - EcommerceSettings: - docs: Ecommerce settings for a Webflow Site - properties: - siteId: - type: optional - docs: The identifier of the Site - createdOn: - type: optional - docs: Date that the Site was created on - defaultCurrency: - type: optional - docs: The three-letter ISO currency code for the Site - source: - openapi: ../../../openapi/referenced-specs/v2.yml diff --git a/.mock/definition/accessGroups.yml b/.mock/definition/accessGroups.yml deleted file mode 100644 index d8828f8..0000000 --- a/.mock/definition/accessGroups.yml +++ /dev/null @@ -1,80 +0,0 @@ -types: - AccessGroupsListRequestSort: - enum: - - value: CreatedOn - name: CreatedOnAscending - docs: Sorts users in ascending order based on their created date - - value: '-CreatedOn' - name: CreatedOnDescending - docs: Sorts users in descending order based on their created date - source: - openapi: ../../../openapi/referenced-specs/v2.yml -imports: - root: __package__.yml -service: - auth: false - base-path: '' - endpoints: - list: - path: /sites/{site_id}/accessgroups - method: GET - auth: true - docs: | - Get a list of access groups for a site - - Required scope | `users:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: List Access Groups - request: - name: AccessGroupsListRequest - query-parameters: - offset: - type: optional - docs: >- - Offset used for pagination if the results have more than limit - records - limit: - type: optional - docs: 'Maximum number of records to be returned (max limit: 100)' - sort: - type: optional - docs: | - Sort string to use when ordering access groups - Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) - response: - docs: Request was successful - type: root.AccessGroupList - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - response: - body: - count: 1 - limit: 10 - offset: 0 - total: 1 - accessGroups: - - id: 62be58d404be8a6cc900c081 - name: Research Team - shortId: rt - slug: hitchhikers-guide-research-team - createdOn: '2022-08-01T19:41:48Z' - - id: 65a96161991e77bbb4a6c573 - name: Admin - shortId: ad - slug: admin - createdOn: '2022-08-01T19:41:48Z' - source: - openapi: ../../../openapi/referenced-specs/v2.yml diff --git a/.mock/definition/api.yml b/.mock/definition/api.yml deleted file mode 100644 index aee9acd..0000000 --- a/.mock/definition/api.yml +++ /dev/null @@ -1,13 +0,0 @@ -name: api -error-discrimination: - strategy: status-code -display-name: Data API -environments: - Default: https://api.webflow.com/v2 -default-environment: Default -auth-schemes: - BearerToken: - scheme: bearer - token: - name: accessToken -auth: BearerToken diff --git a/.mock/definition/assets.yml b/.mock/definition/assets.yml deleted file mode 100644 index 35392ec..0000000 --- a/.mock/definition/assets.yml +++ /dev/null @@ -1,415 +0,0 @@ -imports: - root: __package__.yml -service: - auth: false - base-path: '' - endpoints: - list: - path: /sites/{site_id}/assets - method: GET - auth: true - docs: | - List assets for a given site - - Required scope | `assets:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: List Assets - response: - docs: Request was successful - type: root.Assets - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - response: - body: - assets: - - id: 63e5889e7fe4eafa7384cea4 - contentType: image/png - size: 2212772 - siteId: 63938b302ea6b0aa6f3d8745 - hostedUrl: >- - https://s3.amazonaws.com/webflow-prod-assets/63938b302ea6b0aa6f3d8745/63e5889e7fe4eafa7384cea4_Vectors-Wrapper.svg - originalFileName: Candy-Wrapper.svg - displayName: 63e5889e7fe4eafa7384cea4_Candy-Wrapper.png - lastUpdated: '2023-03-01T23:42:57Z' - createdOn: '2023-02-09T23:58:22Z' - variants: - - hostedUrl: >- - https://s3.amazonaws.com/webflow-prod-assets/6258612d1ee792848f805dcf/660d83ce30f3a599ddb0bdb3_Screenshot%202024-03-20%20at%209.03.24%E2%80%AFPM-p-500.png - originalFileName: >- - Screenshot%202024-03-20%20at%209.03.24%E2%80%AFPM-p-500.png - displayName: >- - 660d83ce30f3a599ddb0bdb3_Screenshot%202024-03-20%20at%209.03.24%E2%80%AFPM-p-500.png - format: png - width: 500 - height: 900 - quality: 100 - altText: A red chair - create: - path: /sites/{site_id}/assets - method: POST - auth: true - docs: > - Create a new asset entry. - - - - This endpoint generates a response with the following information: - `uploadUrl` and `uploadDetails`. - - You can use these two properties to [upload the file to Amazon s3 by - making a - POST](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html) - - request to the `uploadUrl` with the `uploadDetails` object as your - header information in the request. - - - Required scope | `assets:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: Create Asset Metadata - request: - name: AssetsCreateRequest - body: - properties: - fileName: - type: string - docs: >- - File name including file extension. File names must be less than - 100 characters. - fileHash: - type: string - docs: MD5 hash of the file - parentFolder: - type: optional - docs: ID of the Asset folder (optional) - content-type: application/json - response: - docs: Request was successful - type: root.AssetUpload - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - request: - fileName: file.png - fileHash: 3c7d87c9575702bc3b1e991f4d3c638e - response: - body: - uploadDetails: - acl: public-read - bucket: webflow-bucket-name - X-Amz-Algorithm: AWS4-HMAC-SHA256 - X-Amz-Credential: ///s3/aws4_request - X-Amz-Date: - key: /_ - Policy: - X-Amz-Signature: - success_action_status: '201' - content-type: image/png - Cache-Control: max-age=31536000, must-revalidate - contentType: image/png - id: 64358b9544249dc43d37d2b7 - parentFolder: 6436b1ce5281cace05b65aea - uploadUrl: >- - https://s3.amazonaws.com/webflow-dev-assets/643021114e290e0d3a0602b2/64358b9544249dc43d37d2b7_Screenshot%202023-04-11%20at%209.50.42%20AM.png - assetUrl: >- - https://s3.amazonaws.com/webflow-prod-assets/6258612d1ee792848f805dcf/660d907ab9e91e3e9f56385e_paranoidAndroid-2024.png - hostedUrl: >- - https://d1otoma47x30pg.cloudfront.net/643021114e290e0d3a0602b2/64358b9544249dc43d37d2b7_Screenshot%202023-04-11%20at%209.50.42%20AM.png - originalFileName: file.png - createdOn: '2023-04-11T16:32:21Z' - lastUpdated: '2023-04-12T20:31:03Z' - get: - path: /assets/{asset_id} - method: GET - auth: true - docs: | - Get an Asset - - Required scope | `assets:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - asset_id: - type: string - docs: Unique identifier for an Asset on a site - display-name: Get Asset - response: - docs: Request was successful - type: root.Asset - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - asset_id: 580e63fc8c9a982ac9b8b745 - response: - body: - id: 55131cd036c09f7d07883dfc - contentType: image/png - size: 1500 - siteId: 62749158efef318abc8d5a0f - hostedUrl: example.com/hostedimage.png - originalFileName: image.png - displayName: example-image-123.png - lastUpdated: '2016-09-06T21:12:22Z' - createdOn: '2016-09-02T23:26:22Z' - variants: - - hostedUrl: example.com/hostedimage.png - originalFileName: image.png - displayName: A brown dog - format: format - width: 1500 - height: 900 - quality: 1 - error: error - altText: A red chair - delete: - path: /assets/{asset_id} - method: DELETE - auth: true - docs: | - Delete an Asset - - Required Scope: `assets: write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - asset_id: - type: string - docs: Unique identifier for an Asset on a site - display-name: Delete Asset - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - asset_id: 580e63fc8c9a982ac9b8b745 - update: - path: /assets/{asset_id} - method: PATCH - auth: true - docs: | - Update an Asset - - Required scope | `assets:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - asset_id: - type: string - docs: Unique identifier for an Asset on a site - display-name: Update Asset - request: - name: AssetsUpdateRequest - body: - properties: - localeId: - type: optional - docs: >- - Unique identifier for a specific locale. Applicable, when using - localization. - displayName: - type: optional - docs: A human readable name for the asset - content-type: application/json - response: - docs: Request was successful - type: root.Asset - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - asset_id: 580e63fc8c9a982ac9b8b745 - request: {} - response: - body: - id: 55131cd036c09f7d07883dfc - contentType: image/png - size: 1500 - siteId: 62749158efef318abc8d5a0f - hostedUrl: example.com/hostedimage.png - originalFileName: image.png - displayName: example-image-123.png - lastUpdated: '2016-09-06T21:12:22Z' - createdOn: '2016-09-02T23:26:22Z' - variants: - - hostedUrl: example.com/hostedimage.png - originalFileName: image.png - displayName: A brown dog - format: format - width: 1500 - height: 900 - quality: 1 - error: error - altText: A red chair - list-folders: - path: /sites/{site_id}/asset_folders - method: GET - auth: true - docs: | - List Asset Folders within a given site - - Required scope | `assets:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: List Asset Folders - response: - docs: Request was successful - type: root.AssetFolderList - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - response: - body: - assetFolders: - - id: 6390c49774a71f0e3c1a08ee - displayName: emoji icons - parentFolder: 6390c49774a71f99f21a08eb - assets: - - 63e5889e7fe4eafa7384cea4 - - 659595234426a9fcbad57043 - siteId: 6390c49674a71f84b51a08d8 - createdOn: '2018-10-14T21:55:49Z' - lastUpdated: '2022-12-07T16:51:37Z' - pagination: - limit: 1 - offset: 0 - total: 1 - create-folder: - path: /sites/{site_id}/asset_folders - method: POST - auth: true - docs: | - Create an Asset Folder within a given site - - Required scope | `assets:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: Create Asset Folder - request: - name: AssetsCreateFolderRequest - body: - properties: - displayName: - type: string - docs: A human readable name for the Asset Folder - parentFolder: - type: optional - docs: >- - An (optional) pointer to a parent Asset Folder (or null for - root) - content-type: application/json - response: - docs: Request was successful - type: root.AssetFolder - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - request: - displayName: my asset folder - response: - body: - id: 6390c49774a71f0e3c1a08ee - displayName: emoji icons - parentFolder: 6390c49774a71f99f21a08eb - assets: - - 63e5889e7fe4eafa7384cea4 - - 659595234426a9fcbad57043 - siteId: 6390c49674a71f84b51a08d8 - createdOn: '2018-10-14T21:55:49Z' - lastUpdated: '2022-12-07T16:51:37Z' - get-folder: - path: /asset_folders/{asset_folder_id} - method: GET - auth: true - docs: | - Get details about a specific Asset Folder - - Required scope | `assets:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - asset_folder_id: - type: string - docs: Unique identifier for an Asset Folder - display-name: Get Asset Folder - response: - docs: Request was successful - type: root.AssetFolder - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - asset_folder_id: 6390c49774a71f0e3c1a08ee - response: - body: - id: 6390c49774a71f0e3c1a08ee - displayName: emoji icons - parentFolder: 6390c49774a71f99f21a08eb - assets: - - 63e5889e7fe4eafa7384cea4 - - 659595234426a9fcbad57043 - siteId: 6390c49674a71f84b51a08d8 - createdOn: '2018-10-14T21:55:49Z' - lastUpdated: '2022-12-07T16:51:37Z' - source: - openapi: ../../../openapi/referenced-specs/v2.yml - display-name: Assets -docs: Assets are files that are uploaded to your Webflow account. diff --git a/.mock/definition/collections.yml b/.mock/definition/collections.yml deleted file mode 100644 index 661b54b..0000000 --- a/.mock/definition/collections.yml +++ /dev/null @@ -1,186 +0,0 @@ -imports: - root: __package__.yml -service: - auth: false - base-path: '' - endpoints: - list: - path: /sites/{site_id}/collections - method: GET - auth: true - docs: | - List of all Collections within a Site. - - Required scope | `cms:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: List Collections - response: - docs: Request was successful - type: root.CollectionList - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - response: - body: - collections: - - id: 63692ab61fb2852f582ba8f5 - displayName: Products - singularName: Product - slug: product - createdOn: '2019-06-12T13:35:14Z' - lastUpdated: '2022-11-17T15:08:50Z' - - id: 63692ab61fb2856e6a2ba8f6 - displayName: Categories - singularName: Category - slug: category - createdOn: '2019-06-12T13:35:14Z' - lastUpdated: '2022-11-17T15:08:50Z' - - id: 63692ab61fb285a8562ba8f4 - displayName: SKUs - singularName: SKU - slug: sku - createdOn: '2019-06-12T13:35:14Z' - lastUpdated: '2022-11-17T15:08:50Z' - create: - path: /sites/{site_id}/collections - method: POST - auth: true - docs: | - Create a Collection for a site. - - Required scope | `cms:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: Create Collection - request: - name: CollectionsCreateRequest - body: - properties: - displayName: - type: string - docs: Name of the collection. Each collection name must be distinct. - singularName: - type: string - docs: Singular name of each item. - slug: - type: optional - docs: Part of a URL that identifier - content-type: application/json - response: - docs: Request was successful - type: root.Collection - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - request: - displayName: Blog Posts - singularName: Blog Post - slug: posts - response: - body: - id: 580e63fc8c9a982ac9b8b745 - displayName: Blog Posts - singularName: Blog Post - slug: post - createdOn: '2016-10-24T19:41:48Z' - lastUpdated: '2016-10-24T19:42:38Z' - fields: - - id: 23cc2d952d4e4631ffd4345d2743db4e - isRequired: true - isEditable: true - type: PlainText - slug: name - displayName: Name - helpText: helpText - get: - path: /collections/{collection_id} - method: GET - auth: true - docs: | - Get the full details of a collection from its ID. - - Required scope | `cms:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - display-name: Get Collection Details - response: - docs: Request was successful - type: root.Collection - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - response: - body: - id: 580e63fc8c9a982ac9b8b745 - displayName: Blog Posts - singularName: Blog Post - slug: post - createdOn: '2016-10-24T19:41:48Z' - lastUpdated: '2016-10-24T19:42:38Z' - fields: - - id: 23cc2d952d4e4631ffd4345d2743db4e - isRequired: true - isEditable: true - type: PlainText - slug: name - displayName: Name - helpText: helpText - delete: - path: /collections/{collection_id} - method: DELETE - auth: true - docs: | - Delete a collection using its ID. - - Required scope | `cms:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - display-name: Delete Collection - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - source: - openapi: ../../../openapi/referenced-specs/v2.yml - display-name: Collections -docs: Collections are CMS collections of items. diff --git a/.mock/definition/collections/fields.yml b/.mock/definition/collections/fields.yml deleted file mode 100644 index 08dc554..0000000 --- a/.mock/definition/collections/fields.yml +++ /dev/null @@ -1,189 +0,0 @@ -types: - FieldCreateType: - enum: - - Color - - DateTime - - Email - - ExtFileRef - - File - - Image - - Link - - MultiImage - - Number - - Phone - - PlainText - - RichText - - Switch - - Video - docs: Choose these appropriate field type for your collection data - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml -imports: - root: ../__package__.yml -service: - auth: false - base-path: '' - endpoints: - create: - path: /collections/{collection_id}/fields - method: POST - auth: true - docs: > - Create a custom field in a collection. - - - Slugs must be all lowercase letters without spaces. - - If you pass a string with uppercase letters and/or spaces to the "Slug" - property, Webflow will - - convert the slug to lowercase and replace spaces with "-." - - - Only some field types can be created through the API. - - This endpoint does not currently support bulk creation. - - - Required scope | `cms:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - display-name: Create Collection Field - request: - name: FieldCreate - body: - properties: - isRequired: - type: optional - docs: define whether a field is required in a collection - type: - type: FieldCreateType - docs: Choose these appropriate field type for your collection data - displayName: - type: string - docs: The name of a field - helpText: - type: optional - docs: Additional text to help anyone filling out this field - content-type: application/json - response: - docs: Request was successful - type: root.Field - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - request: - isRequired: false - type: RichText - displayName: Post Body - helpText: Add the body of your post here - response: - body: - id: 75821f618da60c18383330bcc0ca488b - isRequired: false - isEditable: true - type: RichText - slug: post-body - displayName: Post Body - helpText: Add the body of your post here - delete: - path: /collections/{collection_id}/fields/{field_id} - method: DELETE - auth: true - docs: > - Delete a custom field in a collection. This endpoint does not currently - support bulk deletion. - - - Required scope | `cms:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - field_id: - type: string - docs: Unique identifier for a Field in a collection - display-name: Delete Collection Field - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - field_id: 580e63fc8c9a982ac9b8b745 - update: - path: /collections/{collection_id}/fields/{field_id} - method: PATCH - auth: true - docs: | - Update a custom field in a collection. - - Required scope | `cms:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - field_id: - type: string - docs: Unique identifier for a Field in a collection - display-name: Update Collection Field - request: - name: FieldUpdate - body: - properties: - isRequired: - type: optional - docs: Define whether a field is required in a collection - displayName: - type: optional - docs: The name of a field - helpText: - type: optional - docs: Additional text to help anyone filling out this field - content-type: application/json - response: - docs: Request was successful - type: root.Field - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - field_id: 580e63fc8c9a982ac9b8b745 - request: - isRequired: false - displayName: Post Body - helpText: Add the body of your post here - response: - body: - id: 75821f618da60c18383330bcc0ca488b - isRequired: false - isEditable: true - type: RichText - slug: post-body - displayName: Post Body - helpText: Add the body of your post here - source: - openapi: ../../../openapi/referenced-specs/v2.yml diff --git a/.mock/definition/collections/items.yml b/.mock/definition/collections/items.yml deleted file mode 100644 index f765817..0000000 --- a/.mock/definition/collections/items.yml +++ /dev/null @@ -1,1628 +0,0 @@ -types: - ItemsListItemsRequestSortBy: - enum: - - lastPublished - - name - - slug - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ItemsListItemsRequestSortOrder: - enum: - - asc - - desc - source: - openapi: ../../../openapi/referenced-specs/v2.yml - Multiple Items: - properties: - items: - type: optional> - docs: An array of items to create - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - ItemsCreateItemRequest: - discriminated: false - union: - - root.CollectionItemPostSingle - - Multiple Items - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ItemsDeleteItemsRequestItemsItem: - properties: - id: - type: string - docs: Unique identifier for the Item - cmsLocaleIds: - type: optional> - docs: Array of identifiers for the locales where the item will be created - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - ItemsListItemsLiveRequestSortBy: - enum: - - lastPublished - - name - - slug - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ItemsListItemsLiveRequestSortOrder: - enum: - - asc - - desc - source: - openapi: ../../../openapi/referenced-specs/v2.yml - Multiple Live Items: - properties: - items: - type: optional> - docs: List of collection items to create - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - ItemsCreateItemLiveRequest: - discriminated: false - union: - - root.CollectionItem - - Multiple Live Items - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ItemsDeleteItemsLiveRequestItemsItem: - properties: - itemId: - type: string - docs: Unique identifier for the Item - cmsLocaleIds: - type: optional> - docs: Array of identifiers for the locales where the item will be created - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - Single CMS Item: - properties: - name: - type: string - docs: The name of the item. - slug: - type: string - docs: >- - URL slug for the item in your site. - - Note: Updating the item slug will break all links referencing the old - slug. - extra-properties: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - CreateBulkCollectionItemRequestBodyFieldDataItem: - docs: A single CMS item to create - properties: - name: - type: string - docs: The name of the item. - slug: - type: string - docs: >- - URL slug for the item in your site. - - Note: Updating the item slug will break all links referencing the old - slug. - extra-properties: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - CreateBulkCollectionItemRequestBodyFieldData: - discriminated: false - union: - - Single CMS Item - - docs: A list of CMS items to create - type: list - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - ItemsPublishItemResponse: - properties: - publishedItemIds: optional> - errors: optional> - source: - openapi: ../../../openapi/referenced-specs/v2.yml -imports: - root: ../__package__.yml -service: - auth: false - base-path: '' - endpoints: - list-items: - path: /collections/{collection_id}/items - method: GET - auth: true - docs: | - List of all Items within a Collection. - - Required scope | `CMS:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - display-name: List Collection Items - request: - name: ItemsListItemsRequest - query-parameters: - cmsLocaleId: - type: optional - docs: >- - Unique identifier for a CMS Locale. This UID is different from the - Site locale identifier and is listed as `cmsLocaleId` in the Sites - response. To query multiple locales, input a comma separated - string. - offset: - type: optional - docs: >- - Offset used for pagination if the results have more than limit - records - limit: - type: optional - docs: 'Maximum number of records to be returned (max limit: 100)' - name: - type: optional - docs: The name of the item(s) - slug: - type: optional - docs: The slug of the item - sortBy: - type: optional - docs: Sort results by the provided value - sortOrder: - type: optional - docs: Sorts the results by asc or desc - response: - docs: Request was successful - type: root.CollectionItemList - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - response: - body: - items: - - id: 62b720ef280c7a7a3be8cabe - cmsLocaleId: 66f6e966c9e1dc700a857ca3 - lastPublished: '2022-06-30T13:35:20.878Z' - lastUpdated: '2022-06-25T14:51:27.809Z' - createdOn: '2022-06-25T14:51:27.809Z' - isArchived: false - isDraft: false - fieldData: - name: Senior Data Analyst - slug: senior-data-analyst - url: https://boards.greenhouse.io/webflow/jobs/26567701 - department: Data - - id: 62c880ef281c7b7b4cf9dabc - cmsLocaleId: 66f6e966c9e1dc700a857ca3 - lastPublished: '2023-04-15T10:25:18.123Z' - lastUpdated: '2023-04-10T11:45:30.567Z' - createdOn: '2023-04-10T11:45:30.567Z' - isArchived: false - isDraft: false - fieldData: - name: Product Manager - slug: product-manager - url: https://boards.greenhouse.io/webflow/jobs/31234567 - department: Product - pagination: - limit: 25 - offset: 0 - total: 2 - create-item: - path: /collections/{collection_id}/items - method: POST - auth: true - docs: > - Create Item(s) in a Collection. - - - - To create items across multiple locales, please use [this - endpoint.](/v2.0.0/data/reference/cms/collection-items/staged-items/create-items) - - - Required scope | `CMS:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - display-name: Create Collection Item(s) - request: - body: ItemsCreateItemRequest - content-type: application/json - response: - docs: Request was successful - type: root.CollectionItem - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - name: SingleItem - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - request: - isArchived: false - isDraft: false - fieldData: - name: Pan Galactic Gargle Blaster Recipe - slug: pan-galactic-gargle-blaster - date: '2022-11-18T00:00:00.000Z' - featured: true - color: '#db4b68' - response: - body: - id: 42b720ef280c7a7a3be8cabe - cmsLocaleId: 653ad57de882f528b32e810e - lastPublished: '2022-11-29T16:22:43.159Z' - lastUpdated: '2022-11-17T17:19:43.282Z' - createdOn: '2022-11-17T17:11:57.148Z' - isArchived: false - isDraft: false - fieldData: - name: Pan Galactic Gargle Blaster Recipe - slug: pan-galactic-gargle-blaster - color: '#db4b68' - date: '2022-11-18T00:00:00.000Z' - featured: true - - name: MultipleItems - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - request: - items: - - isArchived: false - isDraft: false - fieldData: - name: Senior Data Analyst - slug: senior-data-analyst - url: https://boards.greenhouse.io/webflow/jobs/26567701 - department: Data - - isArchived: false - isDraft: false - fieldData: - name: Product Manager - slug: product-manager - url: https://boards.greenhouse.io/webflow/jobs/31234567 - department: Product - response: - body: - id: id - cmsLocaleId: 653ad57de882f528b32e810e - lastPublished: '2023-03-17T18:47:35.560Z' - lastUpdated: '2023-03-17T18:47:35.560Z' - createdOn: '2023-03-17T18:47:35.560Z' - isArchived: true - isDraft: true - fieldData: - name: My new item - slug: my-new-item - date: '2022-11-18T00:00:00.000Z' - featured: false - color: '#db4b68' - delete-items: - path: /collections/{collection_id}/items - method: DELETE - auth: true - docs: > - Delete Items from a Collection. - - - **Note:** If the `cmsLocaleId` parameter is undefined or empty and the - items are localized, items will be deleted only in the primary locale. - - - Required scope | `CMS:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - display-name: Delete Collection Items - request: - name: ItemsDeleteItemsRequest - body: - properties: - items: optional> - content-type: application/json - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.ConflictError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - request: {} - update-items: - path: /collections/{collection_id}/items - method: PATCH - auth: true - docs: > - Update a single item or multiple items (up to 100) in a Collection. - - - **Note:** If the `cmsLocaleId` parameter is undefined or empty and the - items are localized, items will be updated only in the primary locale. - - - Required scope | `CMS:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - display-name: Update Collection Items - request: - name: ItemsUpdateItemsRequest - body: - properties: - items: optional> - content-type: application/json - response: - docs: Request was successful - type: root.CollectionItem - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - name: LocalizedItems - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - request: - items: - - id: 66f6ed9576ddacf3149d5ea6 - cmsLocaleId: 66f6e966c9e1dc700a857ca5 - fieldData: - name: Ne Paniquez Pas - slug: ne-paniquez-pas - featured: false - - id: 66f6ed9576ddacf3149d5ea6 - cmsLocaleId: 66f6e966c9e1dc700a857ca4 - fieldData: - name: No Entrar en Pánico - slug: no-entrar-en-panico - featured: false - - id: 66f6ed9576ddacf3149d5eaa - cmsLocaleId: 66f6e966c9e1dc700a857ca5 - fieldData: - name: Au Revoir et Merci pour Tous les Poissons - slug: au-revoir-et-merci - featured: false - - id: 66f6ed9576ddacf3149d5eaa - cmsLocaleId: 66f6e966c9e1dc700a857ca4 - fieldData: - name: Hasta Luego y Gracias por Todo el Pescado - slug: hasta-luego-y-gracias - featured: false - response: - body: - id: id - cmsLocaleId: 653ad57de882f528b32e810e - lastPublished: '2023-03-17T18:47:35.560Z' - lastUpdated: '2023-03-17T18:47:35.560Z' - createdOn: '2023-03-17T18:47:35.560Z' - isArchived: true - isDraft: true - fieldData: - name: My new item - slug: my-new-item - date: '2022-11-18T00:00:00.000Z' - featured: false - color: '#db4b68' - - name: MultipleItems - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - request: - items: - - id: 580e64008c9a982ac9b8b754 - isArchived: false - isDraft: false - fieldData: - name: Senior Data Analyst - slug: senior-data-analyst - url: https://boards.greenhouse.io/webflow/jobs/26567701 - department: Data - - id: 580e64008c9a982ac9b8b754 - isArchived: false - isDraft: false - fieldData: - name: Product Manager - slug: product-manager - url: https://boards.greenhouse.io/webflow/jobs/31234567 - department: Product - response: - body: - id: id - cmsLocaleId: 653ad57de882f528b32e810e - lastPublished: '2023-03-17T18:47:35.560Z' - lastUpdated: '2023-03-17T18:47:35.560Z' - createdOn: '2023-03-17T18:47:35.560Z' - isArchived: true - isDraft: true - fieldData: - name: My new item - slug: my-new-item - date: '2022-11-18T00:00:00.000Z' - featured: false - color: '#db4b68' - - name: Multiple items updated across multiple locales - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - request: - items: - - id: 66f6ed9576ddacf3149d5ea6 - cmsLocaleId: 66f6e966c9e1dc700a857ca5 - fieldData: - name: Ne Paniquez Pas - slug: ne-paniquez-pas - featured: false - - id: 66f6ed9576ddacf3149d5ea6 - cmsLocaleId: 66f6e966c9e1dc700a857ca4 - fieldData: - name: No Entrar en Pánico - slug: no-entrar-en-panico - featured: false - - id: 66f6ed9576ddacf3149d5eaa - cmsLocaleId: 66f6e966c9e1dc700a857ca5 - fieldData: - name: Au Revoir et Merci pour Tous les Poissons - slug: au-revoir-et-merci - featured: false - - id: 66f6ed9576ddacf3149d5eaa - cmsLocaleId: 66f6e966c9e1dc700a857ca4 - fieldData: - name: Hasta Luego y Gracias por Todo el Pescado - slug: hasta-luego-y-gracias - featured: false - response: - body: - id: id - cmsLocaleId: 653ad57de882f528b32e810e - lastPublished: '2023-03-17T18:47:35.560Z' - lastUpdated: '2023-03-17T18:47:35.560Z' - createdOn: '2023-03-17T18:47:35.560Z' - isArchived: true - isDraft: true - fieldData: - name: My new item - slug: my-new-item - date: '2022-11-18T00:00:00.000Z' - featured: false - color: '#db4b68' - - name: Mulitple items updated in a single locale - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - request: - items: - - id: 66f6ed9576ddacf3149d5ea6 - cmsLocaleId: 66f6e966c9e1dc700a857ca5 - fieldData: - name: Ne Paniquez Pas - slug: ne-paniquez-pas - featured: false - - id: 66f6ed9576ddacf3149d5ea6 - cmsLocaleId: 66f6e966c9e1dc700a857ca4 - fieldData: - name: No Entrar en Pánico - slug: no-entrar-en-panico - featured: false - - id: 66f6ed9576ddacf3149d5eaa - cmsLocaleId: 66f6e966c9e1dc700a857ca5 - fieldData: - name: Au Revoir et Merci pour Tous les Poissons - slug: au-revoir-et-merci - featured: false - - id: 66f6ed9576ddacf3149d5eaa - cmsLocaleId: 66f6e966c9e1dc700a857ca4 - fieldData: - name: Hasta Luego y Gracias por Todo el Pescado - slug: hasta-luego-y-gracias - featured: false - response: - body: - id: id - cmsLocaleId: 653ad57de882f528b32e810e - lastPublished: '2023-03-17T18:47:35.560Z' - lastUpdated: '2023-03-17T18:47:35.560Z' - createdOn: '2023-03-17T18:47:35.560Z' - isArchived: true - isDraft: true - fieldData: - name: My new item - slug: my-new-item - date: '2022-11-18T00:00:00.000Z' - featured: false - color: '#db4b68' - list-items-live: - path: /collections/{collection_id}/items/live - method: GET - auth: true - docs: | - List of all live Items within a Collection. - - Required scope | `CMS:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - display-name: List Live Collection Items - request: - name: ItemsListItemsLiveRequest - query-parameters: - cmsLocaleId: - type: optional - docs: >- - Unique identifier for a CMS Locale. This UID is different from the - Site locale identifier and is listed as `cmsLocaleId` in the Sites - response. To query multiple locales, input a comma separated - string. - offset: - type: optional - docs: >- - Offset used for pagination if the results have more than limit - records - limit: - type: optional - docs: 'Maximum number of records to be returned (max limit: 100)' - name: - type: optional - docs: The name of the item(s) - slug: - type: optional - docs: The slug of the item - sortBy: - type: optional - docs: Sort results by the provided value - sortOrder: - type: optional - docs: Sorts the results by asc or desc - response: - docs: Request was successful - type: root.CollectionItemList - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - response: - body: - items: - - id: 62b720ef280c7a7a3be8cabe - cmsLocaleId: 66f6e966c9e1dc700a857ca3 - lastPublished: '2022-06-30T13:35:20.878Z' - lastUpdated: '2022-06-25T14:51:27.809Z' - createdOn: '2022-06-25T14:51:27.809Z' - isArchived: false - isDraft: false - fieldData: - name: Senior Data Analyst - slug: senior-data-analyst - url: https://boards.greenhouse.io/webflow/jobs/26567701 - department: Data - - id: 62c880ef281c7b7b4cf9dabc - cmsLocaleId: 66f6e966c9e1dc700a857ca3 - lastPublished: '2023-04-15T10:25:18.123Z' - lastUpdated: '2023-04-10T11:45:30.567Z' - createdOn: '2023-04-10T11:45:30.567Z' - isArchived: false - isDraft: false - fieldData: - name: Product Manager - slug: product-manager - url: https://boards.greenhouse.io/webflow/jobs/31234567 - department: Product - pagination: - limit: 25 - offset: 0 - total: 2 - create-item-live: - path: /collections/{collection_id}/items/live - method: POST - auth: true - docs: > - Create live Item(s) in a Collection. The Item(s) will be published to - the live site. - - - - To create items across multiple locales, [please use this - endpoint.](/v2.0.0/data/reference/cms/collection-items/staged-items/create-items) - - - - Required scope | `CMS:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - display-name: Create Live Collection Item(s) - request: - body: ItemsCreateItemLiveRequest - content-type: application/json - response: - docs: Request was successful - type: root.CollectionItem - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - name: SingleItem - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - request: - isArchived: false - isDraft: false - fieldData: - name: Pan Galactic Gargle Blaster Recipe - slug: pan-galactic-gargle-blaster - date: '2022-11-18T00:00:00.000Z' - featured: true - color: '#db4b68' - response: - body: - id: 42b720ef280c7a7a3be8cabe - cmsLocaleId: 653ad57de882f528b32e810e - lastPublished: '2022-11-29T16:22:43.159Z' - lastUpdated: '2022-11-17T17:19:43.282Z' - createdOn: '2022-11-17T17:11:57.148Z' - isArchived: false - isDraft: false - fieldData: - name: Pan Galactic Gargle Blaster Recipe - slug: pan-galactic-gargle-blaster - color: '#db4b68' - date: '2022-11-18T00:00:00.000Z' - featured: true - - name: MultipleItems - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - request: - items: - - isArchived: false - isDraft: false - fieldData: - name: Senior Data Analyst - slug: senior-data-analyst - url: https://boards.greenhouse.io/webflow/jobs/26567701 - department: Data - - isArchived: false - isDraft: false - fieldData: - name: Product Manager - slug: product-manager - url: https://boards.greenhouse.io/webflow/jobs/31234567 - department: Product - response: - body: - id: 42b720ef280c7a7a3be8cabe - cmsLocaleId: 653ad57de882f528b32e810e - lastPublished: '2022-11-29T16:22:43.159Z' - lastUpdated: '2022-11-17T17:19:43.282Z' - createdOn: '2022-11-17T17:11:57.148Z' - isArchived: false - isDraft: false - fieldData: - name: Pan Galactic Gargle Blaster Recipe - slug: pan-galactic-gargle-blaster - color: '#db4b68' - date: '2022-11-18T00:00:00.000Z' - featured: true - delete-items-live: - path: /collections/{collection_id}/items/live - method: DELETE - auth: true - docs: > - Remove an item or multiple items (up to 100 items) from the live site. - Deleting published items will unpublish the items from the live site and - set them to draft. - - - **Note:** If the `cmsLocaleId` parameter is undefined or empty and the - items are localized, items will be unpublished only in the primary - locale. - - - Required scope | `CMS:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - display-name: Delete Live Collection Items - request: - name: ItemsDeleteItemsLiveRequest - body: - properties: - items: optional> - content-type: application/json - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - request: {} - update-items-live: - path: /collections/{collection_id}/items/live - method: PATCH - auth: true - docs: > - Update a single live item or multiple live items (up to 100) in a - Collection - - - **Note:** If the `cmsLocaleId` parameter is undefined or empty and the - items are localized, items will be updated only in the primary locale. - - - Required scope | `CMS:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - display-name: Update Live Collection Items - request: - name: ItemsUpdateItemsLiveRequest - body: - properties: - items: optional> - content-type: application/json - response: - docs: Request was successful - type: root.CollectionItemListNoPagination - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - name: LocalizedItems - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - request: - items: - - id: 66f6ed9576ddacf3149d5ea6 - cmsLocaleId: 66f6e966c9e1dc700a857ca5 - fieldData: - name: Ne Paniquez Pas - slug: ne-paniquez-pas - featured: false - - id: 66f6ed9576ddacf3149d5ea6 - cmsLocaleId: 66f6e966c9e1dc700a857ca4 - fieldData: - name: No Entrar en Pánico - slug: no-entrar-en-panico - featured: false - - id: 66f6ed9576ddacf3149d5eaa - cmsLocaleId: 66f6e966c9e1dc700a857ca5 - fieldData: - name: Au Revoir et Merci pour Tous les Poissons - slug: au-revoir-et-merci - featured: false - - id: 66f6ed9576ddacf3149d5eaa - cmsLocaleId: 66f6e966c9e1dc700a857ca4 - fieldData: - name: Hasta Luego y Gracias por Todo el Pescado - slug: hasta-luego-y-gracias - featured: false - response: - body: - items: - - id: 66f6ed9576ddacf3149d5ea6 - cmsLocaleId: 66f6e966c9e1dc700a857ca5 - lastPublished: '2023-03-17T18:47:35.560Z' - lastUpdated: '2024-09-27T17:38:29.066Z' - createdOn: '2024-09-27T17:38:29.066Z' - isArchived: true - isDraft: true - fieldData: - name: Ne Paniquez Pas - slug: ne-paniquez-pas - featured: false - - id: 66f6ed9576ddacf3149d5ea6 - cmsLocaleId: 66f6e966c9e1dc700a857ca4 - lastPublished: '2023-03-17T18:47:35.560Z' - lastUpdated: '2024-09-27T17:38:29.066Z' - createdOn: '2024-09-27T17:38:29.066Z' - isArchived: true - isDraft: true - fieldData: - name: No Entrar en Pánico - slug: no-entrar-en-panico - featured: false - - id: 66f6ed9576ddacf3149d5eaa - cmsLocaleId: 66f6e966c9e1dc700a857ca5 - lastPublished: '2023-03-17T18:47:35.560Z' - lastUpdated: '2024-09-27T17:38:29.066Z' - createdOn: '2024-09-27T17:38:29.066Z' - isArchived: true - isDraft: true - fieldData: - name: Au Revoir et Merci pour Tous les Poissons - slug: au-revoir-et-merci - featured: false - - id: 66f6ed9576ddacf3149d5eaa - cmsLocaleId: 66f6e966c9e1dc700a857ca4 - lastPublished: '2023-03-17T18:47:35.560Z' - lastUpdated: '2024-09-27T17:38:29.066Z' - createdOn: '2024-09-27T17:38:29.066Z' - isArchived: true - isDraft: true - fieldData: - name: Hasta Luego y Gracias por Todo el Pescado - slug: hasta-luego-y-gracias - featured: false - - name: MultipleItems - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - request: - items: - - id: 580e64008c9a982ac9b8b754 - isArchived: false - isDraft: false - fieldData: - name: Senior Data Analyst - slug: senior-data-analyst - url: https://boards.greenhouse.io/webflow/jobs/26567701 - department: Data - - id: 580e64008c9a982ac9b8b754 - isArchived: false - isDraft: false - fieldData: - name: Product Manager - slug: product-manager - url: https://boards.greenhouse.io/webflow/jobs/31234567 - department: Product - response: - body: - items: - - id: 66f6ed9576ddacf3149d5ea6 - cmsLocaleId: 66f6e966c9e1dc700a857ca5 - lastPublished: '2023-03-17T18:47:35.560Z' - lastUpdated: '2024-09-27T17:38:29.066Z' - createdOn: '2024-09-27T17:38:29.066Z' - isArchived: true - isDraft: true - fieldData: - name: Ne Paniquez Pas - slug: ne-paniquez-pas - featured: false - - id: 66f6ed9576ddacf3149d5ea6 - cmsLocaleId: 66f6e966c9e1dc700a857ca4 - lastPublished: '2023-03-17T18:47:35.560Z' - lastUpdated: '2024-09-27T17:38:29.066Z' - createdOn: '2024-09-27T17:38:29.066Z' - isArchived: true - isDraft: true - fieldData: - name: No Entrar en Pánico - slug: no-entrar-en-panico - featured: false - - id: 66f6ed9576ddacf3149d5eaa - cmsLocaleId: 66f6e966c9e1dc700a857ca5 - lastPublished: '2023-03-17T18:47:35.560Z' - lastUpdated: '2024-09-27T17:38:29.066Z' - createdOn: '2024-09-27T17:38:29.066Z' - isArchived: true - isDraft: true - fieldData: - name: Au Revoir et Merci pour Tous les Poissons - slug: au-revoir-et-merci - featured: false - - id: 66f6ed9576ddacf3149d5eaa - cmsLocaleId: 66f6e966c9e1dc700a857ca4 - lastPublished: '2023-03-17T18:47:35.560Z' - lastUpdated: '2024-09-27T17:38:29.066Z' - createdOn: '2024-09-27T17:38:29.066Z' - isArchived: true - isDraft: true - fieldData: - name: Hasta Luego y Gracias por Todo el Pescado - slug: hasta-luego-y-gracias - featured: false - - name: Multiple items updated across multiple locales - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - request: - items: - - id: 66f6ed9576ddacf3149d5ea6 - cmsLocaleId: 66f6e966c9e1dc700a857ca5 - fieldData: - name: Ne Paniquez Pas - slug: ne-paniquez-pas - featured: false - - id: 66f6ed9576ddacf3149d5ea6 - cmsLocaleId: 66f6e966c9e1dc700a857ca4 - fieldData: - name: No Entrar en Pánico - slug: no-entrar-en-panico - featured: false - - id: 66f6ed9576ddacf3149d5eaa - cmsLocaleId: 66f6e966c9e1dc700a857ca5 - fieldData: - name: Au Revoir et Merci pour Tous les Poissons - slug: au-revoir-et-merci - featured: false - - id: 66f6ed9576ddacf3149d5eaa - cmsLocaleId: 66f6e966c9e1dc700a857ca4 - fieldData: - name: Hasta Luego y Gracias por Todo el Pescado - slug: hasta-luego-y-gracias - featured: false - response: - body: - items: - - id: 66f6ed9576ddacf3149d5ea6 - cmsLocaleId: 66f6e966c9e1dc700a857ca5 - lastPublished: '2023-03-17T18:47:35.560Z' - lastUpdated: '2024-09-27T17:38:29.066Z' - createdOn: '2024-09-27T17:38:29.066Z' - isArchived: true - isDraft: true - fieldData: - name: Ne Paniquez Pas - slug: ne-paniquez-pas - featured: false - - id: 66f6ed9576ddacf3149d5ea6 - cmsLocaleId: 66f6e966c9e1dc700a857ca4 - lastPublished: '2023-03-17T18:47:35.560Z' - lastUpdated: '2024-09-27T17:38:29.066Z' - createdOn: '2024-09-27T17:38:29.066Z' - isArchived: true - isDraft: true - fieldData: - name: No Entrar en Pánico - slug: no-entrar-en-panico - featured: false - - id: 66f6ed9576ddacf3149d5eaa - cmsLocaleId: 66f6e966c9e1dc700a857ca5 - lastPublished: '2023-03-17T18:47:35.560Z' - lastUpdated: '2024-09-27T17:38:29.066Z' - createdOn: '2024-09-27T17:38:29.066Z' - isArchived: true - isDraft: true - fieldData: - name: Au Revoir et Merci pour Tous les Poissons - slug: au-revoir-et-merci - featured: false - - id: 66f6ed9576ddacf3149d5eaa - cmsLocaleId: 66f6e966c9e1dc700a857ca4 - lastPublished: '2023-03-17T18:47:35.560Z' - lastUpdated: '2024-09-27T17:38:29.066Z' - createdOn: '2024-09-27T17:38:29.066Z' - isArchived: true - isDraft: true - fieldData: - name: Hasta Luego y Gracias por Todo el Pescado - slug: hasta-luego-y-gracias - featured: false - - name: Mulitple items updated in a single locale - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - request: - items: - - id: 66f6ed9576ddacf3149d5ea6 - cmsLocaleId: 66f6e966c9e1dc700a857ca5 - fieldData: - name: Ne Paniquez Pas - slug: ne-paniquez-pas - featured: false - - id: 66f6ed9576ddacf3149d5ea6 - cmsLocaleId: 66f6e966c9e1dc700a857ca4 - fieldData: - name: No Entrar en Pánico - slug: no-entrar-en-panico - featured: false - - id: 66f6ed9576ddacf3149d5eaa - cmsLocaleId: 66f6e966c9e1dc700a857ca5 - fieldData: - name: Au Revoir et Merci pour Tous les Poissons - slug: au-revoir-et-merci - featured: false - - id: 66f6ed9576ddacf3149d5eaa - cmsLocaleId: 66f6e966c9e1dc700a857ca4 - fieldData: - name: Hasta Luego y Gracias por Todo el Pescado - slug: hasta-luego-y-gracias - featured: false - response: - body: - items: - - id: 62b720ef280c7a7a3be8cabe - cmsLocaleId: 66f6e966c9e1dc700a857ca3 - lastPublished: '2022-06-30T13:35:20.878Z' - lastUpdated: '2022-06-25T14:51:27.809Z' - createdOn: '2022-06-25T14:51:27.809Z' - isArchived: false - isDraft: false - fieldData: - name: Senior Data Analyst - slug: senior-data-analyst - url: https://boards.greenhouse.io/webflow/jobs/26567701 - department: Data - - id: 62c880ef281c7b7b4cf9dabc - cmsLocaleId: 66f6e966c9e1dc700a857ca3 - lastPublished: '2023-04-15T10:25:18.123Z' - lastUpdated: '2023-04-10T11:45:30.567Z' - createdOn: '2023-04-10T11:45:30.567Z' - isArchived: false - isDraft: false - fieldData: - name: Product Manager - slug: product-manager - url: https://boards.greenhouse.io/webflow/jobs/31234567 - department: Product - create-items: - path: /collections/{collection_id}/items/bulk - method: POST - auth: true - docs: > - Create an item or multiple items in a CMS Collection across multiple - corresponding locales. - - - **Notes:** - - This endpoint can create up to 100 items in a request. - - If the `cmsLocaleIds` parameter is undefined or empty and localization is enabled, items will only be created in the primary locale. - - Required scope | `CMS:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - display-name: Create Collection Items - request: - name: CreateBulkCollectionItemRequestBody - body: - properties: - cmsLocaleIds: - type: optional> - docs: >- - Array of identifiers for the locales where the item will be - created - isArchived: - type: optional - docs: Indicates whether the item is archived. - default: false - isDraft: - type: optional - docs: Indicates whether the item is in draft state. - default: false - fieldData: CreateBulkCollectionItemRequestBodyFieldData - content-type: application/json - response: - docs: Request was successful - type: root.BulkCollectionItem - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - name: Create a single item across multiple locales - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - request: - cmsLocaleIds: - - 66f6e966c9e1dc700a857ca3 - - 66f6e966c9e1dc700a857ca4 - - 66f6e966c9e1dc700a857ca5 - isArchived: false - isDraft: false - fieldData: - name: Don’t Panic - slug: dont-panic - response: - body: - id: 580e64008c9a982ac9b8b754 - cmsLocaleIds: - - 653ad57de882f528b32e810e - - 6514390aea353fc691d69827 - - 65143930ea353fc691d69cd8 - lastPublished: '2023-03-17T18:47:35.560Z' - lastUpdated: '2023-03-17T18:47:35.560Z' - createdOn: '2023-03-17T18:47:35.560Z' - isArchived: true - isDraft: true - fieldData: - name: My new item - slug: my-new-item - date: '2022-11-18T00:00:00.000Z' - featured: false - color: '#db4b68' - - name: Create multiple items across multipel locales - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - request: - cmsLocaleIds: - - 66f6e966c9e1dc700a857ca3 - - 66f6e966c9e1dc700a857ca4 - isArchived: false - isDraft: false - fieldData: - - name: Don’t Panic - slug: dont-panic - - name: So Long and Thanks for All the Fish - slug: so-long-and-thanks - response: - body: - id: 580e64008c9a982ac9b8b754 - cmsLocaleIds: - - 653ad57de882f528b32e810e - - 6514390aea353fc691d69827 - - 65143930ea353fc691d69cd8 - lastPublished: '2023-03-17T18:47:35.560Z' - lastUpdated: '2023-03-17T18:47:35.560Z' - createdOn: '2023-03-17T18:47:35.560Z' - isArchived: true - isDraft: true - fieldData: - name: My new item - slug: my-new-item - date: '2022-11-18T00:00:00.000Z' - featured: false - color: '#db4b68' - - name: Single item created across multiple locales - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - request: - cmsLocaleIds: - - 66f6e966c9e1dc700a857ca3 - - 66f6e966c9e1dc700a857ca4 - - 66f6e966c9e1dc700a857ca5 - isArchived: false - isDraft: false - fieldData: - name: Don’t Panic - slug: dont-panic - response: - body: - id: 580e64008c9a982ac9b8b754 - cmsLocaleIds: - - 653ad57de882f528b32e810e - - 6514390aea353fc691d69827 - - 65143930ea353fc691d69cd8 - lastPublished: '2023-03-17T18:47:35.560Z' - lastUpdated: '2023-03-17T18:47:35.560Z' - createdOn: '2023-03-17T18:47:35.560Z' - isArchived: true - isDraft: true - fieldData: - name: My new item - slug: my-new-item - date: '2022-11-18T00:00:00.000Z' - featured: false - color: '#db4b68' - - name: Multiple items created across multiple locales - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - request: - cmsLocaleIds: - - 66f6e966c9e1dc700a857ca3 - - 66f6e966c9e1dc700a857ca4 - - 66f6e966c9e1dc700a857ca5 - isArchived: false - isDraft: false - fieldData: - name: Don’t Panic - slug: dont-panic - response: - body: - id: 580e64008c9a982ac9b8b754 - cmsLocaleIds: - - 653ad57de882f528b32e810e - - 6514390aea353fc691d69827 - - 65143930ea353fc691d69cd8 - lastPublished: '2023-03-17T18:47:35.560Z' - lastUpdated: '2023-03-17T18:47:35.560Z' - createdOn: '2023-03-17T18:47:35.560Z' - isArchived: true - isDraft: true - fieldData: - name: My new item - slug: my-new-item - date: '2022-11-18T00:00:00.000Z' - featured: false - color: '#db4b68' - get-item: - path: /collections/{collection_id}/items/{item_id} - method: GET - auth: true - docs: | - Get details of a selected Collection Item. - - Required scope | `CMS:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - item_id: - type: string - docs: Unique identifier for an Item - display-name: Get Collection Item - request: - name: ItemsGetItemRequest - query-parameters: - cmsLocaleId: - type: optional - docs: >- - Unique identifier for a CMS Locale. This UID is different from the - Site locale identifier and is listed as `cmsLocaleId` in the Sites - response. To query multiple locales, input a comma separated - string. - response: - docs: Request was successful - type: root.CollectionItem - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - item_id: 580e64008c9a982ac9b8b754 - response: - body: - id: 42b720ef280c7a7a3be8cabe - cmsLocaleId: 653ad57de882f528b32e810e - lastPublished: '2022-11-29T16:22:43.159Z' - lastUpdated: '2022-11-17T17:19:43.282Z' - createdOn: '2022-11-17T17:11:57.148Z' - isArchived: false - isDraft: false - fieldData: - name: Pan Galactic Gargle Blaster Recipe - slug: pan-galactic-gargle-blaster - color: '#db4b68' - date: '2022-11-18T00:00:00.000Z' - featured: true - delete-item: - path: /collections/{collection_id}/items/{item_id} - method: DELETE - auth: true - docs: > - Delete an Item from a Collection. This endpoint does not currently - support bulk deletion. - - - Required scope | `CMS:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - item_id: - type: string - docs: Unique identifier for an Item - display-name: Delete Collection Item - request: - name: ItemsDeleteItemRequest - query-parameters: - cmsLocaleId: - type: optional - docs: >- - Unique identifier for a CMS Locale. This UID is different from the - Site locale identifier and is listed as `cmsLocaleId` in the Sites - response. To query multiple locales, input a comma separated - string. - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - item_id: 580e64008c9a982ac9b8b754 - update-item: - path: /collections/{collection_id}/items/{item_id} - method: PATCH - auth: true - docs: | - Update a selected Item in a Collection. - - Required scope | `CMS:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - item_id: - type: string - docs: Unique identifier for an Item - display-name: Update Collection Item - request: - body: root.CollectionItemPatchSingle - content-type: application/json - response: - docs: Request was successful - type: root.CollectionItem - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - item_id: 580e64008c9a982ac9b8b754 - request: - isArchived: false - isDraft: false - fieldData: - name: Pan Galactic Gargle Blaster Recipe - slug: pan-galactic-gargle-blaster - date: '2022-11-18T00:00:00.000Z' - featured: true - color: '#db4b68' - response: - body: - id: 42b720ef280c7a7a3be8cabe - cmsLocaleId: 653ad57de882f528b32e810e - lastPublished: '2022-11-29T16:22:43.159Z' - lastUpdated: '2022-11-17T17:19:43.282Z' - createdOn: '2022-11-17T17:11:57.148Z' - isArchived: false - isDraft: false - fieldData: - name: Pan Galactic Gargle Blaster Recipe - slug: pan-galactic-gargle-blaster - color: '#db4b68' - date: '2022-11-18T00:00:00.000Z' - featured: true - get-item-live: - path: /collections/{collection_id}/items/{item_id}/live - method: GET - auth: true - docs: | - Get details of a selected Collection live Item. - - Required scope | `CMS:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - item_id: - type: string - docs: Unique identifier for an Item - display-name: Get Live Collection Item - request: - name: ItemsGetItemLiveRequest - query-parameters: - cmsLocaleId: - type: optional - docs: >- - Unique identifier for a CMS Locale. This UID is different from the - Site locale identifier and is listed as `cmsLocaleId` in the Sites - response. To query multiple locales, input a comma separated - string. - response: - docs: Request was successful - type: root.CollectionItem - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - item_id: 580e64008c9a982ac9b8b754 - response: - body: - id: 42b720ef280c7a7a3be8cabe - cmsLocaleId: 653ad57de882f528b32e810e - lastPublished: '2022-11-29T16:22:43.159Z' - lastUpdated: '2022-11-17T17:19:43.282Z' - createdOn: '2022-11-17T17:11:57.148Z' - isArchived: false - isDraft: false - fieldData: - name: Pan Galactic Gargle Blaster Recipe - slug: pan-galactic-gargle-blaster - color: '#db4b68' - date: '2022-11-18T00:00:00.000Z' - featured: true - delete-item-live: - path: /collections/{collection_id}/items/{item_id}/live - method: DELETE - auth: true - docs: > - Remove a live item from the site. Removing a published item will - unpublish the item from the live site and set it to draft. - - - This endpoint does not currently support bulk deletion. - - - Required scope | `CMS:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - item_id: - type: string - docs: Unique identifier for an Item - display-name: Delete Live Collection Item - request: - name: ItemsDeleteItemLiveRequest - query-parameters: - cmsLocaleId: - type: optional - docs: >- - Unique identifier for a CMS Locale. This UID is different from the - Site locale identifier and is listed as `cmsLocaleId` in the Sites - response. To query multiple locales, input a comma separated - string. - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - item_id: 580e64008c9a982ac9b8b754 - update-item-live: - path: /collections/{collection_id}/items/{item_id}/live - method: PATCH - auth: true - docs: > - Update a selected live Item in a Collection. The updates for this Item - will be published to the live site. - - - Required scope | `CMS:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - item_id: - type: string - docs: Unique identifier for an Item - display-name: Update Live Collection Item - request: - body: root.CollectionItemPatchSingle - content-type: application/json - response: - docs: Request was successful - type: root.CollectionItem - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - item_id: 580e64008c9a982ac9b8b754 - request: - isArchived: false - isDraft: false - fieldData: - name: Pan Galactic Gargle Blaster Recipe - slug: pan-galactic-gargle-blaster - date: '2022-11-18T00:00:00.000Z' - featured: true - color: '#db4b68' - response: - body: - id: 42b720ef280c7a7a3be8cabe - cmsLocaleId: 653ad57de882f528b32e810e - lastPublished: '2022-11-29T16:22:43.159Z' - lastUpdated: '2022-11-17T17:19:43.282Z' - createdOn: '2022-11-17T17:11:57.148Z' - isArchived: false - isDraft: false - fieldData: - name: Pan Galactic Gargle Blaster Recipe - slug: pan-galactic-gargle-blaster - color: '#db4b68' - date: '2022-11-18T00:00:00.000Z' - featured: true - publish-item: - path: /collections/{collection_id}/items/publish - method: POST - auth: true - docs: | - Publish an item or multiple items. - - Required scope | `cms:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - display-name: Publish Collection Item - request: - name: ItemsPublishItemRequest - body: - properties: - itemIds: list - content-type: application/json - response: - docs: Request was successful - type: ItemsPublishItemResponse - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.ConflictError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - request: - itemIds: - - itemIds - response: - body: - publishedItemIds: - - 643fd856d66b6528195ee2ca - - 643fd856d66b6528195ee2cb - errors: - - Staging item ID 643fd856d66b6528195ee2cf not found. - source: - openapi: ../../../openapi/referenced-specs/v2.yml diff --git a/.mock/definition/components.yml b/.mock/definition/components.yml deleted file mode 100644 index b9eb7d6..0000000 --- a/.mock/definition/components.yml +++ /dev/null @@ -1,486 +0,0 @@ -imports: - root: __package__.yml -service: - auth: false - base-path: '' - endpoints: - list: - path: /sites/{site_id}/components - method: GET - auth: true - docs: | - List of all components for a site. - - Required scope | `components:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: List Components - request: - name: ComponentsListRequest - query-parameters: - limit: - type: optional - docs: 'Maximum number of records to be returned (max limit: 100)' - offset: - type: optional - docs: >- - Offset used for pagination if the results have more than limit - records - response: - docs: Request was successful - type: root.ComponentList - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - response: - body: - components: - - id: 6596da6045e56dee495bcbba - name: Primary Button - group: Buttons - description: A default button component that can be used across the site - readonly: true - - id: 658205daa3e8206a523b5ad4 - name: Secondary Button - group: Buttons - description: >- - A secondary button component that can be used across the - site - readonly: true - - id: 6258612d1ee792848f805dcf - name: Card - group: Buttons - description: A button component that can be used across the site - readonly: true - - id: 68a2b1d1ee792848f805dcf - name: Nav - group: Buttons - description: A button component that can be used across the site - readonly: true - pagination: - limit: 20 - offset: 0 - total: 4 - get-content: - path: /sites/{site_id}/components/{component_id}/dom - method: GET - auth: true - docs: > - Get static content from a component definition. This includes text - nodes, image nodes and nested component instances. - - To retrieve dynamic content set by component properties, use the [get - component - properties](/data/reference/pages-and-components/components/get-properties) - endpoint. - - - If you do not provide a Locale ID in your request, the response - will return any content that can be localized from the Primary - locale. - - - Required scope | `components:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - component_id: - type: string - docs: Unique identifier for a Component - display-name: Get Component Content - request: - name: ComponentsGetContentRequest - query-parameters: - localeId: - type: optional - docs: >- - Unique identifier for a specific locale. Applicable, when using - localization. - limit: - type: optional - docs: 'Maximum number of records to be returned (max limit: 100)' - offset: - type: optional - docs: >- - Offset used for pagination if the results have more than limit - records - response: - docs: Request was successful - type: root.ComponentDom - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - name: ComponentDOM - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - component_id: 8505ba55-ef72-629e-f85c-33e4b703d48b - query-parameters: - localeId: 65427cf400e02b306eaa04a0 - response: - body: - componentId: 69118560-d0bc-15fc-bbf8-b8fe5f6535b5 - nodes: - - type: component-instance - id: a245c12d-995b-55ee-5ec7-aa36a6cad623 - componentId: nodes - propertyOverrides: - - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0 - - type: component-instance - id: a245c12d-995b-55ee-5ec7-aa36a6cad627 - componentId: nodes - propertyOverrides: - - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0 - - type: component-instance - id: a245c12d-995b-55ee-5ec7-aa36a6cad629 - componentId: nodes - propertyOverrides: - - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0 - - type: component-instance - id: a245c12d-995b-55ee-5ec7-aa36a6cad631 - componentId: 6258612d1ee792848f805dcf - propertyOverrides: - - propertyId: a245c12d-995b-55ee-5ec7-aa36a6cad633 - type: Plain Text - text: - text: Don't Panic! - - propertyId: a245c12d-995b-55ee-5ec7-aa36a6cad635 - type: Rich Text - text: - html:

Always know where your towel is.

- pagination: - limit: 4 - offset: 0 - total: 4 - - name: LocalizedComponentDOM - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - component_id: 8505ba55-ef72-629e-f85c-33e4b703d48b - query-parameters: - localeId: 65427cf400e02b306eaa04a0 - response: - body: - componentId: 69118560-d0bc-15fc-bbf8-b8fe5f6535b5 - nodes: - - type: component-instance - id: 69118560-d0bc-15fc-bbf8-b8fe5f6535b8 - componentId: nodes - propertyOverrides: - - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0 - - type: component-instance - id: 8ebfb409-7493-3bca-5d48-0e547befb960 - componentId: nodes - propertyOverrides: - - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0 - - type: component-instance - id: 69118560-d0bc-15fc-bbf8-b8fe5f6535c2 - componentId: 69118560-d0bc-15fc-bbf8-b8fe5f6535b5 - propertyOverrides: - - propertyId: a245c12d-995b-55ee-5ec7-aa36a6cad623 - pagination: - limit: 100 - offset: 0 - total: 3 - update-content: - path: /sites/{site_id}/components/{component_id}/dom - method: POST - auth: true - docs: > - This endpoint updates content within a component defintion for - **secondary locales**. It supports updating up to 1000 nodes in a single - request. - - - Before making updates: - - 1. Use the [get component - content](/data/reference/pages-and-components/components/get-content) - endpoint to identify available content nodes and their types - - 2. If your component definition has a component instance nested within - it, retrieve the nested component instance's properties that you'll - override using the [get component - properties](/data/reference/pages-and-components/components/get-properties) - endpoint - - - - This endpoint is specifically for localizing component definitions. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail. - - - - Required scope | `components:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - component_id: - type: string - docs: Unique identifier for a Component - display-name: Update Component Content - request: - name: ComponentDomWrite - query-parameters: - localeId: - type: optional - docs: >- - Unique identifier for a specific locale. Applicable, when using - localization. - body: - properties: - nodes: - docs: >- - List of DOM Nodes with the new content that will be updated in - each node. - type: list - content-type: application/json - response: - docs: Request was successful - type: ComponentsUpdateContentResponse - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - component_id: 8505ba55-ef72-629e-f85c-33e4b703d48b - query-parameters: - localeId: 65427cf400e02b306eaa04a0 - request: - nodes: - - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad623 - text:

The Hitchhiker's Guide to the Galaxy

- - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad627 - text: >- -

Don't Panic!

Always know where your towel - is.

- - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad629 - propertyOverrides: - - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0 - text:

Time is an illusion

- - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f1 - text: Life, the Universe and Everything - response: - body: - errors: - - errors - get-properties: - path: /sites/{site_id}/components/{component_id}/properties - method: GET - auth: true - docs: > - Get the property default values of a component definition. - - - If you do not provide a Locale ID in your request, the response - will return any properties that can be localized from the Primary - locale. - - - Required scope | `components:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - component_id: - type: string - docs: Unique identifier for a Component - display-name: Get Component Properties - request: - name: ComponentsGetPropertiesRequest - query-parameters: - localeId: - type: optional - docs: >- - Unique identifier for a specific locale. Applicable, when using - localization. - limit: - type: optional - docs: 'Maximum number of records to be returned (max limit: 100)' - offset: - type: optional - docs: >- - Offset used for pagination if the results have more than limit - records - response: - docs: Request was successful - type: root.ComponentProperties - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - component_id: 8505ba55-ef72-629e-f85c-33e4b703d48b - query-parameters: - localeId: 65427cf400e02b306eaa04a0 - response: - body: - componentId: 658205daa3e8206a523b5ad4 - properties: - - propertyId: a245c12d-995b-55ee-5ec7-aa36a6cad623 - type: Plain Text - label: Title - text: - text: The Hitchhiker's Guide to the Galaxy - - propertyId: a245c12d-995b-55ee-5ec7-aa36a6cad627 - type: Rich Text - label: Content - text: - html: >- -

Don't Panic!

Always know where your towel - is.

- pagination: - limit: 2 - offset: 0 - total: 2 - update-properties: - path: /sites/{site_id}/components/{component_id}/properties - method: POST - auth: true - docs: > - Update the property default values of a component definition in a - specificed locale. - - - Before making updates: - - 1. Use the [get component - properties](/data/reference/pages-and-components/components/get-properties) - endpoint to identify available properties - - - The request requires a secondary locale ID. If a locale is - missing, the request will not be processed and will result in an - error. - - - Required scope | `components:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - component_id: - type: string - docs: Unique identifier for a Component - display-name: Update Component Properties - request: - name: ComponentPropertiesWrite - query-parameters: - localeId: - type: optional - docs: >- - Unique identifier for a specific locale. Applicable, when using - localization. - body: - properties: - properties: - docs: >- - A list of component properties to update within the specified - secondary locale. - type: list - content-type: application/json - response: - docs: Request was successful - type: ComponentsUpdatePropertiesResponse - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - component_id: 8505ba55-ef72-629e-f85c-33e4b703d48b - query-parameters: - localeId: 65427cf400e02b306eaa04a0 - request: - properties: - - propertyId: a245c12d-995b-55ee-5ec7-aa36a6cad623 - text: The Hitchhiker’s Guide to the Galaxy - - propertyId: a245c12d-995b-55ee-5ec7-aa36a6cad627 - text: >- -

Dont Panic!

Always know where your towel - is.

- response: - body: - errors: - - errors - source: - openapi: ../../../openapi/referenced-specs/v2.yml -types: - ComponentDomWriteNodesItem: - discriminated: false - union: - - root.TextNodeWrite - - root.ComponentInstanceNodePropertyOverridesWrite - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - ComponentsUpdateContentResponse: - properties: - errors: - docs: A list of error messages, if any. - type: list - source: - openapi: ../../../openapi/referenced-specs/v2.yml - ComponentPropertiesWritePropertiesItem: - properties: - propertyId: - type: string - docs: The ID of the property. - text: - type: string - docs: > - The new string or HTML value used to update the component property in - the secondary locale. - - - The provided value must be compatible with the type of the component - property. - - - For example, attempting to update a single-line plain-text property - with a multi-line - - value will result in an error. - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - ComponentsUpdatePropertiesResponse: - properties: - errors: - docs: A list of error messages, if any. - type: list - source: - openapi: ../../../openapi/referenced-specs/v2.yml diff --git a/.mock/definition/ecommerce.yml b/.mock/definition/ecommerce.yml deleted file mode 100644 index 1a2ca95..0000000 --- a/.mock/definition/ecommerce.yml +++ /dev/null @@ -1,42 +0,0 @@ -imports: - root: __package__.yml -service: - auth: false - base-path: '' - endpoints: - get-settings: - path: /sites/{site_id}/ecommerce/settings - method: GET - auth: true - docs: | - Retrieve ecommerce settings for a site. - - Required scope | `ecommerce:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: Get Ecommerce Settings - response: - docs: Request was successful - type: root.EcommerceSettings - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.ConflictError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - response: - body: - siteId: 5eb0b5583bf24e2d3a488969 - createdOn: '2018-10-04T15:21:02Z' - defaultCurrency: USD - source: - openapi: ../../../openapi/referenced-specs/v2.yml diff --git a/.mock/definition/forms.yml b/.mock/definition/forms.yml deleted file mode 100644 index 9eac177..0000000 --- a/.mock/definition/forms.yml +++ /dev/null @@ -1,302 +0,0 @@ -imports: - root: __package__.yml -service: - auth: false - base-path: '' - endpoints: - list: - path: /sites/{site_id}/forms - method: GET - auth: true - docs: | - List forms for a given site. - - Required scope | `forms:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: List Forms - request: - name: FormsListRequest - query-parameters: - limit: - type: optional - docs: 'Maximum number of records to be returned (max limit: 100)' - offset: - type: optional - docs: >- - Offset used for pagination if the results have more than limit - records - response: - docs: Request was successful - type: root.FormList - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.ConflictError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - response: - body: - forms: - - displayName: Email Form - createdOn: '2016-10-24T19:41:29Z' - lastUpdated: '2016-10-24T19:43:17Z' - fields: - '0': - displayName: Email - userVisible: true - '1': - displayName: Email - userVisible: true - responseSettings: - redirectUrl: https://example.com - redirectMethod: GET - sendEmailConfirmation: true - id: 589a331aa51e760df7ccb89e - siteId: 580e63e98c9a982ac9b8b741 - siteDomainId: 6419db964a9c436a4baf6248 - pageId: 6419db964a9c43f6a3af6348 - pageName: Home - formElementId: 4e038d2c-6a1e-4953-7be9-a59a2b453177 - workspaceId: 580e63fc8c9a982ac9b8b744 - - displayName: Name Form - createdOn: '2016-10-24T19:41:29Z' - lastUpdated: '2016-10-24T19:43:17Z' - fields: - '0': - displayName: Email - userVisible: true - responseSettings: - redirectUrl: https://example.com - redirectMethod: GET - sendEmailConfirmation: false - id: 580ff8d7ba3e45ba9fe588e9 - siteId: 580e63e98c9a982ac9b8b741 - siteDomainId: 6419db964a9c436a4baf6248 - pageId: 6419db964a9c43f6a3af6348 - pageName: Home - formElementId: 4e038d2c-6a1e-4953-7be9-a59a2b453177 - workspaceId: 580e63fc8c9a982ac9b8b744 - pagination: - limit: 25 - offset: 0 - total: 2 - get: - path: /forms/{form_id} - method: GET - auth: true - docs: | - Get information about a given form. - - Required scope | `forms:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - form_id: - type: string - docs: Unique identifier for a Form - display-name: Get Form Schema - response: - docs: Request was successful - type: root.Form - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - form_id: 580e63e98c9a982ac9b8b741 - response: - body: - displayName: Email Form - createdOn: '2016-10-24T19:41:29Z' - lastUpdated: '2016-10-24T19:43:17Z' - fields: - 660d5bcc9c0772150459dfb1: - displayName: Name - type: Plain - placeholder: Enter your email - userVisible: true - 589a331aa51e760df7ccb89d: - displayName: Email - type: Email - placeholder: Enter your email - userVisible: true - responseSettings: - redirectUrl: https://example.com - redirectMethod: GET - redirectAction: POST https://example.com - sendEmailConfirmation: true - id: 589a331aa51e760df7ccb89e - siteId: 580e63e98c9a982ac9b8b741 - siteDomainId: 6419db964a9c436a4baf6248 - pageId: 6419db964a9c43f6a3af6348 - pageName: Home - formElementId: 4e038d2c-6a1e-4953-7be9-a59a2b453177 - workspaceId: 580e63fc8c9a982ac9b8b744 - list-submissions: - path: /forms/{form_id}/submissions - method: GET - auth: true - docs: | - List form submissions for a given form - - Required scope | `forms:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - form_id: - type: string - docs: Unique identifier for a Form - display-name: List Form Submissions - request: - name: FormsListSubmissionsRequest - query-parameters: - offset: - type: optional - docs: >- - Offset used for pagination if the results have more than limit - records - limit: - type: optional - docs: 'Maximum number of records to be returned (max limit: 100)' - response: - docs: Request was successful - type: root.FormSubmissionList - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - form_id: 580e63e98c9a982ac9b8b741 - response: - body: - formSubmissions: - - id: 6321ca84df3949bfc6752327 - displayName: Sample Form - siteId: 62749158efef318abc8d5a0f - workspaceId: 62749158efef318abc8d5a0f - dateSubmitted: '2022-09-14T12:35:16Z' - formResponse: - First Name: Arthur - Last Name: Dent - - id: 660d64fabf6e0a0d4edab981 - displayName: Sample Form - siteId: 62749158efef318abc8d5a0f - workspaceId: 62749158efef318abc8d5a0f - dateSubmitted: '2022-09-14T12:35:16Z' - formResponse: - First Name: Ford - Last Name: Prefect - pagination: - limit: 25 - offset: 0 - total: 2 - get-submission: - path: /form_submissions/{form_submission_id} - method: GET - auth: true - docs: | - Get information about a given form submissio. - - Required scope | `forms:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - form_submission_id: - type: string - docs: Unique identifier for a Form Submission - display-name: Get Form Submission - response: - docs: Request was successful - type: root.FormSubmission - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - form_submission_id: 580e63e98c9a982ac9b8b741 - response: - body: - id: 6321ca84df3949bfc6752327 - displayName: Sample Form - siteId: 62749158efef318abc8d5a0f - workspaceId: 62749158efef318abc8d5a0f - dateSubmitted: '2022-09-14T12:35:16Z' - formResponse: - First Name: Arthur - Last Name: Dent - update-submission: - path: /form_submissions/{form_submission_id} - method: PATCH - auth: true - docs: | - Update hidden fields on a form submission - - Required scope | `forms:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - form_submission_id: - type: string - docs: Unique identifier for a Form Submission - display-name: Modify Form Submission - request: - name: FormsUpdateSubmissionRequest - body: - properties: - formSubmissionData: - type: optional> - docs: >- - An existing **hidden field** defined on the form schema, and the - corresponding value to set - content-type: application/json - response: - docs: Request was successful - type: root.FormSubmission - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.ConflictError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - form_submission_id: 580e63e98c9a982ac9b8b741 - request: {} - response: - body: - id: 6321ca84df3949bfc6752327 - displayName: Sample Form - siteId: 62749158efef318abc8d5a0f - workspaceId: 62749158efef318abc8d5a0f - dateSubmitted: '2022-09-14T12:35:16Z' - formResponse: - First Name: Arthur - Last Name: Dent - source: - openapi: ../../../openapi/referenced-specs/v2.yml - display-name: Forms -docs: Forms are forms that are created on your Webflow site. diff --git a/.mock/definition/inventory.yml b/.mock/definition/inventory.yml deleted file mode 100644 index 5e69c29..0000000 --- a/.mock/definition/inventory.yml +++ /dev/null @@ -1,122 +0,0 @@ -imports: - root: __package__.yml -service: - auth: false - base-path: '' - endpoints: - list: - path: /collections/{collection_id}/items/{item_id}/inventory - method: GET - auth: true - docs: | - List the current inventory levels for a particular SKU item. - - Required scope | `ecommerce:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - item_id: - type: string - docs: Unique identifier for an Item - display-name: List Inventory - response: - docs: Request was successful - type: root.InventoryItem - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.ConflictError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - item_id: 580e64008c9a982ac9b8b754 - response: - body: - id: 5bfedb42bab0ad90fa7dad39 - quantity: 100 - inventoryType: finite - update: - path: /collections/{collection_id}/items/{item_id}/inventory - method: PATCH - auth: true - docs: > - Updates the current inventory levels for a particular SKU item. - - - Updates may be given in one or two methods, absolutely or - incrementally. - - - Absolute updates are done by setting `quantity` directly. - - - Incremental updates are by specifying the inventory delta in - `updateQuantity` which is then added to the `quantity` stored on the - server. - - - Required scope | `ecommerce:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - collection_id: - type: string - docs: Unique identifier for a Collection - item_id: - type: string - docs: Unique identifier for an Item - display-name: Update Item Inventory - request: - name: InventoryUpdateRequest - body: - properties: - inventoryType: - type: InventoryUpdateRequestInventoryType - docs: infinite or finite - updateQuantity: - type: optional - docs: Adds this quantity to currently store quantity. Can be negative. - quantity: - type: optional - docs: Immediately sets quantity to this value. - content-type: application/json - response: - docs: Request was successful - type: root.InventoryItem - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.ConflictError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - collection_id: 580e63fc8c9a982ac9b8b745 - item_id: 580e64008c9a982ac9b8b754 - request: - inventoryType: infinite - response: - body: - id: 5bfedb42bab0ad90fa7dad39 - quantity: 100 - inventoryType: finite - source: - openapi: ../../../openapi/referenced-specs/v2.yml - display-name: Inventory -docs: Inventory is the stock of e-commerce items in your Webflow site. -types: - InventoryUpdateRequestInventoryType: - enum: - - infinite - - finite - docs: infinite or finite - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml diff --git a/.mock/definition/orders.yml b/.mock/definition/orders.yml deleted file mode 100644 index b2802cf..0000000 --- a/.mock/definition/orders.yml +++ /dev/null @@ -1,1571 +0,0 @@ -types: - OrdersListRequestStatus: - enum: - - pending - - refunded - - value: dispute-lost - name: DisputeLost - - fulfilled - - disputed - - unfulfilled - source: - openapi: ../../../openapi/referenced-specs/v2.yml - OrdersRefundRequestReason: - enum: - - duplicate - - fraudulent - - requested - docs: The reason for the refund - inline: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml -imports: - root: __package__.yml -service: - auth: false - base-path: '' - endpoints: - list: - path: /sites/{site_id}/orders - method: GET - auth: true - docs: | - List all orders created for a given site. - - Required scope | `ecommerce:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: List Orders - request: - name: OrdersListRequest - query-parameters: - status: - type: optional - docs: Filter the orders by status - offset: - type: optional - docs: >- - Offset used for pagination if the results have more than limit - records - limit: - type: optional - docs: 'Maximum number of records to be returned (max limit: 100)' - response: - docs: Request was successful - type: root.OrderList - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.ConflictError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - response: - body: - orders: - - orderId: 7c1-9fd - status: unfulfilled - comment: >- - Customer requested gift wrapping and a personalized note - saying: Happy Birthday, Ford! 🎉 Please ensure the item is - packed with extra bubble wrap for safe transit. - orderComment: >- - Please gift wrap with a personal note saying "Happy - Birthday, Ford! 🎉 - acceptedOn: '2024-04-10T13:16:21Z' - fulfilledOn: '2018-12-03T22:06:15Z' - refundedOn: '2018-12-03T22:06:15Z' - disputedOn: '2018-12-03T22:06:15Z' - disputeUpdatedOn: '2018-12-03T22:06:15Z' - disputeLastStatus: warning_needs_response - customerPaid: - unit: USD - value: '5892' - string: ' 211.55 USD' - netAmount: - unit: USD - value: '5892' - string: ' 200.89 USD' - applicationFee: - unit: USD - value: '5892' - string: ' 4.23 USD' - allAddresses: - - type: billing - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - - type: shipping - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - shippingAddress: - type: shipping - japanType: kanji - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - billingAddress: - type: billing - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - shippingProvider: Shipping Company, Co. - shippingTracking: tr00000000002 - shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000002 - customerInfo: - fullName: Arthur Dent - email: arthur.dent@example.com - purchasedItems: - - count: 2 - rowTotal: - unit: USD - value: '5892' - string: ' 111.22 USD' - productId: 66072fb61b89448912e26791 - productName: Luxurious Fresh Ball - productSlug: luxurious-fresh-ball - variantId: 66072fb71b89448912e2683f - variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic' - variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic - variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic - variantImage: - url: >- - https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg - variantPrice: - unit: USD - value: '5892' - string: ' 55.61 USD' - weight: 11 - width: 82 - height: 70 - length: 9 - - count: 1 - rowTotal: - unit: USD - value: '5892' - string: ' 83.09 USD' - productId: 66072fb61b89448912e2678b - productName: Incredible Bronze Towels - productSlug: incredible-bronze-towels - variantId: 66072fb71b89448912e2681e - variantName: >- - Incredible Bronze Towels Sleek: Frozen, Incredible: - Metal - variantSlug: incredible-bronze-towels-sleek-frozen-incredible-metal - variantSKU: incredible-bronze-towels-sleek-frozen-incredible-metal - variantImage: - url: >- - https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e26729_image16.jpeg - variantPrice: - unit: USD - value: '5892' - string: ' 83.09 USD' - width: 19 - height: 72 - length: 18 - purchasedItemsCount: 3 - stripeDetails: - paymentMethod: pm_1P410gJYFi4lcbXWbeKghqjK - paymentIntentId: pi_3P410iJYFi4lcbXW0EKKgcVg - customerId: cus_Ptod8KJBiiPgnH - chargeId: ch_3P410iJYFi4lcbXW0DxUkzCH - stripeCard: - last4: '4242' - brand: Visa - ownerName: Arthur Dent - expires: - year: 2025 - month: 4 - paypalDetails: - orderId: 1a2b3c4d5e6f7g8h9i0j - payerId: 9k8j7i6h5g4f3e2d1c0b - captureId: qwe123rty456uio789p - refundId: abcde12345fghij67890 - refundReason: Customer requested refund - disputeId: zxcvbnm987poiuytrewq - customData: - - key: value - metadata: - isBuyNow: false - isCustomerDeleted: false - isShippingRequired: false - hasDownloads: false - paymentProcessor: stripe - totals: - extras: - - type: tax - name: State Taxes - description: CA Taxes (6.25%) - price: - unit: USD - value: '5892' - string: '3.44' - downloadFiles: - - id: 5e9a5eba75e0ac242e1b6f64 - name: The modern web design process - Webflow Ebook.pdf - url: >- - https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa - - orderId: fc7-128 - status: refunded - comment: Example comment to myself - orderComment: '' - acceptedOn: '2024-03-29T21:29:21Z' - fulfilledOn: '2018-12-03T22:06:15Z' - refundedOn: '2024-04-08T18:25:04Z' - disputedOn: '2018-12-03T22:06:15Z' - disputeUpdatedOn: '2018-12-03T22:06:15Z' - disputeLastStatus: warning_needs_response - customerPaid: - unit: USD - value: '5892' - string: ' 118.73 USD' - netAmount: - unit: USD - value: '5892' - string: ' 112.62 USD' - applicationFee: - unit: USD - value: '5892' - string: ' 2.37 USD' - allAddresses: - - type: billing - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - - type: shipping - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - shippingAddress: - type: shipping - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - billingAddress: - type: billing - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - shippingProvider: Shipping Company, Co. - shippingTracking: tr00000000001 - shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000001 - customerInfo: - fullName: Arthur Dent - email: arthur.dent@example.com - purchasedItems: - - count: 1 - rowTotal: - unit: USD - value: '5892' - string: ' 55.61 USD' - productId: 66072fb61b89448912e26791 - productName: Luxurious Fresh Ball - productSlug: luxurious-fresh-ball - variantId: 66072fb71b89448912e2683f - variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic' - variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic - variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic - variantImage: - url: >- - https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg - variantPrice: - unit: USD - value: '5892' - string: ' 55.61 USD' - weight: 11 - width: 82 - height: 70 - length: 9 - - count: 1 - rowTotal: - unit: USD - value: '5892' - string: ' 53.44 USD' - productId: 66072fb61b89448912e26799 - productName: Recycled Steel Gloves - productSlug: recycled-steel-gloves - variantId: 66072fb91b89448912e26ab9 - variantName: >- - Recycled Steel Gloves Electronic: Granite, Handcrafted: - grey - variantSlug: >- - recycled-steel-gloves-electronic-granite-handcrafted-grey - variantSKU: >- - recycled-steel-gloves-electronic-granite-handcrafted-grey - variantImage: - url: >- - https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg - variantPrice: - unit: USD - value: '5892' - string: ' 53.44 USD' - weight: 38 - width: 76 - height: 85 - length: 40 - purchasedItemsCount: 2 - stripeDetails: - paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j - paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft - customerId: cus_PpRsNHwWdUoRKR - chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2 - refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk - refundReason: fraudulent - stripeCard: - last4: '4242' - brand: Visa - ownerName: Arthur Dent - expires: - year: 2024 - month: 4 - paypalDetails: - orderId: 1a2b3c4d5e6f7g8h9i0j - payerId: 9k8j7i6h5g4f3e2d1c0b - captureId: qwe123rty456uio789p - refundId: abcde12345fghij67890 - refundReason: Customer requested refund - disputeId: zxcvbnm987poiuytrewq - customData: - - key: value - metadata: - isBuyNow: false - isCustomerDeleted: false - isShippingRequired: true - hasDownloads: false - paymentProcessor: stripe - totals: - subtotal: - unit: USD - value: '5892' - string: ' 109.05 USD' - extras: - - type: tax - name: State Taxes - description: NY Taxes (4.00%) - price: - unit: USD - value: '5892' - string: ' 4.36 USD' - - type: tax - name: City Taxes - description: NEW YORK Taxes (4.88%) - price: - unit: USD - value: '5892' - string: ' 5.32 USD' - - type: shipping - name: Flat - description: '' - price: - unit: USD - value: '5892' - string: ' 0.00 USD' - total: - unit: USD - value: '5892' - string: ' 118.73 USD' - downloadFiles: - - id: 5e9a5eba75e0ac242e1b6f64 - name: New product guide - url: >- - https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa - pagination: - limit: 100 - offset: 0 - total: 2 - get: - path: /sites/{site_id}/orders/{order_id} - method: GET - auth: true - docs: | - Retrieve a single product by its ID. All of its SKUs will also be - retrieved. - - Required scope | `ecommerce:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - order_id: - type: string - docs: Unique identifier for an Order - display-name: Get Order - response: - docs: Request was successful - type: root.Order - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.ConflictError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - order_id: 5e8518516e147040726cc415 - response: - body: - orderId: fc7-128 - status: refunded - comment: >- - Customer requested gift wrapping and a personalized note saying: - Happy Birthday, Ford! 🎉 Please ensure the item is packed with - extra bubble wrap for safe transit. - orderComment: >- - Please gift wrap with a personal note saying "Happy Birthday, - Ford! 🎉 - acceptedOn: '2024-03-29T21:29:21Z' - fulfilledOn: '2024-03-29T21:29:21Z' - refundedOn: '2024-04-08T18:25:04Z' - disputedOn: '2024-03-29T21:29:21Z' - disputeUpdatedOn: '2024-03-29T21:29:21Z' - disputeLastStatus: charge_refunded - customerPaid: - unit: USD - value: '5892' - string: ' 118.73 USD' - netAmount: - unit: USD - value: '5892' - string: ' 112.62 USD' - applicationFee: - unit: USD - value: '5892' - string: ' 2.37 USD' - allAddresses: - - type: billing - japanType: kana - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - - type: shipping - japanType: kana - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - shippingAddress: - type: shipping - japanType: kanji - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - billingAddress: - type: billing - japanType: kana - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - shippingProvider: Shipping Company, Co. - shippingTracking: tr00000000001 - shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000001 - customerInfo: - fullName: Arthur Dent - email: arthur.dent@example.com - purchasedItems: - - count: 1 - rowTotal: - unit: USD - value: '5892' - string: ' 55.61 USD' - productId: 66072fb61b89448912e26791 - productName: Luxurious Fresh Ball - productSlug: luxurious-fresh-ball - variantId: 66072fb71b89448912e2683f - variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic' - variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic - variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic - variantImage: - url: >- - https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg - variantPrice: - unit: USD - value: '5892' - string: ' 55.61 USD' - weight: 11 - width: 82 - height: 70 - length: 9 - - count: 1 - rowTotal: - unit: USD - value: '5892' - string: ' 53.44 USD' - productId: 66072fb61b89448912e26799 - productName: Recycled Steel Gloves - productSlug: recycled-steel-gloves - variantId: 66072fb91b89448912e26ab9 - variantName: 'Recycled Steel Gloves Electronic: Granite, Handcrafted: grey' - variantSlug: recycled-steel-gloves-electronic-granite-handcrafted-grey - variantSKU: recycled-steel-gloves-electronic-granite-handcrafted-grey - variantImage: - url: >- - https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg - variantPrice: - unit: USD - value: '5892' - string: ' 53.44 USD' - weight: 38 - width: 76 - height: 85 - length: 40 - purchasedItemsCount: 2 - stripeDetails: - subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn - paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j - paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft - customerId: cus_PpRsNHwWdUoRKR - chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2 - disputeId: disputeId - refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk - refundReason: fraudulent - stripeCard: - last4: '4242' - brand: Visa - ownerName: Arthur Dent - expires: - year: 2024 - month: 4 - paypalDetails: - orderId: 1a2b3c4d5e6f7g8h9i0j - payerId: 9k8j7i6h5g4f3e2d1c0b - captureId: qwe123rty456uio789p - refundId: abcde12345fghij67890 - refundReason: Customer requested refund - disputeId: zxcvbnm987poiuytrewq - customData: - - key: value - metadata: - isBuyNow: false - isCustomerDeleted: false - isShippingRequired: true - hasDownloads: false - paymentProcessor: stripe - totals: - subtotal: - unit: USD - value: '5892' - string: ' 109.05 USD' - extras: - - type: tax - name: State Taxes - description: NY Taxes (4.00%) - price: - unit: USD - value: '5892' - string: ' 4.36 USD' - - type: tax - name: City Taxes - description: NEW YORK Taxes (4.88%) - price: - unit: USD - value: '5892' - string: ' 5.32 USD' - - type: shipping - name: Flat - description: '' - price: - unit: USD - value: '5892' - string: ' 0.00 USD' - total: - unit: USD - value: '5892' - string: ' 118.73 USD' - downloadFiles: - - id: 5e9a5eba75e0ac242e1b6f64 - name: New product guide - url: >- - https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa - update: - path: /sites/{site_id}/orders/{order_id} - method: PATCH - auth: true - docs: | - This API lets you update the fields, `comment`, `shippingProvider`, - and/or `shippingTracking` for a given order. All three fields can be - updated simultaneously or independently. - - Required scope | `ecommerce:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - order_id: - type: string - docs: Unique identifier for an Order - display-name: Update Order - request: - name: OrdersUpdateRequest - body: - properties: - comment: - type: optional - docs: Arbitrary data for your records - shippingProvider: - type: optional - docs: Company or method used to ship order - shippingTracking: - type: optional - docs: Tracking number for order shipment - shippingTrackingURL: - type: optional - docs: URL to track order shipment - content-type: application/json - response: - docs: Request was successful - type: root.Order - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.ConflictError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - order_id: 5e8518516e147040726cc415 - request: {} - response: - body: - orderId: fc7-128 - status: refunded - comment: >- - Customer requested gift wrapping and a personalized note saying: - Happy Birthday, Ford! 🎉 Please ensure the item is packed with - extra bubble wrap for safe transit. - orderComment: >- - Please gift wrap with a personal note saying "Happy Birthday, - Ford! 🎉 - acceptedOn: '2024-03-29T21:29:21Z' - fulfilledOn: '2024-03-29T21:29:21Z' - refundedOn: '2024-04-08T18:25:04Z' - disputedOn: '2024-03-29T21:29:21Z' - disputeUpdatedOn: '2024-03-29T21:29:21Z' - disputeLastStatus: charge_refunded - customerPaid: - unit: USD - value: '5892' - string: ' 118.73 USD' - netAmount: - unit: USD - value: '5892' - string: ' 112.62 USD' - applicationFee: - unit: USD - value: '5892' - string: ' 2.37 USD' - allAddresses: - - type: billing - japanType: kana - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - - type: shipping - japanType: kana - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - shippingAddress: - type: shipping - japanType: kanji - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - billingAddress: - type: billing - japanType: kana - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - shippingProvider: Shipping Company, Co. - shippingTracking: tr00000000001 - shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000001 - customerInfo: - fullName: Arthur Dent - email: arthur.dent@example.com - purchasedItems: - - count: 1 - rowTotal: - unit: USD - value: '5892' - string: ' 55.61 USD' - productId: 66072fb61b89448912e26791 - productName: Luxurious Fresh Ball - productSlug: luxurious-fresh-ball - variantId: 66072fb71b89448912e2683f - variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic' - variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic - variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic - variantImage: - url: >- - https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg - variantPrice: - unit: USD - value: '5892' - string: ' 55.61 USD' - weight: 11 - width: 82 - height: 70 - length: 9 - - count: 1 - rowTotal: - unit: USD - value: '5892' - string: ' 53.44 USD' - productId: 66072fb61b89448912e26799 - productName: Recycled Steel Gloves - productSlug: recycled-steel-gloves - variantId: 66072fb91b89448912e26ab9 - variantName: 'Recycled Steel Gloves Electronic: Granite, Handcrafted: grey' - variantSlug: recycled-steel-gloves-electronic-granite-handcrafted-grey - variantSKU: recycled-steel-gloves-electronic-granite-handcrafted-grey - variantImage: - url: >- - https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg - variantPrice: - unit: USD - value: '5892' - string: ' 53.44 USD' - weight: 38 - width: 76 - height: 85 - length: 40 - purchasedItemsCount: 2 - stripeDetails: - subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn - paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j - paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft - customerId: cus_PpRsNHwWdUoRKR - chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2 - disputeId: disputeId - refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk - refundReason: fraudulent - stripeCard: - last4: '4242' - brand: Visa - ownerName: Arthur Dent - expires: - year: 2024 - month: 4 - paypalDetails: - orderId: 1a2b3c4d5e6f7g8h9i0j - payerId: 9k8j7i6h5g4f3e2d1c0b - captureId: qwe123rty456uio789p - refundId: abcde12345fghij67890 - refundReason: Customer requested refund - disputeId: zxcvbnm987poiuytrewq - customData: - - key: value - metadata: - isBuyNow: false - isCustomerDeleted: false - isShippingRequired: true - hasDownloads: false - paymentProcessor: stripe - totals: - subtotal: - unit: USD - value: '5892' - string: ' 109.05 USD' - extras: - - type: tax - name: State Taxes - description: NY Taxes (4.00%) - price: - unit: USD - value: '5892' - string: ' 4.36 USD' - - type: tax - name: City Taxes - description: NEW YORK Taxes (4.88%) - price: - unit: USD - value: '5892' - string: ' 5.32 USD' - - type: shipping - name: Flat - description: '' - price: - unit: USD - value: '5892' - string: ' 0.00 USD' - total: - unit: USD - value: '5892' - string: ' 118.73 USD' - downloadFiles: - - id: 5e9a5eba75e0ac242e1b6f64 - name: New product guide - url: >- - https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa - update-fulfill: - path: /sites/{site_id}/orders/{order_id}/fulfill - method: POST - auth: true - docs: | - Updates an order's status to fulfilled - - Required scope | `ecommerce:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - order_id: - type: string - docs: Unique identifier for an Order - display-name: Fulfill Order - request: - name: OrdersUpdateFulfillRequest - body: - properties: - sendOrderFulfilledEmail: - type: optional - docs: Whether or not the Order Fulfilled email should be sent - default: false - content-type: application/json - response: - docs: Request was successful - type: root.Order - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.ConflictError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - order_id: 5e8518516e147040726cc415 - request: {} - response: - body: - orderId: fc7-128 - status: refunded - comment: >- - Customer requested gift wrapping and a personalized note saying: - Happy Birthday, Ford! 🎉 Please ensure the item is packed with - extra bubble wrap for safe transit. - orderComment: >- - Please gift wrap with a personal note saying "Happy Birthday, - Ford! 🎉 - acceptedOn: '2024-03-29T21:29:21Z' - fulfilledOn: '2024-03-29T21:29:21Z' - refundedOn: '2024-04-08T18:25:04Z' - disputedOn: '2024-03-29T21:29:21Z' - disputeUpdatedOn: '2024-03-29T21:29:21Z' - disputeLastStatus: charge_refunded - customerPaid: - unit: USD - value: '5892' - string: ' 118.73 USD' - netAmount: - unit: USD - value: '5892' - string: ' 112.62 USD' - applicationFee: - unit: USD - value: '5892' - string: ' 2.37 USD' - allAddresses: - - type: billing - japanType: kana - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - - type: shipping - japanType: kana - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - shippingAddress: - type: shipping - japanType: kanji - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - billingAddress: - type: billing - japanType: kana - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - shippingProvider: Shipping Company, Co. - shippingTracking: tr00000000001 - shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000001 - customerInfo: - fullName: Arthur Dent - email: arthur.dent@example.com - purchasedItems: - - count: 1 - rowTotal: - unit: USD - value: '5892' - string: ' 55.61 USD' - productId: 66072fb61b89448912e26791 - productName: Luxurious Fresh Ball - productSlug: luxurious-fresh-ball - variantId: 66072fb71b89448912e2683f - variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic' - variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic - variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic - variantImage: - url: >- - https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg - variantPrice: - unit: USD - value: '5892' - string: ' 55.61 USD' - weight: 11 - width: 82 - height: 70 - length: 9 - - count: 1 - rowTotal: - unit: USD - value: '5892' - string: ' 53.44 USD' - productId: 66072fb61b89448912e26799 - productName: Recycled Steel Gloves - productSlug: recycled-steel-gloves - variantId: 66072fb91b89448912e26ab9 - variantName: 'Recycled Steel Gloves Electronic: Granite, Handcrafted: grey' - variantSlug: recycled-steel-gloves-electronic-granite-handcrafted-grey - variantSKU: recycled-steel-gloves-electronic-granite-handcrafted-grey - variantImage: - url: >- - https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg - variantPrice: - unit: USD - value: '5892' - string: ' 53.44 USD' - weight: 38 - width: 76 - height: 85 - length: 40 - purchasedItemsCount: 2 - stripeDetails: - subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn - paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j - paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft - customerId: cus_PpRsNHwWdUoRKR - chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2 - disputeId: disputeId - refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk - refundReason: fraudulent - stripeCard: - last4: '4242' - brand: Visa - ownerName: Arthur Dent - expires: - year: 2024 - month: 4 - paypalDetails: - orderId: 1a2b3c4d5e6f7g8h9i0j - payerId: 9k8j7i6h5g4f3e2d1c0b - captureId: qwe123rty456uio789p - refundId: abcde12345fghij67890 - refundReason: Customer requested refund - disputeId: zxcvbnm987poiuytrewq - customData: - - key: value - metadata: - isBuyNow: false - isCustomerDeleted: false - isShippingRequired: true - hasDownloads: false - paymentProcessor: stripe - totals: - subtotal: - unit: USD - value: '5892' - string: ' 109.05 USD' - extras: - - type: tax - name: State Taxes - description: NY Taxes (4.00%) - price: - unit: USD - value: '5892' - string: ' 4.36 USD' - - type: tax - name: City Taxes - description: NEW YORK Taxes (4.88%) - price: - unit: USD - value: '5892' - string: ' 5.32 USD' - - type: shipping - name: Flat - description: '' - price: - unit: USD - value: '5892' - string: ' 0.00 USD' - total: - unit: USD - value: '5892' - string: ' 118.73 USD' - downloadFiles: - - id: 5e9a5eba75e0ac242e1b6f64 - name: New product guide - url: >- - https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa - update-unfulfill: - path: /sites/{site_id}/orders/{order_id}/unfulfill - method: POST - auth: true - docs: | - Updates an order's status to unfulfilled - - Required scope | `ecommerce:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - order_id: - type: string - docs: Unique identifier for an Order - display-name: Unfulfill Order - response: - docs: Request was successful - type: root.Order - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.ConflictError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - order_id: 5e8518516e147040726cc415 - response: - body: - orderId: fc7-128 - status: refunded - comment: >- - Customer requested gift wrapping and a personalized note saying: - Happy Birthday, Ford! 🎉 Please ensure the item is packed with - extra bubble wrap for safe transit. - orderComment: >- - Please gift wrap with a personal note saying "Happy Birthday, - Ford! 🎉 - acceptedOn: '2024-03-29T21:29:21Z' - fulfilledOn: '2024-03-29T21:29:21Z' - refundedOn: '2024-04-08T18:25:04Z' - disputedOn: '2024-03-29T21:29:21Z' - disputeUpdatedOn: '2024-03-29T21:29:21Z' - disputeLastStatus: charge_refunded - customerPaid: - unit: USD - value: '5892' - string: ' 118.73 USD' - netAmount: - unit: USD - value: '5892' - string: ' 112.62 USD' - applicationFee: - unit: USD - value: '5892' - string: ' 2.37 USD' - allAddresses: - - type: billing - japanType: kana - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - - type: shipping - japanType: kana - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - shippingAddress: - type: shipping - japanType: kanji - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - billingAddress: - type: billing - japanType: kana - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - shippingProvider: Shipping Company, Co. - shippingTracking: tr00000000001 - shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000001 - customerInfo: - fullName: Arthur Dent - email: arthur.dent@example.com - purchasedItems: - - count: 1 - rowTotal: - unit: USD - value: '5892' - string: ' 55.61 USD' - productId: 66072fb61b89448912e26791 - productName: Luxurious Fresh Ball - productSlug: luxurious-fresh-ball - variantId: 66072fb71b89448912e2683f - variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic' - variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic - variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic - variantImage: - url: >- - https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg - variantPrice: - unit: USD - value: '5892' - string: ' 55.61 USD' - weight: 11 - width: 82 - height: 70 - length: 9 - - count: 1 - rowTotal: - unit: USD - value: '5892' - string: ' 53.44 USD' - productId: 66072fb61b89448912e26799 - productName: Recycled Steel Gloves - productSlug: recycled-steel-gloves - variantId: 66072fb91b89448912e26ab9 - variantName: 'Recycled Steel Gloves Electronic: Granite, Handcrafted: grey' - variantSlug: recycled-steel-gloves-electronic-granite-handcrafted-grey - variantSKU: recycled-steel-gloves-electronic-granite-handcrafted-grey - variantImage: - url: >- - https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg - variantPrice: - unit: USD - value: '5892' - string: ' 53.44 USD' - weight: 38 - width: 76 - height: 85 - length: 40 - purchasedItemsCount: 2 - stripeDetails: - subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn - paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j - paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft - customerId: cus_PpRsNHwWdUoRKR - chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2 - disputeId: disputeId - refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk - refundReason: fraudulent - stripeCard: - last4: '4242' - brand: Visa - ownerName: Arthur Dent - expires: - year: 2024 - month: 4 - paypalDetails: - orderId: 1a2b3c4d5e6f7g8h9i0j - payerId: 9k8j7i6h5g4f3e2d1c0b - captureId: qwe123rty456uio789p - refundId: abcde12345fghij67890 - refundReason: Customer requested refund - disputeId: zxcvbnm987poiuytrewq - customData: - - key: value - metadata: - isBuyNow: false - isCustomerDeleted: false - isShippingRequired: true - hasDownloads: false - paymentProcessor: stripe - totals: - subtotal: - unit: USD - value: '5892' - string: ' 109.05 USD' - extras: - - type: tax - name: State Taxes - description: NY Taxes (4.00%) - price: - unit: USD - value: '5892' - string: ' 4.36 USD' - - type: tax - name: City Taxes - description: NEW YORK Taxes (4.88%) - price: - unit: USD - value: '5892' - string: ' 5.32 USD' - - type: shipping - name: Flat - description: '' - price: - unit: USD - value: '5892' - string: ' 0.00 USD' - total: - unit: USD - value: '5892' - string: ' 118.73 USD' - downloadFiles: - - id: 5e9a5eba75e0ac242e1b6f64 - name: New product guide - url: >- - https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa - refund: - path: /sites/{site_id}/orders/{order_id}/refund - method: POST - auth: true - docs: | - This API will reverse a Stripe charge and refund an order back to a - customer. It will also set the order's status to `refunded`. - - Required scope | `ecommerce:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - order_id: - type: string - docs: Unique identifier for an Order - display-name: Refund Order - request: - name: OrdersRefundRequest - body: - properties: - reason: - type: optional - docs: The reason for the refund - content-type: application/json - response: - docs: Request was successful - type: root.Order - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.ConflictError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - order_id: 5e8518516e147040726cc415 - request: {} - response: - body: - orderId: fc7-128 - status: refunded - comment: >- - Customer requested gift wrapping and a personalized note saying: - Happy Birthday, Ford! 🎉 Please ensure the item is packed with - extra bubble wrap for safe transit. - orderComment: >- - Please gift wrap with a personal note saying "Happy Birthday, - Ford! 🎉 - acceptedOn: '2024-03-29T21:29:21Z' - fulfilledOn: '2024-03-29T21:29:21Z' - refundedOn: '2024-04-08T18:25:04Z' - disputedOn: '2024-03-29T21:29:21Z' - disputeUpdatedOn: '2024-03-29T21:29:21Z' - disputeLastStatus: charge_refunded - customerPaid: - unit: USD - value: '5892' - string: ' 118.73 USD' - netAmount: - unit: USD - value: '5892' - string: ' 112.62 USD' - applicationFee: - unit: USD - value: '5892' - string: ' 2.37 USD' - allAddresses: - - type: billing - japanType: kana - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - - type: shipping - japanType: kana - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - shippingAddress: - type: shipping - japanType: kanji - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - billingAddress: - type: billing - japanType: kana - addressee: Arthur Dent - line1: 20 W 34th St - line2: Empire State Building - city: New York - state: New York - country: US - postalCode: '10118' - shippingProvider: Shipping Company, Co. - shippingTracking: tr00000000001 - shippingTrackingURL: https://www.shippingcompany.com/tracking/tr00000000001 - customerInfo: - fullName: Arthur Dent - email: arthur.dent@example.com - purchasedItems: - - count: 1 - rowTotal: - unit: USD - value: '5892' - string: ' 55.61 USD' - productId: 66072fb61b89448912e26791 - productName: Luxurious Fresh Ball - productSlug: luxurious-fresh-ball - variantId: 66072fb71b89448912e2683f - variantName: 'Luxurious Fresh Ball Generic: Bronze, Practical: Plastic' - variantSlug: luxurious-fresh-ball-generic-bronze-practical-plastic - variantSKU: luxurious-fresh-ball-generic-bronze-practical-plastic - variantImage: - url: >- - https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg - variantPrice: - unit: USD - value: '5892' - string: ' 55.61 USD' - weight: 11 - width: 82 - height: 70 - length: 9 - - count: 1 - rowTotal: - unit: USD - value: '5892' - string: ' 53.44 USD' - productId: 66072fb61b89448912e26799 - productName: Recycled Steel Gloves - productSlug: recycled-steel-gloves - variantId: 66072fb91b89448912e26ab9 - variantName: 'Recycled Steel Gloves Electronic: Granite, Handcrafted: grey' - variantSlug: recycled-steel-gloves-electronic-granite-handcrafted-grey - variantSKU: recycled-steel-gloves-electronic-granite-handcrafted-grey - variantImage: - url: >- - https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg - variantPrice: - unit: USD - value: '5892' - string: ' 53.44 USD' - weight: 38 - width: 76 - height: 85 - length: 40 - purchasedItemsCount: 2 - stripeDetails: - subscriptionId: sub_1J6xwG2eZvKYlo2CXu9Zt0Tn - paymentMethod: pm_1OzmzBJYFi4lcbXWHKNdXU7j - paymentIntentId: pi_3OzmzDJYFi4lcbXW1hTBW6ft - customerId: cus_PpRsNHwWdUoRKR - chargeId: ch_3OzmzDJYFi4lcbXW1ndkkrH2 - disputeId: disputeId - refundId: re_3OzmzDJYFi4lcbXW1kFAmlBk - refundReason: fraudulent - stripeCard: - last4: '4242' - brand: Visa - ownerName: Arthur Dent - expires: - year: 2024 - month: 4 - paypalDetails: - orderId: 1a2b3c4d5e6f7g8h9i0j - payerId: 9k8j7i6h5g4f3e2d1c0b - captureId: qwe123rty456uio789p - refundId: abcde12345fghij67890 - refundReason: Customer requested refund - disputeId: zxcvbnm987poiuytrewq - customData: - - key: value - metadata: - isBuyNow: false - isCustomerDeleted: false - isShippingRequired: true - hasDownloads: false - paymentProcessor: stripe - totals: - subtotal: - unit: USD - value: '5892' - string: ' 109.05 USD' - extras: - - type: tax - name: State Taxes - description: NY Taxes (4.00%) - price: - unit: USD - value: '5892' - string: ' 4.36 USD' - - type: tax - name: City Taxes - description: NEW YORK Taxes (4.88%) - price: - unit: USD - value: '5892' - string: ' 5.32 USD' - - type: shipping - name: Flat - description: '' - price: - unit: USD - value: '5892' - string: ' 0.00 USD' - total: - unit: USD - value: '5892' - string: ' 118.73 USD' - downloadFiles: - - id: 5e9a5eba75e0ac242e1b6f64 - name: New product guide - url: >- - https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa - source: - openapi: ../../../openapi/referenced-specs/v2.yml - display-name: Orders -docs: Orders are the orders for your Webflow site. diff --git a/.mock/definition/pages.yml b/.mock/definition/pages.yml deleted file mode 100644 index 62de7dc..0000000 --- a/.mock/definition/pages.yml +++ /dev/null @@ -1,470 +0,0 @@ -imports: - root: __package__.yml -service: - auth: false - base-path: '' - endpoints: - list: - path: /sites/{site_id}/pages - method: GET - auth: true - docs: | - List of all pages for a site. - - Required scope | `pages:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: List Pages - request: - name: PagesListRequest - query-parameters: - localeId: - type: optional - docs: >- - Unique identifier for a specific locale. Applicable, when using - localization. - limit: - type: optional - docs: 'Maximum number of records to be returned (max limit: 100)' - offset: - type: optional - docs: >- - Offset used for pagination if the results have more than limit - records - response: - docs: Request was successful - type: root.PageList - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - query-parameters: - localeId: 65427cf400e02b306eaa04a0 - response: - body: - pages: - - id: 6596da6045e56dee495bcbba - siteId: 6258612d1ee792848f805dcf - title: Guide to the Galaxy - slug: guide-to-the-galaxy - parentId: 6419db964a9c435aa3af6251 - collectionId: 6390c49774a71f12831a08e3 - createdOn: '2024-03-11T10:42:00Z' - lastUpdated: '2024-03-11T10:42:42Z' - archived: false - draft: false - canBranch: true - isBranch: false - isMembersOnly: false - seo: - title: The Ultimate Hitchhiker's Guide to the Galaxy - description: >- - Everything you need to know about the galaxy, from - avoiding Vogon poetry to the importance of towels. - openGraph: - title: Explore the Cosmos with The Ultimate Guide - titleCopied: false - description: >- - Dive deep into the mysteries of the universe with your - guide to everything galactic. - descriptionCopied: false - localeId: 653fd9af6a07fc9cfd7a5e57 - publishedPath: /en-us/guide-to-the-galaxy - - id: 6596da6045e56dee495bcbad - siteId: 6258612d1ee792848f805dcf - title: Towel Day Celebrations - slug: towel-day - parentId: 6419db964a9c435aa3af6251 - collectionId: 6390c49774a71f12831a08e3 - createdOn: '2024-05-25T09:00:00Z' - lastUpdated: '2024-05-25T09:42:00Z' - archived: false - draft: false - canBranch: true - isBranch: false - isMembersOnly: false - seo: - title: Celebrate Towel Day - The Hitchhiker's Guide to the Galaxy - description: >- - A guide to celebrating Towel Day, in honor of the most - massively useful thing an interstellar hitchhiker can - have. - openGraph: - title: Towel Day - Don't Panic - titleCopied: false - description: >- - Join the galaxy in celebrating Towel Day, the day - dedicated to carrying towels everywhere in memory of - Douglas Adams. - descriptionCopied: false - localeId: 653fd9af6a07fc9cfd7a5e57 - publishedPath: /en-us/towel-day - pagination: - limit: 20 - offset: 0 - total: 2 - get-metadata: - path: /pages/{page_id} - method: GET - auth: true - docs: | - Get metadata information for a single page. - - Required scope | `pages:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - page_id: - type: string - docs: Unique identifier for a Page - display-name: Get Page Metadata - request: - name: PagesGetMetadataRequest - query-parameters: - localeId: - type: optional - docs: >- - Unique identifier for a specific locale. Applicable, when using - localization. - response: - docs: Request was successful - type: root.Page - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - page_id: 63c720f9347c2139b248e552 - query-parameters: - localeId: 65427cf400e02b306eaa04a0 - response: - body: - id: 6596da6045e56dee495bcbba - siteId: 6258612d1ee792848f805dcf - title: Guide to the Galaxy - slug: guide-to-the-galaxy - parentId: 6419db964a9c435aa3af6251 - collectionId: 6390c49774a71f12831a08e3 - createdOn: '2024-03-11T10:42:00Z' - lastUpdated: '2024-03-11T10:42:42Z' - archived: false - draft: false - canBranch: true - isBranch: false - isMembersOnly: false - seo: - title: The Ultimate Hitchhiker's Guide to the Galaxy - description: >- - Everything you need to know about the galaxy, from avoiding - Vogon poetry to the importance of towels. - openGraph: - title: Explore the Cosmos with The Ultimate Guide - titleCopied: false - description: >- - Dive deep into the mysteries of the universe with your guide - to everything galactic. - descriptionCopied: false - localeId: 653fd9af6a07fc9cfd7a5e57 - publishedPath: /en-us/guide-to-the-galaxy - update-page-settings: - path: /pages/{page_id} - method: PUT - auth: true - docs: | - Update Page-level metadata, including SEO and Open Graph fields. - - Required scope | `pages:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - page_id: - type: string - docs: Unique identifier for a Page - display-name: Update Page Metadata - request: - body: root.Page - query-parameters: - localeId: - type: optional - docs: >- - Unique identifier for a specific locale. Applicable, when using - localization. - name: UpdatePageSettingsRequest - content-type: application/json - response: - docs: Request was successful - type: root.Page - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - page_id: 63c720f9347c2139b248e552 - query-parameters: - localeId: 65427cf400e02b306eaa04a0 - request: - id: 6596da6045e56dee495bcbba - siteId: 6258612d1ee792848f805dcf - title: Guide to the Galaxy - slug: guide-to-the-galaxy - createdOn: '2024-03-11T10:42:00Z' - lastUpdated: '2024-03-11T10:42:42Z' - archived: false - draft: false - canBranch: true - isBranch: false - seo: - title: The Ultimate Hitchhiker's Guide to the Galaxy - description: >- - Everything you need to know about the galaxy, from avoiding - Vogon poetry to the importance of towels. - openGraph: - title: Explore the Cosmos with The Ultimate Guide - titleCopied: false - description: >- - Dive deep into the mysteries of the universe with your guide to - everything galactic. - descriptionCopied: false - localeId: 653fd9af6a07fc9cfd7a5e57 - publishedPath: /en-us/guide-to-the-galaxy - response: - body: - id: 6596da6045e56dee495bcbba - siteId: 6258612d1ee792848f805dcf - title: Guide to the Galaxy - slug: guide-to-the-galaxy - parentId: 6419db964a9c435aa3af6251 - collectionId: 6390c49774a71f12831a08e3 - createdOn: '2024-03-11T10:42:00Z' - lastUpdated: '2024-03-11T10:42:42Z' - archived: false - draft: false - canBranch: true - isBranch: false - isMembersOnly: false - seo: - title: The Ultimate Hitchhiker's Guide to the Galaxy - description: >- - Everything you need to know about the galaxy, from avoiding - Vogon poetry to the importance of towels. - openGraph: - title: Explore the Cosmos with The Ultimate Guide - titleCopied: false - description: >- - Dive deep into the mysteries of the universe with your guide - to everything galactic. - descriptionCopied: false - localeId: 653fd9af6a07fc9cfd7a5e57 - publishedPath: /en-us/guide-to-the-galaxy - get-content: - path: /pages/{page_id}/dom - method: GET - auth: true - docs: > - Get static content from a static page. This includes text nodes, image - nodes and component instances. - - To retrieve the contents of components in the page use the [get - component - content](/data/reference/pages-and-components/components/get-content) - endpoint. - - - If you do not provide a Locale ID in your request, the response - will return any content that can be localized from the Primary - locale. - - - Required scope | `pages:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - page_id: - type: string - docs: Unique identifier for a Page - display-name: Get Page Content - request: - name: PagesGetContentRequest - query-parameters: - localeId: - type: optional - docs: >- - Unique identifier for a specific locale. Applicable, when using - localization. - limit: - type: optional - docs: 'Maximum number of records to be returned (max limit: 100)' - offset: - type: optional - docs: >- - Offset used for pagination if the results have more than limit - records - response: - docs: Request was successful - type: root.Dom - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - name: PageDOM - path-parameters: - page_id: 63c720f9347c2139b248e552 - query-parameters: - localeId: 65427cf400e02b306eaa04a0 - response: - body: - pageId: 658205daa3e8206a523b5ad4 - nodes: - - type: component-instance - id: a245c12d-995b-55ee-5ec7-aa36a6cad623 - componentId: nodes - propertyOverrides: - - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0 - - type: component-instance - id: a245c12d-995b-55ee-5ec7-aa36a6cad627 - componentId: nodes - propertyOverrides: - - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0 - - type: component-instance - id: a245c12d-995b-55ee-5ec7-aa36a6cad629 - componentId: nodes - propertyOverrides: - - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0 - - type: component-instance - id: a245c12d-995b-55ee-5ec7-aa36a6cad631 - componentId: 6258612d1ee792848f805dcf - propertyOverrides: - - propertyId: a245c12d-995b-55ee-5ec7-aa36a6cad633 - type: Plain Text - label: Catchphrase - text: - text: Don't Panic! - - propertyId: a245c12d-995b-55ee-5ec7-aa36a6cad635 - type: Rich Text - label: Tagline - text: - html:

Always know where your towel is.

- pagination: - limit: 4 - offset: 0 - total: 4 - update-static-content: - path: /pages/{page_id}/dom - method: POST - auth: true - docs: > - This endpoint updates content on a static page in **secondary locales**. - It supports updating up to 1000 nodes in a single request. - - - Before making updates: - - 1. Use the [get page - content](/data/reference/pages-and-components/pages/get-content) - endpoint to identify available content nodes and their types - - 2. If the page has component instances, retrieve the component's - properties that you'll override using the [get component - properties](/data/reference/pages-and-components/components/get-properties) - endpoint - - - - This endpoint is specifically for localized pages. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail. - - - - Required scope | `pages:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - page_id: - type: string - docs: Unique identifier for a Page - display-name: Update Page Content - request: - name: PageDomWrite - query-parameters: - localeId: - type: string - docs: The locale identifier. - body: - properties: - nodes: - docs: >- - List of DOM Nodes with the new content that will be updated in - each node. - type: list - content-type: application/json - response: - docs: Request was successful - type: UpdateStaticContentResponse - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - page_id: 63c720f9347c2139b248e552 - query-parameters: - localeId: localeId - request: - nodes: - - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad623 - text:

The Hitchhiker's Guide to the Galaxy

- - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad627 - text: >- -

Don't Panic!

Always know where your towel - is.

- - nodeId: a245c12d-995b-55ee-5ec7-aa36a6cad629 - propertyOverrides: - - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f0 - text:

Time is an illusion

- - propertyId: 7dd14c08-2e96-8d3d-2b19-b5c03642a0f1 - text: Life, the Universe and Everything - response: - body: - errors: - - errors - source: - openapi: ../../../openapi/referenced-specs/v2.yml - display-name: Pages -docs: Pages are the pages in your Webflow site. -types: - PageDomWriteNodesItem: - discriminated: false - union: - - root.TextNodeWrite - - root.ComponentInstanceNodePropertyOverridesWrite - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true - UpdateStaticContentResponse: - properties: - errors: - docs: A list of error messages, if any. - type: list - source: - openapi: ../../../openapi/referenced-specs/v2.yml diff --git a/.mock/definition/pages/scripts.yml b/.mock/definition/pages/scripts.yml deleted file mode 100644 index f8ee328..0000000 --- a/.mock/definition/pages/scripts.yml +++ /dev/null @@ -1,170 +0,0 @@ -imports: - root: ../__package__.yml -service: - auth: false - base-path: '' - endpoints: - get-custom-code: - path: /pages/{page_id}/custom_code - method: GET - auth: true - docs: > - Get all registered scripts that have been applied to a specific Page. - - - In order to use the Custom Code APIs for Sites and Pages, Custom Code - Scripts must first be registered - - to a Site via the `registered_scripts` endpoints, and then applied to a - Site or Page using the appropriate - - `custom_code` endpoints. - - - Access to this endpoint requires a bearer token from a [Data - Client App](/data/docs/getting-started-data-clients). - - - Required scope | `custom_code:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - page_id: - type: string - docs: Unique identifier for a Page - display-name: Get Custom Code - response: - docs: Request was successful - type: root.ScriptApplyList - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - page_id: 63c720f9347c2139b248e552 - response: - body: - scripts: - - id: id - location: header - version: version - attributes: - key: value - lastUpdated: lastUpdated - createdOn: createdOn - upsert-custom-code: - path: /pages/{page_id}/custom_code - method: PUT - auth: true - docs: > - Add a registered script to a Page. - - - In order to use the Custom Code APIs for Sites and Pages, Custom Code - Scripts must first be registered - - to a Site via the `registered_scripts` endpoints, and then applied to a - Site or Page using the appropriate - - `custom_code` endpoints. - - - A site can have a maximum of 800 registered scripts. - - - Access to this endpoint requires a bearer token from a [Data - Client App](/data/docs/getting-started-data-clients). - - - Required scope | `custom_code:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - page_id: - type: string - docs: Unique identifier for a Page - display-name: Add/Update Custom Code - request: - body: root.ScriptApplyList - content-type: application/json - response: - docs: Request was successful - type: root.ScriptApplyList - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.ConflictError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - page_id: 63c720f9347c2139b248e552 - request: - scripts: - - id: cms_slider - location: header - version: 1.0.0 - attributes: - my-attribute: some-value - - id: alert - location: header - version: 0.0.1 - response: - body: - scripts: - - id: cms_slider - location: header - version: 1.0.0 - attributes: - my-attribute: some-value - - id: alert - location: header - version: 0.0.1 - attributes: - key: value - lastUpdated: '2022-10-26T00:28:54.191Z' - createdOn: '2022-10-26T00:28:54.191Z' - delete-custom-code: - path: /pages/{page_id}/custom_code - method: DELETE - auth: true - docs: > - Delete the custom code block that an app has created for a page - - - In order to use the Custom Code APIs for Sites and Pages, Custom Code - Scripts must first be registered - - to a Site via the `registered_scripts` endpoints, and then applied to a - Site or Page using the appropriate - - `custom_code` endpoints. - - - Access to this endpoint requires a bearer token from a [Data - Client App](/data/docs/getting-started-data-clients). - - - Required scope | `custom_code:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - page_id: - type: string - docs: Unique identifier for a Page - display-name: Delete Custom Code - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - page_id: 63c720f9347c2139b248e552 - source: - openapi: ../../../openapi/referenced-specs/v2.yml diff --git a/.mock/definition/products.yml b/.mock/definition/products.yml deleted file mode 100644 index 4c6fcd1..0000000 --- a/.mock/definition/products.yml +++ /dev/null @@ -1,500 +0,0 @@ -imports: - root: __package__.yml -service: - auth: false - base-path: '' - endpoints: - list: - path: /sites/{site_id}/products - method: GET - auth: true - docs: > - Retrieve all products for a site. - - - Use `limit` and `offset` to page through all products with subsequent - requests. All SKUs for each product - - will also be fetched and returned. The `limit`, `offset` and `total` - values represent Products only and do not include any SKUs. - - - Required scope | `ecommerce:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: List Products & SKUs - request: - name: ProductsListRequest - query-parameters: - offset: - type: optional - docs: >- - Offset used for pagination if the results have more than limit - records - limit: - type: optional - docs: 'Maximum number of records to be returned (max limit: 100)' - response: - docs: Request was successful - type: root.ProductAndSkUsList - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.ConflictError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - response: - body: - items: - - product: - id: 660eb7a486d1d6e0412292d7 - cmsLocaleId: 653ad57de882f528b32e810e - lastPublished: '2024-04-04T14:24:19Z' - lastUpdated: '2024-04-04T14:30:19Z' - createdOn: '2024-04-04T14:22:28Z' - isArchived: false - isDraft: false - fieldData: - name: T-Shirt - slug: t-shirt - description: A plain cotton t-shirt. - shippable: true - sku-properties: - - id: Color - name: Color - enum: - - id: id - name: Royal Blue - slug: royal-blue - skus: - - id: 580e63fc8c9a982ac9b8b745 - cmsLocaleId: 653ad57de882f528b32e810e - lastPublished: '2023-03-17T18:47:35Z' - lastUpdated: '2023-03-17T18:47:35Z' - createdOn: '2023-03-17T18:47:35Z' - fieldData: - sku-values: - ff42fee0113744f693a764e3431a9cc2: 64a74715c456e36762fc39a1 - name: Blue T-shirt - slug: t-shirt-blue - price: - value: 100 - unit: USD - quantity: 10 - pagination: - limit: 100 - offset: 0 - total: 100 - create: - path: /sites/{site_id}/products - method: POST - auth: true - docs: > - Create a new product and SKU. - - - When you create a product, you will always create a SKU, since a Product - Item must have, at minimum, a single SKU. - - - To create a Product with multiple SKUs - for example a T-shirt in sizes - small, medium and large: - - Create parameters in `sku-properties`, also known as [product options and variants.](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants). - - A single `sku-property` would be `color`. Within the `color` property, list the various colors of T-shirts as an array of `enum` values: `royal-blue`, `crimson-red`, and `forrest-green`. - - Once, you've created a Product and its `sku-properties` with `enum` values, Webflow will create a **default SKU**, which will automatically be a combination of the first `sku-properties` you've created. - - In our example, the default SKU will be a Royal Blue T-Shirt, because our first `enum` of our Color `sku-property` is Royal Blue. - - After you've created your product, you can create additional SKUs using the [Create SKU endpoint.](/data/reference/ecommerce/products/create-sku) - - Upon creation, the default product type will be `Advanced`, which - ensures all Product and SKU fields will be shown to users in the - Designer. - - - Required scope | `ecommerce:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: Create Product & SKU - request: - name: ProductSkuCreate - body: - properties: - publishStatus: optional - product: optional - sku: optional - content-type: application/json - response: - docs: Request was successful - type: root.ProductAndSkUs - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.ConflictError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - request: {} - response: - body: - product: - id: 660eb7a486d1d6e0412292d7 - cmsLocaleId: 653ad57de882f528b32e810e - lastPublished: '2024-04-04T14:24:19Z' - lastUpdated: '2024-04-04T14:30:19Z' - createdOn: '2024-04-04T14:22:28Z' - isArchived: false - isDraft: false - fieldData: - name: T-Shirt - slug: t-shirt - description: A plain cotton t-shirt. - shippable: true - sku-properties: - - id: Color - name: Color - enum: - - id: id - name: Royal Blue - slug: royal-blue - categories: - - categories - tax-category: standard-taxable - default-sku: default-sku - ec-product-type: ff42fee0113744f693a764e3431a9cc2 - skus: - - id: 580e63fc8c9a982ac9b8b745 - cmsLocaleId: 653ad57de882f528b32e810e - lastPublished: '2023-03-17T18:47:35Z' - lastUpdated: '2023-03-17T18:47:35Z' - createdOn: '2023-03-17T18:47:35Z' - fieldData: - sku-values: - ff42fee0113744f693a764e3431a9cc2: 64a74715c456e36762fc39a1 - name: Blue T-shirt - slug: t-shirt-blue - price: - value: 100 - unit: USD - quantity: 10 - get: - path: /sites/{site_id}/products/{product_id} - method: GET - auth: true - docs: | - Retrieve a single product by its ID. All of its SKUs will also be - retrieved. - - Required scope | `ecommerce:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - product_id: - type: string - docs: Unique identifier for a Product - display-name: Get Product and SKUs - response: - docs: Request was successful - type: root.ProductAndSkUs - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.ConflictError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - product_id: 580e63fc8c9a982ac9b8b745 - response: - body: - product: - id: 660eb7a486d1d6e0412292d7 - cmsLocaleId: 653ad57de882f528b32e810e - lastPublished: '2024-04-04T14:24:19Z' - lastUpdated: '2024-04-04T14:30:19Z' - createdOn: '2024-04-04T14:22:28Z' - isArchived: false - isDraft: false - fieldData: - name: T-Shirt - slug: t-shirt - description: A plain cotton t-shirt. - shippable: true - sku-properties: - - id: Color - name: Color - enum: - - id: id - name: Royal Blue - slug: royal-blue - categories: - - categories - tax-category: standard-taxable - default-sku: default-sku - ec-product-type: ff42fee0113744f693a764e3431a9cc2 - skus: - - id: 580e63fc8c9a982ac9b8b745 - cmsLocaleId: 653ad57de882f528b32e810e - lastPublished: '2023-03-17T18:47:35Z' - lastUpdated: '2023-03-17T18:47:35Z' - createdOn: '2023-03-17T18:47:35Z' - fieldData: - sku-values: - ff42fee0113744f693a764e3431a9cc2: 64a74715c456e36762fc39a1 - name: Blue T-shirt - slug: t-shirt-blue - price: - value: 100 - unit: USD - quantity: 10 - update: - path: /sites/{site_id}/products/{product_id} - method: PATCH - auth: true - docs: > - Update an existing Product. - - - Updating an existing Product will set the product type to `Advanced`, - which ensures all Product and SKU fields will be shown to users in the - Designer. - - - Required scope | `ecommerce:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - product_id: - type: string - docs: Unique identifier for a Product - display-name: Update Product - request: - name: ProductSkuUpdate - body: - properties: - publishStatus: optional - product: optional - sku: optional - content-type: application/json - response: - docs: Request was successful - type: root.Product - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.ConflictError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - product_id: 580e63fc8c9a982ac9b8b745 - request: {} - response: - body: - id: 660eb7a486d1d6e0412292d7 - cmsLocaleId: 653ad57de882f528b32e810e - lastPublished: '2024-04-04T14:24:19Z' - lastUpdated: '2024-04-04T14:30:19Z' - createdOn: '2024-04-04T14:22:28Z' - isArchived: false - isDraft: false - fieldData: - name: T-Shirt - slug: t-shirt - description: A plain cotton t-shirt. - shippable: true - sku-properties: - - id: Color - name: Color - enum: - - id: id - name: Royal Blue - slug: royal-blue - categories: - - categories - tax-category: standard-taxable - default-sku: default-sku - ec-product-type: ff42fee0113744f693a764e3431a9cc2 - create-sku: - path: /sites/{site_id}/products/{product_id}/skus - method: POST - auth: true - docs: > - Create additional SKUs to manage every [option and variant of your - Product.](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants) - - - Creating SKUs through the API will set the product type to `Advanced`, - which ensures all Product and SKU fields will be shown to users in the - Designer. - - - Required scope | `ecommerce:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - product_id: - type: string - docs: Unique identifier for a Product - display-name: Create SKU - request: - name: ProductsCreateSkuRequest - body: - properties: - publishStatus: optional - skus: - docs: An array of the SKU data your are adding - type: list - content-type: application/json - response: - docs: Request was successful - type: ProductsCreateSkuResponse - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.ConflictError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - product_id: 580e63fc8c9a982ac9b8b745 - request: - skus: - - {} - response: - body: - skus: - - id: 580e63fc8c9a982ac9b8b745 - cmsLocaleId: 653ad57de882f528b32e810e - lastPublished: '2023-03-17T18:47:35Z' - lastUpdated: '2023-03-17T18:47:35Z' - createdOn: '2023-03-17T18:47:35Z' - fieldData: - sku-values: - ff42fee0113744f693a764e3431a9cc2: 64a74715c456e36762fc39a1 - name: Blue T-shirt - slug: t-shirt-blue - price: - value: 100 - unit: USD - quantity: 10 - update-sku: - path: /sites/{site_id}/products/{product_id}/skus/{sku_id} - method: PATCH - auth: true - docs: > - Update a specified SKU. - - - Updating an existing SKU will set the Product type to `Advanced`, which - ensures all Product and SKU fields will be shown to users in the - Designer. - - - Required scope | `ecommerce:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - product_id: - type: string - docs: Unique identifier for a Product - sku_id: - type: string - docs: Unique identifier for a SKU - display-name: Update SKU - request: - name: ProductsUpdateSkuRequest - body: - properties: - publishStatus: optional - sku: root.Sku - content-type: application/json - response: - docs: Request was successful - type: root.Sku - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.ConflictError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - product_id: 580e63fc8c9a982ac9b8b745 - sku_id: 5e8518516e147040726cc415 - request: - sku: {} - response: - body: - id: 580e63fc8c9a982ac9b8b745 - cmsLocaleId: 653ad57de882f528b32e810e - lastPublished: '2023-03-17T18:47:35Z' - lastUpdated: '2023-03-17T18:47:35Z' - createdOn: '2023-03-17T18:47:35Z' - fieldData: - sku-values: - ff42fee0113744f693a764e3431a9cc2: 64a74715c456e36762fc39a1 - name: Blue T-shirt - slug: t-shirt-blue - price: - value: 100 - unit: USD - compare-at-price: - value: 100 - unit: USD - ec-sku-billing-method: one-time - ec-sku-subscription-plan: - interval: day - frequency: 1 - trial: 7 - plans: - - {} - track-inventory: true - quantity: 10 - source: - openapi: ../../../openapi/referenced-specs/v2.yml -types: - ProductsCreateSkuResponse: - properties: - skus: optional> - source: - openapi: ../../../openapi/referenced-specs/v2.yml diff --git a/.mock/definition/scripts.yml b/.mock/definition/scripts.yml deleted file mode 100644 index 8236ed2..0000000 --- a/.mock/definition/scripts.yml +++ /dev/null @@ -1,253 +0,0 @@ -imports: - root: __package__.yml -service: - auth: false - base-path: '' - endpoints: - list: - path: /sites/{site_id}/registered_scripts - method: GET - auth: true - docs: > - List of scripts registered to a Site. - - - In order to use the Custom Code APIs for Sites and Pages, Custom Code - Scripts must first be registered - - to a Site via the `registered_scripts` endpoints, and then applied to a - Site or Page using the appropriate - - `custom_code` endpoints. - - Additionally, Scripts can be remotely hosted, or registered as inline - snippets. - - - Access to this endpoint requires a bearer token from a [Data - Client App](/data/docs/getting-started-data-clients). - - - Required scope | `custom_code:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: Get Registered Scripts - response: - docs: Request was successful - type: root.RegisteredScriptList - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - response: - body: - registeredScripts: - - id: alert - canCopy: false - displayName: Alert - hostedLocation: https://cdn.webflow.io/.../alert-0.0.1.js - integrityHash: integrityHash - createdOn: '2022-10-26T00:28:54.191Z' - lastUpdated: lastUpdated - version: 0.0.1 - - id: alert - canCopy: false - displayName: Alert - hostedLocation: https://cdn.webflow.io/.../alert-0.0.2.js - integrityHash: integrityHash - createdOn: '2022-10-26T00:28:54.191Z' - lastUpdated: lastUpdated - version: 0.0.2 - - id: cms_slider - canCopy: true - displayName: CMS Slider - hostedLocation: https://cdn.jsdelivr.net/.../cms_slider.js - integrityHash: >- - sha384-J+YlJ8v0gpaRoKH7SbFbEmxOZlAxLiwNjfSsBhDooGa5roXlPPpXbEevck4J7YZ+ - createdOn: '2022-10-26T00:28:54.191Z' - lastUpdated: lastUpdated - version: 1.0.0 - register-hosted: - path: /sites/{site_id}/registered_scripts/hosted - method: POST - auth: true - docs: > - Add a script to a Site's Custom Code registry. - - - In order to use the Custom Code APIs for Sites and Pages, Custom Code - Scripts must first be registered - - to a Site via the `registered_scripts` endpoints, and then applied to a - Site or Page using the appropriate - - `custom_code` endpoints. - - Additionally, Scripts can be remotely hosted, or registered as inline - snippets. - - - Access to this endpoint requires a bearer token from a [Data - Client App](/data/docs/getting-started-data-clients). - - - Required scope | `custom_code:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: Register Script - Hosted - request: - name: CustomCodeHostedRequest - body: - properties: - hostedLocation: - type: string - docs: URI for an externally hosted script location - integrityHash: - type: string - docs: Sub-Resource Integrity Hash - canCopy: - type: optional - docs: >- - Define whether the script can be copied on site duplication and - transfer - default: false - version: - type: string - docs: >- - A Semantic Version (SemVer) string, denoting the version of the - script - displayName: - type: string - docs: >- - User-facing name for the script. Must be between 1 and 50 - alphanumeric characters - content-type: application/json - response: - docs: Request was successful - type: root.CustomCodeHostedResponse - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - request: - hostedLocation: hostedLocation - integrityHash: integrityHash - version: version - displayName: displayName - response: - body: - id: cms_slider - canCopy: true - displayName: CMS Slider - hostedLocation: https://cdn.jsdelivr.net/.../cmsslider.js - integrityHash: >- - sha384-J+YlJ8v0gpaRoKH7SbFbEmxOZlAxLiwNjfSsBhDooGa5roXlPPpXbEevck4J7YZ+ - createdOn: '2022-10-26T00:28:54.191Z' - lastUpdated: lastUpdated - version: 1.0.0 - register-inline: - path: /sites/{site_id}/registered_scripts/inline - method: POST - auth: true - docs: > - Add a script to a Site's Custom Code registry. Inline scripts can be - between 1 and 2000 characters. - - - In order to use the Custom Code APIs for Sites and Pages, Custom Code - Scripts must first be registered - - to a Site via the `registered_scripts` endpoints, and then applied to a - Site or Page using the appropriate - - `custom_code` endpoints. - - - Access to this endpoint requires a bearer token from a [Data - Client App](/data/docs/getting-started-data-clients). - - - Required scope | `custom_code:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: Register Script - Inline - request: - name: CustomCodeInlineRequest - body: - properties: - sourceCode: - type: string - docs: The code to be added to the site (to be hosted by Webflow). - integrityHash: - type: optional - docs: >- - Sub-Resource Integrity Hash. Only required for externally hosted - scripts (passed via hostedLocation) - canCopy: - type: optional - docs: >- - Define whether the script can be copied on site duplication and - transfer - default: false - version: - type: string - docs: >- - A Semantic Version (SemVer) string, denoting the version of the - script - displayName: - type: string - docs: >- - User-facing name for the script. Must be between 1 and 50 - alphanumeric characters - content-type: application/json - response: - docs: Created - type: root.CustomCodeInlineResponse - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - request: - sourceCode: alert('hello world'); - version: 0.0.1 - displayName: Alert - response: - body: - id: alert - canCopy: false - displayName: Alert - hostedLocation: >- - https://uploads-ssl.webflow.com/6258612d1ee792848f805dcf%2F64b6c769ff52ba6c3d904a91%2F660d6e15b3d1696f2d2b1447%2Falert-0.0.1.js - integrityHash: integrityHash - createdOn: '2022-10-26T00:28:54.191Z' - lastUpdated: lastUpdated - version: 0.0.1 - source: - openapi: ../../../openapi/referenced-specs/v2.yml diff --git a/.mock/definition/sites.yml b/.mock/definition/sites.yml deleted file mode 100644 index cea8997..0000000 --- a/.mock/definition/sites.yml +++ /dev/null @@ -1,495 +0,0 @@ -imports: - root: __package__.yml -service: - auth: false - base-path: '' - endpoints: - create: - path: /workspaces/{workspace_id}/sites - method: POST - auth: true - docs: | - Create a site. This endpoint requires an Enterprise workspace. - - Required scope | `workspace:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - workspace_id: - type: string - docs: Unique identifier for a Workspace - display-name: Create Site - request: - name: SitesCreateRequest - body: - properties: - name: - type: string - docs: The name of the site - templateName: - type: optional - docs: The workspace or marketplace template to use - parentFolderId: - type: optional - docs: MegaDodo Publications - Potential Book Ideas - content-type: application/json - response: - docs: Request was successful - type: root.Site - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - name: NewlyCreatedSite - path-parameters: - workspace_id: 580e63e98c9a982ac9b8b741 - request: - name: The Hitchhiker's Guide to the Galaxy - response: - body: - id: 670ecf86817e3cc7a510eb6a - workspaceId: 625860a7a6c16d624927122f - createdOn: '2024-10-15T20:24:38Z' - displayName: The Hitchiker‘s Guide - shortName: hitchikers-guide - lastPublished: '2016-10-24T19:43:17Z' - lastUpdated: '2024-10-15T20:24:38Z' - previewUrl: >- - https://d1otoma47x30pg.cloudfront.net/580e63e98c9a982ac9b8b741/201610241243.png - timeZone: America/Los_Angeles - parentFolderId: 670ece123598db72d9648be1 - customDomains: - - id: 589a331aa51e760df7ccb89d - url: test-api-domain.com - lastPublished: '2022-12-07T16:51:37Z' - locales: - primary: - id: 653fd9af6a07fc9cfd7a5e57 - cmsLocaleId: 653ad57de882f528b32e810e - enabled: false - displayName: English (United States) - displayImageId: displayImageId - redirect: true - subdirectory: '' - tag: en-US - secondary: - - id: 653fd9af6a07fc9cfd7a5e57 - cmsLocaleId: 653ad57de882f528b32e810e - enabled: false - displayName: English (United States) - redirect: true - subdirectory: '' - tag: en-US - dataCollectionEnabled: false - dataCollectionType: always - list: - path: /sites - method: GET - auth: true - docs: | - List of all sites the provided access token is able to access. - - Required scope | `sites:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - display-name: List Sites - response: - docs: Request was successful - type: root.Sites - errors: - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - examples: - - response: - body: - sites: - - id: 42e63e98c9a982ac9b8b741 - workspaceId: 42e63fc8c9a982ac9b8b744 - createdOn: '1979-10-12T12:00:00Z' - displayName: Heart of Gold Spaceship - shortName: heart-of-gold - lastPublished: '2023-04-02T12:42:00Z' - lastUpdated: '2016-10-24T19:43:17Z' - previewUrl: >- - https://d1otoma47x30pg.cloudfront.net/42e63e98c9a982ac9b8b741/197910121200.png - timeZone: DeepSpace/InfiniteImprobability - parentFolderId: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6 - customDomains: - - id: 589a331aa51e760df7ccb89e - url: heartofgold.galaxy - lastPublished: '2022-12-07T16:51:37Z' - locales: - primary: - id: 653fd9af6a07fc9cfd7a5e57 - cmsLocaleId: 653ad57de882f528b32e810e - enabled: true - displayName: English - Heart of Gold Standard - redirect: false - subdirectory: /en - tag: The Ultimate Answer - secondary: - - id: 653fd9af6a07fc9cfd7a5e58 - cmsLocaleId: 653ad57de882f528b32e810g - enabled: true - displayName: Betelgeusian - Vogon Liaison - redirect: true - subdirectory: /bet - tag: Vogon - - id: 653fd9af6a07fc9cfd7a5e59 - cmsLocaleId: 653ad57de882f528b32e810h - enabled: false - displayName: Magrathean - Custom Planet Designs - redirect: true - subdirectory: /mg - tag: Magrathean - dataCollectionEnabled: true - dataCollectionType: always - - id: 42e63e98c9a982ac9b8b742 - workspaceId: 42e63fc8c9a982ac9b8b745 - createdOn: '1981-10-12T12:00:00Z' - displayName: Marvin's Personal Blog - shortName: paranoid-android - lastPublished: '2023-04-02T12:45:00Z' - lastUpdated: '2016-10-24T19:43:17Z' - previewUrl: >- - https://d1otoma47x30pg.cloudfront.net/42e63e98c9a982ac9b8b742/198110121200.png - timeZone: DeepSpace/Depression - parentFolderId: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6 - customDomains: - - id: 589a331aa51e760df7ccb89f - url: marvin.blog - lastPublished: '2022-12-07T16:51:37Z' - locales: - primary: - id: 653fd9af6a07fc9cfd7a5e57 - cmsLocaleId: 653ad57de882f528b32e810e - enabled: true - displayName: English - Marvin's Musings - redirect: false - subdirectory: /en - tag: English - secondary: - - id: 653fd9af6a07fc9cfd7a5e56 - cmsLocaleId: 653ad57de882f528b32e810f - enabled: true - displayName: Squornshellous - Mattress Speak - redirect: true - subdirectory: /sr - tag: Squornshellous - dataCollectionEnabled: true - dataCollectionType: always - - id: 42e63e98c9a982ac9b8b743 - workspaceId: 42e63fc8c9a982ac9b8b746 - createdOn: '1982-10-12T12:00:00Z' - displayName: Vogon Poetry Archive - shortName: vogon-poetry - lastPublished: '2023-04-02T12:50:00Z' - lastUpdated: '2016-10-24T19:43:17Z' - previewUrl: >- - https://d1otoma47x30pg.cloudfront.net/42e63e98c9a982ac9b8b743/198210121200.png - timeZone: Vogsphere/PoetryHall - parentFolderId: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6 - customDomains: - - id: 589a331aa51e760df7ccb8a0 - url: vogonpoetry.galaxy - lastPublished: '2022-12-07T16:51:37Z' - locales: - primary: - id: 653fd9af6a07fc9cfd7a5e55 - cmsLocaleId: 653ad57de882f528b32e810d - enabled: true - displayName: English - Vogon Verse - redirect: false - subdirectory: /en - tag: Third Worst Poetry - secondary: - - id: 653fd9af6a07fc9cfd7a5e54 - cmsLocaleId: 653ad57de882f528b32e810c - enabled: true - displayName: Galactic - Universal Language - redirect: true - subdirectory: /gl - tag: Pan-Galactic Gargle Blaster - dataCollectionEnabled: true - dataCollectionType: always - get: - path: /sites/{site_id} - method: GET - auth: true - docs: | - Get details of a site. - - Required scope | `sites:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: Get Site - response: - docs: Request was successful - type: root.Site - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - response: - body: - id: 42e98c9a982ac9b8b742 - workspaceId: 42e63e98c9a982ac9b8b742 - createdOn: '1979-10-12T12:00:00Z' - displayName: The Hitchhiker's Guide to the Galaxy - shortName: hitchhikers-guide - lastPublished: '2023-04-02T12:42:00Z' - lastUpdated: '2023-04-02T12:42:00Z' - previewUrl: >- - https://screenshots.webflow.com/sites/6258612d1ee792848f805dcf/20231219211811_d5990556c743f33b7071300a03bf67e6.png - timeZone: Magrathea/FactoryFloor - parentFolderId: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6 - customDomains: - - id: 589a331aa51e760df7ccb89d - url: hitchhikersguide.galaxy - lastPublished: '2022-12-07T16:51:37Z' - - id: 589a331aa51e760df7ccb89e - url: heartofgold.spaceship - lastPublished: '2022-12-07T16:51:37Z' - locales: - primary: - id: 653fd9af6a07fc9cfd7a5e57 - cmsLocaleId: 653ad57de882f528b32e810e - enabled: false - displayName: English (United States) - displayImageId: displayImageId - redirect: true - subdirectory: '' - tag: en-US - secondary: - - id: 653fd9af6a07fc9cfd7a5e57 - cmsLocaleId: 653ad57de882f528b32e810e - enabled: false - displayName: English (United States) - redirect: true - subdirectory: '' - tag: en-US - dataCollectionEnabled: true - dataCollectionType: always - delete: - path: /sites/{site_id} - method: DELETE - auth: true - docs: | - Delete a site. This endpoint requires an Enterprise workspace. - - Required scope | `sites:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: Delete Site - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - update: - path: /sites/{site_id} - method: PATCH - auth: true - docs: | - Update a site. This endpoint requires an Enterprise workspace. - - Required scope | `sites:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: Update Site - request: - name: SitesUpdateRequest - body: - properties: - name: - type: optional - docs: The name of the site - parentFolderId: - type: optional - docs: The parent folder ID of the site - content-type: application/json - response: - docs: Request was successful - type: root.Site - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - request: {} - response: - body: - id: 42e98c9a982ac9b8b742 - workspaceId: 42e63e98c9a982ac9b8b742 - createdOn: '1979-10-12T12:00:00Z' - displayName: The Hitchhiker's Guide to the Galaxy - shortName: hitchhikers-guide - lastPublished: '2023-04-02T12:42:00Z' - lastUpdated: '2023-04-02T12:42:00Z' - previewUrl: >- - https://screenshots.webflow.com/sites/6258612d1ee792848f805dcf/20231219211811_d5990556c743f33b7071300a03bf67e6.png - timeZone: Magrathea/FactoryFloor - parentFolderId: 1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6 - customDomains: - - id: 589a331aa51e760df7ccb89d - url: hitchhikersguide.galaxy - lastPublished: '2022-12-07T16:51:37Z' - - id: 589a331aa51e760df7ccb89e - url: heartofgold.spaceship - lastPublished: '2022-12-07T16:51:37Z' - locales: - primary: - id: 653fd9af6a07fc9cfd7a5e57 - cmsLocaleId: 653ad57de882f528b32e810e - enabled: false - displayName: English (United States) - displayImageId: displayImageId - redirect: true - subdirectory: '' - tag: en-US - secondary: - - id: 653fd9af6a07fc9cfd7a5e57 - cmsLocaleId: 653ad57de882f528b32e810e - enabled: false - displayName: English (United States) - redirect: true - subdirectory: '' - tag: en-US - dataCollectionEnabled: true - dataCollectionType: always - get-custom-domain: - path: /sites/{site_id}/custom_domains - method: GET - auth: true - docs: | - Get a list of all custom domains related to site. - - Required scope | `sites:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: Get Custom Domains - response: - docs: Request was successful - type: root.Domains - errors: - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - response: - body: - customDomains: - - id: 589a331aa51e760df7ccb89d - url: hitchhikersguide.galaxy - lastPublished: '2022-12-07T16:51:37Z' - - id: 589a331aa51e760df7ccb89e - url: heartofgold.spaceship - lastPublished: '2022-12-07T16:51:37Z' - publish: - path: /sites/{site_id}/publish - method: POST - auth: true - docs: > - Publishes a site to one or more more domains. - - - This endpoint has a limit of - one successful publish queue per minute. - - - Required scope | `sites:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: Publish Site - request: - name: SitesPublishRequest - body: - properties: - customDomains: - type: optional> - docs: Array of Custom Domain IDs to publish - publishToWebflowSubdomain: - type: optional - docs: Choice of whether to publish to the default Webflow Subdomain - default: false - content-type: application/json - response: - docs: Request accepted - type: SitesPublishResponse - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.TooManyRequestsError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - request: {} - response: - body: - customDomains: - - id: 589a331aa51e760df7ccb89d - url: test-api-domain.com - lastPublished: '2022-12-07T16:51:37Z' - publishToWebflowSubdomain: true - source: - openapi: ../../../openapi/referenced-specs/v2.yml - display-name: Sites -docs: Sites are the sites in your Webflow workspace. -types: - SitesPublishResponse: - properties: - customDomains: - type: optional> - docs: Array of domains objects - publishToWebflowSubdomain: - type: optional - docs: Flag for publishing to webflow.io subdomain - default: false - source: - openapi: ../../../openapi/referenced-specs/v2.yml diff --git a/.mock/definition/sites/activityLogs.yml b/.mock/definition/sites/activityLogs.yml deleted file mode 100644 index 1468f52..0000000 --- a/.mock/definition/sites/activityLogs.yml +++ /dev/null @@ -1,65 +0,0 @@ -imports: - root: ../__package__.yml -service: - auth: false - base-path: '' - endpoints: - list: - path: /sites/{site_id}/activity_logs - method: GET - auth: true - docs: >- - Retrieve Activity Logs for a specific Site. Requires Site to be on an - Enterprise plan.

Required scope | `site_activity:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: Get Site Activity Logs - request: - name: ActivityLogsListRequest - query-parameters: - limit: - type: optional - docs: 'Maximum number of records to be returned (max limit: 100)' - offset: - type: optional - docs: >- - Offset used for pagination if the results have more than limit - records - response: - docs: A list of site activity logs - type: root.SiteActivityLogResponse - errors: - - root.ForbiddenError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - response: - body: - items: - - id: 654c16c7b229e56bcf26872d - createdOn: '2023-11-08T23:16:23Z' - lastUpdated: '2023-11-08T23:16:23Z' - event: cms_collection - resourceOperation: CREATED - user: - id: 6509cd56e90eec668b009712 - displayName: John Doe - resourceId: 654c16c7b229e56bcf26870c - resourceName: foo-bar - newValue: newValue - previousValue: previousValue - payload: - key: value - pagination: - limit: 25 - offset: 0 - total: 1 - source: - openapi: ../../../openapi/referenced-specs/v2.yml diff --git a/.mock/definition/sites/plans.yml b/.mock/definition/sites/plans.yml deleted file mode 100644 index ae9de6d..0000000 --- a/.mock/definition/sites/plans.yml +++ /dev/null @@ -1,40 +0,0 @@ -imports: - root: ../__package__.yml -service: - auth: false - base-path: '' - endpoints: - get-site-plan: - path: /sites/{site_id}/plan - method: GET - auth: true - docs: | - Get site plan details for the specified Site. - - Required scope | `sites:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: Get Site Plan - response: - docs: Request was successful - type: root.SitePlan - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - response: - body: - id: hosting-business-v4 - name: Business Hosting - pricingInfo: https://webflow.com/pricing - source: - openapi: ../../../openapi/referenced-specs/v2.yml diff --git a/.mock/definition/sites/redirects.yml b/.mock/definition/sites/redirects.yml deleted file mode 100644 index b104d86..0000000 --- a/.mock/definition/sites/redirects.yml +++ /dev/null @@ -1,190 +0,0 @@ -imports: - root: ../__package__.yml -service: - auth: false - base-path: '' - endpoints: - list: - path: /sites/{site_id}/redirects - method: GET - auth: true - docs: > - Fetch a list of all URL redirect rules configured for a specific site. - - - Use this endpoint to review, audit, or manage the redirection rules that - control how traffic is rerouted on your site. - - - - Required scope: `sites:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: Get URL redirects - response: - docs: Request was successful - type: root.Redirects - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - response: - body: - redirects: - - id: 42e1a2b7aa1a13f768a0042a - fromUrl: /mostly-harmless - toUrl: /earth - - id: 6x9e7f8d9a4b1c2d3e4f5678 - fromUrl: /babel-fish - toUrl: /translate - pagination: - limit: 100 - offset: 0 - total: 2 - create: - path: /sites/{site_id}/redirects - method: POST - auth: true - docs: > - Add a new URL redirection rule to a site. - - - This endpoint allows you to define a source path (`fromUrl`) and its - corresponding destination path (`toUrl`), which will dictate how traffic - is rerouted on your site. This is useful for managing site changes, - restructuring URLs, or handling outdated links. - - - Required scope: `sites:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: Create a URL redirect - request: - body: root.Redirect - content-type: application/json - response: - docs: Request was successful - type: root.Redirect - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - request: - id: 42e1a2b7aa1a13f768a0042a - fromUrl: /mostly-harmless - toUrl: /earth - response: - body: - id: 42e1a2b7aa1a13f768a0042a - fromUrl: /mostly-harmless - toUrl: /earth - delete: - path: /sites/{site_id}/redirects/{redirect_id} - method: DELETE - auth: true - docs: > - Remove a URL redirection rule from a site. - - This is useful for cleaning up outdated or unnecessary redirects, - ensuring that your site's routing behavior remains efficient and - up-to-date. - - Required scope: `sites:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - redirect_id: - type: string - docs: Unique identifier site rediect - display-name: Delete URL redirects - response: - docs: Request was successful - type: root.Redirects - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - redirect_id: 66c4cb9a20cac35ed19500e6 - response: - body: - redirects: - - id: 42e1a2b7aa1a13f768a0042a - fromUrl: /mostly-harmless - toUrl: /earth - - id: 6x9e7f8d9a4b1c2d3e4f5678 - fromUrl: /babel-fish - toUrl: /translate - pagination: - limit: 100 - offset: 0 - total: 2 - update: - path: /sites/{site_id}/redirects/{redirect_id} - method: PATCH - auth: true - docs: | - Update a URL redirection rule from a site. - Required scope: `sites:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - redirect_id: - type: string - docs: Unique identifier site rediect - display-name: Update URL redirect - request: - body: root.Redirect - content-type: application/json - response: - docs: Request was successful - type: root.Redirect - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - redirect_id: 66c4cb9a20cac35ed19500e6 - request: - id: 42e1a2b7aa1a13f768a0042a - fromUrl: /mostly-harmless - toUrl: /earth - response: - body: - id: 42e1a2b7aa1a13f768a0042a - fromUrl: /mostly-harmless - toUrl: /earth - source: - openapi: ../../../openapi/referenced-specs/v2.yml diff --git a/.mock/definition/sites/scripts.yml b/.mock/definition/sites/scripts.yml deleted file mode 100644 index 92ad0e4..0000000 --- a/.mock/definition/sites/scripts.yml +++ /dev/null @@ -1,223 +0,0 @@ -imports: - root: ../__package__.yml -service: - auth: false - base-path: '' - endpoints: - get-custom-code: - path: /sites/{site_id}/custom_code - method: GET - auth: true - docs: > - Get all registered scripts that have been applied to a specific Site. - - - Access to this endpoint requires a bearer token from a [Data - Client App](/data/docs/getting-started-data-clients). - - - Required scope | `custom_code:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: Get Custom Code - response: - docs: Request was successful - type: root.ScriptApplyList - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - response: - body: - scripts: - - id: cms_slider - location: header - version: 1.0.0 - attributes: - my-attribute: some-value - - id: alert - location: header - version: 0.0.1 - attributes: - key: value - lastUpdated: '2022-10-26T00:28:54.191Z' - createdOn: '2022-10-26T00:28:54.191Z' - upsert-custom-code: - path: /sites/{site_id}/custom_code - method: PUT - auth: true - docs: > - Add a registered script to a Site. - - - In order to use the Custom Code APIs for Sites and Pages, Custom Code - Scripts must first be registered - - to a Site via the `registered_scripts` endpoints, and then applied to a - Site or Page using the appropriate - - `custom_code` endpoints. - - - Access to this endpoint requires a bearer token from a [Data - Client App](/data/docs/getting-started-data-clients). - - - Required scope | `custom_code:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: Add/Update Custom Code - request: - body: root.ScriptApplyList - content-type: application/json - response: - docs: Request was successful - type: root.ScriptApplyList - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - request: - scripts: - - id: cms_slider - location: header - version: 1.0.0 - attributes: - my-attribute: some-value - - id: alert - location: header - version: 0.0.1 - response: - body: - scripts: - - id: cms_slider - location: header - version: 1.0.0 - attributes: - my-attribute: some-value - - id: alert - location: header - version: 0.0.1 - attributes: - key: value - lastUpdated: lastUpdated - createdOn: createdOn - delete-custom-code: - path: /sites/{site_id}/custom_code - method: DELETE - auth: true - docs: > - Delete the custom code block that an app created for a Site - - - Access to this endpoint requires a bearer token from a [Data - Client App](/data/docs/getting-started-data-clients). - - - Required scope | `custom_code:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: Delete Custom Code - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - list-custom-code-blocks: - path: /sites/{site_id}/custom_code/blocks - method: GET - auth: true - docs: > - Get all instances of Custom Code applied to a Site or Pages. - - - Access to this endpoint requires a bearer token from a [Data - Client App](/data/docs/getting-started-data-clients). - - - Required scope | `custom_code:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: List Custom Code Blocks - request: - name: ScriptsListCustomCodeBlocksRequest - query-parameters: - offset: - type: optional - docs: >- - Offset used for pagination if the results have more than limit - records - limit: - type: optional - docs: 'Maximum number of records to be returned (max limit: 100)' - response: - docs: Request was successful - type: root.ListCustomCodeBlocks - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - response: - body: - blocks: - - siteId: 6258612d1ee792848f805dcf - pageId: pageId - type: site - scripts: - - id: chartjs - location: header - version: 4.4.2 - attributes: - key: value - createdOn: '2024-04-03T16:49:15Z' - lastUpdated: '2024-04-03T16:49:15Z' - - siteId: 6390c49674a71f84b51a08d8 - pageId: 6419db964a9c43f6a3af6348 - type: page - scripts: - - id: id - location: header - version: version - createdOn: '2022-10-26T00:28:54Z' - lastUpdated: '2022-10-26T00:28:54Z' - pagination: - limit: 10 - offset: 0 - total: 1 - source: - openapi: ../../../openapi/referenced-specs/v2.yml diff --git a/.mock/definition/token.yml b/.mock/definition/token.yml deleted file mode 100644 index 033c5c3..0000000 --- a/.mock/definition/token.yml +++ /dev/null @@ -1,72 +0,0 @@ -imports: - root: __package__.yml -service: - auth: false - base-path: '' - endpoints: - authorized-by: - path: /token/authorized_by - method: GET - auth: true - docs: | - Information about the Authorized User - - Required Scope | `authorized_user:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - display-name: Get Authorization User Info - response: - docs: Request was successful - type: root.AuthorizedUser - errors: - - root.UnauthorizedError - - root.ForbiddenError - examples: - - response: - body: - id: 545bbecb7bdd6769632504a7 - email: some@email.com - firstName: Some - lastName: One - introspect: - path: /token/introspect - method: GET - auth: true - docs: > - Information about the authorization token - - - Access to this endpoint requires a bearer token from a [Data - Client App](/data/docs/getting-started-data-clients). - source: - openapi: ../../../openapi/referenced-specs/v2.yml - display-name: Get Authorization Info - response: - docs: Request was successful - type: root.Authorization - errors: - - root.UnauthorizedError - examples: - - response: - body: - authorization: - id: 55818d58616600637b9a5786 - createdOn: '2016-10-03T23:12:00Z' - lastUsed: '2016-10-10T21:41:12Z' - grantType: authorization_code - rateLimit: 60 - scope: assets:read,assets:write - authorizedTo: - siteIds: - - 62f3b1f7eafac55d0c64ef91 - workspaceIds: - - 52f3b1f7eafac55d0c64ef91 - userIds: - - 545bbecb7bdd6769632504a7 - application: - id: 55131cd036c09f7d07883dfc - description: My Amazing App - homepage: https://webflow.com - displayName: My Amazing App - source: - openapi: ../../../openapi/referenced-specs/v2.yml diff --git a/.mock/definition/users.yml b/.mock/definition/users.yml deleted file mode 100644 index 19a17cc..0000000 --- a/.mock/definition/users.yml +++ /dev/null @@ -1,392 +0,0 @@ -types: - UsersListRequestSort: - enum: - - value: CreatedOn - name: CreatedOnAscending - docs: Sorts users in ascending order based on their created date - - value: '-CreatedOn' - name: CreatedOnDescending - docs: Sorts users in descending order based on their created date - - value: Email - name: EmailAscending - docs: Sorts users in ascending order based on their email - - value: '-Email' - name: EmailDescending - docs: Sorts users in descending order based on their email - - value: Status - name: StatusAscending - docs: Sorts users in ascending order based on their status - - value: '-Status' - name: StatusDescending - docs: Sorts users in descending order based on their status - - value: LastLogin - name: LastLoginAscending - docs: Sorts users in ascending order based on their last login date - - value: '-LastLogin' - name: LastLoginDescending - docs: Sorts users in descending order based on their last login date - - value: UpdatedOn - name: UpdatedOnAscending - docs: Sorts users in ascending order based on their update date - - value: '-UpdatedOn' - name: UpdatedOnDescending - docs: Sorts users in descending order based on their update date - source: - openapi: ../../../openapi/referenced-specs/v2.yml - UsersUpdateRequestData: - properties: - name: - type: optional - docs: | - The name of the user - accept-privacy: - type: optional - docs: | - Boolean indicating if the user has accepted the privacy policy - accept-communications: - type: optional - docs: | - Boolean indicating if the user has accepted to receive communications - source: - openapi: ../../../openapi/referenced-specs/v2.yml - inline: true -imports: - root: __package__.yml -service: - auth: false - base-path: '' - endpoints: - list: - path: /sites/{site_id}/users - method: GET - auth: true - docs: | - Get a list of users for a site - - Required scope | `users:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: List Users - request: - name: UsersListRequest - query-parameters: - offset: - type: optional - docs: >- - Offset used for pagination if the results have more than limit - records - limit: - type: optional - docs: 'Maximum number of records to be returned (max limit: 100)' - sort: - type: optional - docs: | - Sort string to use when ordering users - - Example(`CreatedOn`, `Email`, `Status`, `LastLogin`, `UpdatedOn`). - - Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) - response: - docs: Request was successful - type: root.UserList - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - response: - body: - count: 5 - limit: 5 - offset: 0 - total: 201 - users: - - id: 6287ec36a841b25637c663df - isEmailVerified: false - lastUpdated: '2022-05-20T13:46:12Z' - invitedOn: '2016-10-24T19:41:29Z' - createdOn: '2022-05-20T13:46:12Z' - lastLogin: '2016-10-24T19:41:29Z' - status: unverified - accessGroups: - - slug: vogon-construction-crew - type: admin - - id: 6287ec36a841b25637c663f0 - isEmailVerified: false - lastUpdated: '2022-05-19T05:32:04Z' - invitedOn: '2016-10-24T19:41:29Z' - createdOn: '2022-05-19T05:32:04Z' - lastLogin: '2016-10-24T19:41:29Z' - status: unverified - accessGroups: - - slug: improbability-drive-test-subjects - type: admin - - id: 6287ec36a841b25637c663d9 - isEmailVerified: true - lastUpdated: '2022-05-17T03:34:06Z' - invitedOn: '2016-10-24T19:41:29Z' - createdOn: '2022-05-17T03:34:06Z' - lastLogin: '2016-10-24T19:41:29Z' - status: verified - accessGroups: - - slug: heart-of-gold-crew - type: admin - - id: 6287ec37a841b25637c6641b - isEmailVerified: false - lastUpdated: '2022-05-15T03:46:09Z' - invitedOn: '2016-10-24T19:41:29Z' - createdOn: '2022-05-15T03:46:09Z' - lastLogin: '2016-10-24T19:41:29Z' - status: unverified - accessGroups: - - slug: hitchhikers-guide-research-team - type: admin - - id: 6287ec37a841b25637c66449 - isEmailVerified: true - lastUpdated: '2022-05-15T02:55:38Z' - invitedOn: '2016-10-24T19:41:29Z' - createdOn: '2022-05-15T02:55:38Z' - lastLogin: '2016-10-24T19:41:29Z' - status: verified - accessGroups: - - slug: milliways-reservationists - type: admin - get: - path: /sites/{site_id}/users/{user_id} - method: GET - auth: true - docs: | - Get a User by ID - - Required scope | `users:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - user_id: - type: string - docs: Unique identifier for a User - display-name: Get User - response: - docs: Request was successful - type: root.User - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - user_id: 580e63e98c9a982ac9b8b741 - response: - body: - id: 6287ec36a841b25637c663df - isEmailVerified: true - lastUpdated: '2022-05-20T13:46:12Z' - invitedOn: '2022-05-20T13:46:12Z' - createdOn: '2022-05-20T13:46:12Z' - lastLogin: '2022-05-20T13:46:12Z' - status: verified - accessGroups: - - slug: webflowers - type: admin - data: - data: - name: name - email: email - accept-privacy: true - accept-communications: true - additionalProperties: additionalProperties - delete: - path: /sites/{site_id}/users/{user_id} - method: DELETE - auth: true - docs: | - Delete a User by ID - - Required scope | `users:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - user_id: - type: string - docs: Unique identifier for a User - display-name: Delete User - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - user_id: 580e63e98c9a982ac9b8b741 - update: - path: /sites/{site_id}/users/{user_id} - method: PATCH - auth: true - docs: | - Update a User by ID - - Required scope | `users:write` - - The email and password - fields cannot be updated using this endpoint - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - user_id: - type: string - docs: Unique identifier for a User - display-name: Update User - request: - name: UsersUpdateRequest - body: - properties: - data: optional - accessGroups: - type: optional> - docs: > - An array of access group slugs. Access groups are assigned to - the user as type `admin` and the user remains in the group until - removed. - content-type: application/json - response: - docs: Request was successful - type: root.User - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - user_id: 580e63e98c9a982ac9b8b741 - request: - data: - name: Some One - accept-privacy: false - accept-communications: false - accessGroups: - - webflowers - - platinum - - free-tier - response: - body: - id: 6287ec36a841b25637c663df - isEmailVerified: true - lastUpdated: '2022-05-20T13:46:12Z' - invitedOn: '2022-05-20T13:46:12Z' - createdOn: '2022-05-20T13:46:12Z' - lastLogin: '2022-05-20T13:46:12Z' - status: verified - accessGroups: - - slug: webflowers - type: admin - data: - data: - name: name - email: email - accept-privacy: true - accept-communications: true - additionalProperties: additionalProperties - invite: - path: /sites/{site_id}/users/invite - method: POST - auth: true - docs: > - Create and invite a user with an email address. - - - The user will be sent and invite via email, which they will need to - accept in order to join paid any paid access group. - - - Required scope | `users:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: Create and Invite a User - request: - name: UsersInviteRequest - body: - properties: - email: - type: string - docs: Email address of user to send invite to - validation: - format: email - accessGroups: - type: optional> - docs: > - An array of access group slugs. Access groups are assigned to - the user as type `admin` and the user remains in the group until - removed. - content-type: application/json - response: - docs: Request was successful - type: root.User - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.ForbiddenError - - root.NotFoundError - - root.ConflictError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - request: - email: some.one@home.com - accessGroups: - - webflowers - response: - body: - id: 6287ec36a841b25637c663df - isEmailVerified: true - lastUpdated: '2022-05-20T13:46:12Z' - invitedOn: '2022-05-20T13:46:12Z' - createdOn: '2022-05-20T13:46:12Z' - lastLogin: '2022-05-20T13:46:12Z' - status: verified - accessGroups: - - slug: webflowers - type: admin - data: - data: - name: name - email: email - accept-privacy: true - accept-communications: true - additionalProperties: additionalProperties - source: - openapi: ../../../openapi/referenced-specs/v2.yml diff --git a/.mock/definition/webhooks.yml b/.mock/definition/webhooks.yml deleted file mode 100644 index d40e3e4..0000000 --- a/.mock/definition/webhooks.yml +++ /dev/null @@ -1,189 +0,0 @@ -imports: - root: __package__.yml -service: - auth: false - base-path: '' - endpoints: - list: - path: /sites/{site_id}/webhooks - method: GET - auth: true - docs: | - List all App-created Webhooks registered for a given site - - Required scope | `sites:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: List Webhooks - response: - docs: Request was successful - type: root.WebhookList - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - response: - body: - pagination: - limit: 100 - offset: 0 - total: 100 - webhooks: - - id: 57ca0a9e418c504a6e1acbb6 - triggerType: form_submission - url: https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f - workspaceId: 4f4e46fd476ea8c507000001 - siteId: 562ac0395358780a1f5e6fbd - filter: - name: Email Form - lastTriggered: '2023-02-08T23:59:28Z' - createdOn: '2016-09-02T23:26:22Z' - - id: 578d85cce0c47cd2865f4cf2 - triggerType: form_submission - url: https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f - workspaceId: 4f4e46fd476ea8c507000001 - siteId: 562ac0395358780a1f5e6fbd - filter: - name: Email Form - lastTriggered: '2023-02-08T23:59:28Z' - createdOn: '2016-07-19T01:43:40Z' - - id: 578d85cce0c47cd2865f4cf3 - triggerType: form_submission - url: https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f - workspaceId: 4f4e46fd476ea8c507000001 - siteId: 562ac0395358780a1f5e6fbd - filter: - name: Email Form - lastTriggered: '2023-02-08T23:59:28Z' - createdOn: '2016-07-19T01:43:40Z' - create: - path: /sites/{site_id}/webhooks - method: POST - auth: true - docs: > - Create a new Webhook. - - - Limit of 75 registrations per `triggerType`, per site. - - - Access to this endpoint requires a bearer token from a [Data - Client App](/data/docs/getting-started-data-clients). - - Required scope | `sites:write` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - site_id: - type: string - docs: Unique identifier for a Site - display-name: Create Webhook - request: - body: root.Webhook - content-type: application/json - response: - docs: Request was successful - type: root.Webhook - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - site_id: 580e63e98c9a982ac9b8b741 - request: - id: 582266e0cd48de0f0e3c6d8b - triggerType: form_submission - url: https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f - workspaceId: 4f4e46fd476ea8c507000001 - siteId: 562ac0395358780a1f5e6fbd - lastTriggered: '2023-02-08T23:59:28Z' - createdOn: '2022-11-08T23:59:28Z' - response: - body: - id: 582266e0cd48de0f0e3c6d8b - triggerType: form_submission - url: https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f - workspaceId: 4f4e46fd476ea8c507000001 - siteId: 562ac0395358780a1f5e6fbd - filter: - name: My Form - lastTriggered: '2023-02-08T23:59:28Z' - createdOn: '2022-11-08T23:59:28Z' - get: - path: /webhooks/{webhook_id} - method: GET - auth: true - docs: | - Get a specific Webhook instance - - Required scope: `sites:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - webhook_id: - type: string - docs: Unique identifier for a Webhook - display-name: Get Webhook - response: - docs: Request was successful - type: root.Webhook - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - webhook_id: 580e64008c9a982ac9b8b754 - response: - body: - id: 582266e0cd48de0f0e3c6d8b - triggerType: form_submission - url: https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f - workspaceId: 4f4e46fd476ea8c507000001 - siteId: 562ac0395358780a1f5e6fbd - filter: - name: My Form - lastTriggered: '2023-02-08T23:59:28Z' - createdOn: '2022-11-08T23:59:28Z' - delete: - path: /webhooks/{webhook_id} - method: DELETE - auth: true - docs: | - Remove a Webhook - - Required scope: `sites:read` - source: - openapi: ../../../openapi/referenced-specs/v2.yml - path-parameters: - webhook_id: - type: string - docs: Unique identifier for a Webhook - display-name: Remove Webhook - errors: - - root.BadRequestError - - root.UnauthorizedError - - root.NotFoundError - - root.TooManyRequestsError - - root.InternalServerError - examples: - - path-parameters: - webhook_id: 580e64008c9a982ac9b8b754 - source: - openapi: ../../../openapi/referenced-specs/v2.yml - display-name: Webhooks -docs: Webhooks are the webhooks in your Webflow site. diff --git a/.mock/fern.config.json b/.mock/fern.config.json deleted file mode 100644 index 8b3316e..0000000 --- a/.mock/fern.config.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "organization" : "webflow", - "version" : "0.46.19" -} \ No newline at end of file diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..eb82e56 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Webflow. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. \ No newline at end of file diff --git a/poetry.lock b/poetry.lock index a563308..83fdc8b 100644 --- a/poetry.lock +++ b/poetry.lock @@ -38,13 +38,13 @@ trio = ["trio (>=0.26.1)"] [[package]] name = "certifi" -version = "2024.12.14" +version = "2026.2.25" description = "Python package for providing Mozilla's CA Bundle." optional = false -python-versions = ">=3.6" +python-versions = ">=3.7" files = [ - {file = "certifi-2024.12.14-py3-none-any.whl", hash = "sha256:1275f7a45be9464efc1173084eaa30f866fe2e47d389406136d332ed4967ec56"}, - {file = "certifi-2024.12.14.tar.gz", hash = "sha256:b650d30f370c2b724812bee08008be0c4163b163ddaec3f2546c1caf65f191db"}, + {file = "certifi-2026.2.25-py3-none-any.whl", hash = "sha256:027692e4402ad994f1c42e52a4997a9763c646b73e4096e4d5d6db8af1d6f0fa"}, + {file = "certifi-2026.2.25.tar.gz", hash = "sha256:e887ab5cee78ea814d3472169153c2d12cd43b14bd03329a39a9c6e2e80bfba7"}, ] [[package]] @@ -60,43 +60,60 @@ files = [ [[package]] name = "exceptiongroup" -version = "1.2.2" +version = "1.3.1" description = "Backport of PEP 654 (exception groups)" optional = false python-versions = ">=3.7" files = [ - {file = "exceptiongroup-1.2.2-py3-none-any.whl", hash = "sha256:3111b9d131c238bec2f8f516e123e14ba243563fb135d3fe885990585aa7795b"}, - {file = "exceptiongroup-1.2.2.tar.gz", hash = "sha256:47c2edf7c6738fafb49fd34290706d1a1a2f4d1c6df275526b62cbb4aa5393cc"}, + {file = "exceptiongroup-1.3.1-py3-none-any.whl", hash = "sha256:a7a39a3bd276781e98394987d3a5701d0c4edffb633bb7a5144577f82c773598"}, + {file = "exceptiongroup-1.3.1.tar.gz", hash = "sha256:8b412432c6055b0b7d14c310000ae93352ed6754f70fa8f7c34141f91c4e3219"}, ] +[package.dependencies] +typing-extensions = {version = ">=4.6.0", markers = "python_version < \"3.13\""} + [package.extras] test = ["pytest (>=6)"] +[[package]] +name = "execnet" +version = "2.1.2" +description = "execnet: rapid multi-Python deployment" +optional = false +python-versions = ">=3.8" +files = [ + {file = "execnet-2.1.2-py3-none-any.whl", hash = "sha256:67fba928dd5a544b783f6056f449e5e3931a5c378b128bc18501f7ea79e296ec"}, + {file = "execnet-2.1.2.tar.gz", hash = "sha256:63d83bfdd9a23e35b9c6a3261412324f964c2ec8dcd8d3c6916ee9373e0befcd"}, +] + +[package.extras] +testing = ["hatch", "pre-commit", "pytest", "tox"] + [[package]] name = "h11" -version = "0.14.0" +version = "0.16.0" description = "A pure-Python, bring-your-own-I/O implementation of HTTP/1.1" optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "h11-0.14.0-py3-none-any.whl", hash = "sha256:e3fe4ac4b851c468cc8363d500db52c2ead036020723024a109d37346efaa761"}, - {file = "h11-0.14.0.tar.gz", hash = "sha256:8f19fbbe99e72420ff35c00b27a34cb9937e902a8b810e2c88300c6f0a3b699d"}, + {file = "h11-0.16.0-py3-none-any.whl", hash = "sha256:63cf8bbe7522de3bf65932fda1d9c2772064ffb3dae62d55932da54b31cb6c86"}, + {file = "h11-0.16.0.tar.gz", hash = "sha256:4e35b956cf45792e4caa5885e69fba00bdbc6ffafbfa020300e549b208ee5ff1"}, ] [[package]] name = "httpcore" -version = "1.0.7" +version = "1.0.9" description = "A minimal low-level HTTP client." optional = false python-versions = ">=3.8" files = [ - {file = "httpcore-1.0.7-py3-none-any.whl", hash = "sha256:a3fff8f43dc260d5bd363d9f9cf1830fa3a458b332856f34282de498ed420edd"}, - {file = "httpcore-1.0.7.tar.gz", hash = "sha256:8551cb62a169ec7162ac7be8d4817d561f60e08eaa485234898414bb5a8a0b4c"}, + {file = "httpcore-1.0.9-py3-none-any.whl", hash = "sha256:2d400746a40668fc9dec9810239072b40b4484b640a8c38fd654a024c7a1bf55"}, + {file = "httpcore-1.0.9.tar.gz", hash = "sha256:6e34463af53fd2ab5d807f399a9b45ea31c3dfa2276f15a2c3f00afff6e176e8"}, ] [package.dependencies] certifi = "*" -h11 = ">=0.13,<0.15" +h11 = ">=0.16" [package.extras] asyncio = ["anyio (>=4.0,<5.0)"] @@ -130,13 +147,13 @@ zstd = ["zstandard (>=0.18.0)"] [[package]] name = "idna" -version = "3.10" +version = "3.11" description = "Internationalized Domain Names in Applications (IDNA)" optional = false -python-versions = ">=3.6" +python-versions = ">=3.8" files = [ - {file = "idna-3.10-py3-none-any.whl", hash = "sha256:946d195a0d259cbba61165e88e65941f16e9b36ea6ddb97f00452bae8b1287d3"}, - {file = "idna-3.10.tar.gz", hash = "sha256:12f65c9b470abda6dc35cf8e63cc574b1c52b11df2c86030af0ac09b01b13ea9"}, + {file = "idna-3.11-py3-none-any.whl", hash = "sha256:771a87f49d9defaf64091e6e6fe9c18d4833f140bd19464795bc32d966ca37ea"}, + {file = "idna-3.11.tar.gz", hash = "sha256:795dafcc9c04ed0c1fb032c2aa73654d8e8c5023a7df64a53f39190ada629902"}, ] [package.extras] @@ -144,81 +161,88 @@ all = ["flake8 (>=7.1.1)", "mypy (>=1.11.2)", "pytest (>=8.3.2)", "ruff (>=0.6.2 [[package]] name = "iniconfig" -version = "2.0.0" +version = "2.1.0" description = "brain-dead simple config-ini parsing" optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "iniconfig-2.0.0-py3-none-any.whl", hash = "sha256:b6a85871a79d2e3b22d2d1b94ac2824226a63c6b741c88f7ae975f18b6778374"}, - {file = "iniconfig-2.0.0.tar.gz", hash = "sha256:2d91e135bf72d31a410b17c16da610a82cb55f6b0477d1a902134b24a455b8b3"}, + {file = "iniconfig-2.1.0-py3-none-any.whl", hash = "sha256:9deba5723312380e77435581c6bf4935c94cbfab9b1ed33ef8d238ea168eb760"}, + {file = "iniconfig-2.1.0.tar.gz", hash = "sha256:3abbd2e30b36733fee78f9c7f7308f2d0050e88f0087fd25c2645f63c773e1c7"}, ] [[package]] name = "mypy" -version = "1.0.1" +version = "1.13.0" description = "Optional static typing for Python" optional = false -python-versions = ">=3.7" +python-versions = ">=3.8" files = [ - {file = "mypy-1.0.1-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:71a808334d3f41ef011faa5a5cd8153606df5fc0b56de5b2e89566c8093a0c9a"}, - {file = "mypy-1.0.1-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:920169f0184215eef19294fa86ea49ffd4635dedfdea2b57e45cb4ee85d5ccaf"}, - {file = "mypy-1.0.1-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:27a0f74a298769d9fdc8498fcb4f2beb86f0564bcdb1a37b58cbbe78e55cf8c0"}, - {file = "mypy-1.0.1-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:65b122a993d9c81ea0bfde7689b3365318a88bde952e4dfa1b3a8b4ac05d168b"}, - {file = "mypy-1.0.1-cp310-cp310-win_amd64.whl", hash = "sha256:5deb252fd42a77add936b463033a59b8e48eb2eaec2976d76b6878d031933fe4"}, - {file = "mypy-1.0.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:2013226d17f20468f34feddd6aae4635a55f79626549099354ce641bc7d40262"}, - {file = "mypy-1.0.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:48525aec92b47baed9b3380371ab8ab6e63a5aab317347dfe9e55e02aaad22e8"}, - {file = "mypy-1.0.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:c96b8a0c019fe29040d520d9257d8c8f122a7343a8307bf8d6d4a43f5c5bfcc8"}, - {file = "mypy-1.0.1-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:448de661536d270ce04f2d7dddaa49b2fdba6e3bd8a83212164d4174ff43aa65"}, - {file = "mypy-1.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:d42a98e76070a365a1d1c220fcac8aa4ada12ae0db679cb4d910fabefc88b994"}, - {file = "mypy-1.0.1-cp37-cp37m-macosx_10_9_x86_64.whl", hash = "sha256:e64f48c6176e243ad015e995de05af7f22bbe370dbb5b32bd6988438ec873919"}, - {file = "mypy-1.0.1-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5fdd63e4f50e3538617887e9aee91855368d9fc1dea30da743837b0df7373bc4"}, - {file = "mypy-1.0.1-cp37-cp37m-musllinux_1_1_x86_64.whl", hash = "sha256:dbeb24514c4acbc78d205f85dd0e800f34062efcc1f4a4857c57e4b4b8712bff"}, - {file = "mypy-1.0.1-cp37-cp37m-win_amd64.whl", hash = "sha256:a2948c40a7dd46c1c33765718936669dc1f628f134013b02ff5ac6c7ef6942bf"}, - {file = "mypy-1.0.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:5bc8d6bd3b274dd3846597855d96d38d947aedba18776aa998a8d46fabdaed76"}, - {file = "mypy-1.0.1-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:17455cda53eeee0a4adb6371a21dd3dbf465897de82843751cf822605d152c8c"}, - {file = "mypy-1.0.1-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e831662208055b006eef68392a768ff83596035ffd6d846786578ba1714ba8f6"}, - {file = "mypy-1.0.1-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:e60d0b09f62ae97a94605c3f73fd952395286cf3e3b9e7b97f60b01ddfbbda88"}, - {file = "mypy-1.0.1-cp38-cp38-win_amd64.whl", hash = "sha256:0af4f0e20706aadf4e6f8f8dc5ab739089146b83fd53cb4a7e0e850ef3de0bb6"}, - {file = "mypy-1.0.1-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:24189f23dc66f83b839bd1cce2dfc356020dfc9a8bae03978477b15be61b062e"}, - {file = "mypy-1.0.1-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:93a85495fb13dc484251b4c1fd7a5ac370cd0d812bbfc3b39c1bafefe95275d5"}, - {file = "mypy-1.0.1-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:5f546ac34093c6ce33f6278f7c88f0f147a4849386d3bf3ae193702f4fe31407"}, - {file = "mypy-1.0.1-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:c6c2ccb7af7154673c591189c3687b013122c5a891bb5651eca3db8e6c6c55bd"}, - {file = "mypy-1.0.1-cp39-cp39-win_amd64.whl", hash = "sha256:15b5a824b58c7c822c51bc66308e759243c32631896743f030daf449fe3677f3"}, - {file = "mypy-1.0.1-py3-none-any.whl", hash = "sha256:eda5c8b9949ed411ff752b9a01adda31afe7eae1e53e946dbdf9db23865e66c4"}, - {file = "mypy-1.0.1.tar.gz", hash = "sha256:28cea5a6392bb43d266782983b5a4216c25544cd7d80be681a155ddcdafd152d"}, + {file = "mypy-1.13.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:6607e0f1dd1fb7f0aca14d936d13fd19eba5e17e1cd2a14f808fa5f8f6d8f60a"}, + {file = "mypy-1.13.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:8a21be69bd26fa81b1f80a61ee7ab05b076c674d9b18fb56239d72e21d9f4c80"}, + {file = "mypy-1.13.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:7b2353a44d2179846a096e25691d54d59904559f4232519d420d64da6828a3a7"}, + {file = "mypy-1.13.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:0730d1c6a2739d4511dc4253f8274cdd140c55c32dfb0a4cf8b7a43f40abfa6f"}, + {file = "mypy-1.13.0-cp310-cp310-win_amd64.whl", hash = "sha256:c5fc54dbb712ff5e5a0fca797e6e0aa25726c7e72c6a5850cfd2adbc1eb0a372"}, + {file = "mypy-1.13.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:581665e6f3a8a9078f28d5502f4c334c0c8d802ef55ea0e7276a6e409bc0d82d"}, + {file = "mypy-1.13.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:3ddb5b9bf82e05cc9a627e84707b528e5c7caaa1c55c69e175abb15a761cec2d"}, + {file = "mypy-1.13.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:20c7ee0bc0d5a9595c46f38beb04201f2620065a93755704e141fcac9f59db2b"}, + {file = "mypy-1.13.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:3790ded76f0b34bc9c8ba4def8f919dd6a46db0f5a6610fb994fe8efdd447f73"}, + {file = "mypy-1.13.0-cp311-cp311-win_amd64.whl", hash = "sha256:51f869f4b6b538229c1d1bcc1dd7d119817206e2bc54e8e374b3dfa202defcca"}, + {file = "mypy-1.13.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:5c7051a3461ae84dfb5dd15eff5094640c61c5f22257c8b766794e6dd85e72d5"}, + {file = "mypy-1.13.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:39bb21c69a5d6342f4ce526e4584bc5c197fd20a60d14a8624d8743fffb9472e"}, + {file = "mypy-1.13.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:164f28cb9d6367439031f4c81e84d3ccaa1e19232d9d05d37cb0bd880d3f93c2"}, + {file = "mypy-1.13.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:a4c1bfcdbce96ff5d96fc9b08e3831acb30dc44ab02671eca5953eadad07d6d0"}, + {file = "mypy-1.13.0-cp312-cp312-win_amd64.whl", hash = "sha256:a0affb3a79a256b4183ba09811e3577c5163ed06685e4d4b46429a271ba174d2"}, + {file = "mypy-1.13.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:a7b44178c9760ce1a43f544e595d35ed61ac2c3de306599fa59b38a6048e1aa7"}, + {file = "mypy-1.13.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:5d5092efb8516d08440e36626f0153b5006d4088c1d663d88bf79625af3d1d62"}, + {file = "mypy-1.13.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:de2904956dac40ced10931ac967ae63c5089bd498542194b436eb097a9f77bc8"}, + {file = "mypy-1.13.0-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:7bfd8836970d33c2105562650656b6846149374dc8ed77d98424b40b09340ba7"}, + {file = "mypy-1.13.0-cp313-cp313-win_amd64.whl", hash = "sha256:9f73dba9ec77acb86457a8fc04b5239822df0c14a082564737833d2963677dbc"}, + {file = "mypy-1.13.0-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:100fac22ce82925f676a734af0db922ecfea991e1d7ec0ceb1e115ebe501301a"}, + {file = "mypy-1.13.0-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:7bcb0bb7f42a978bb323a7c88f1081d1b5dee77ca86f4100735a6f541299d8fb"}, + {file = "mypy-1.13.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:bde31fc887c213e223bbfc34328070996061b0833b0a4cfec53745ed61f3519b"}, + {file = "mypy-1.13.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:07de989f89786f62b937851295ed62e51774722e5444a27cecca993fc3f9cd74"}, + {file = "mypy-1.13.0-cp38-cp38-win_amd64.whl", hash = "sha256:4bde84334fbe19bad704b3f5b78c4abd35ff1026f8ba72b29de70dda0916beb6"}, + {file = "mypy-1.13.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:0246bcb1b5de7f08f2826451abd947bf656945209b140d16ed317f65a17dc7dc"}, + {file = "mypy-1.13.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:7f5b7deae912cf8b77e990b9280f170381fdfbddf61b4ef80927edd813163732"}, + {file = "mypy-1.13.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:7029881ec6ffb8bc233a4fa364736789582c738217b133f1b55967115288a2bc"}, + {file = "mypy-1.13.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:3e38b980e5681f28f033f3be86b099a247b13c491f14bb8b1e1e134d23bb599d"}, + {file = "mypy-1.13.0-cp39-cp39-win_amd64.whl", hash = "sha256:a6789be98a2017c912ae6ccb77ea553bbaf13d27605d2ca20a76dfbced631b24"}, + {file = "mypy-1.13.0-py3-none-any.whl", hash = "sha256:9c250883f9fd81d212e0952c92dbfcc96fc237f4b7c92f56ac81fd48460b3e5a"}, + {file = "mypy-1.13.0.tar.gz", hash = "sha256:0291a61b6fbf3e6673e3405cfcc0e7650bebc7939659fdca2702958038bd835e"}, ] [package.dependencies] -mypy-extensions = ">=0.4.3" +mypy-extensions = ">=1.0.0" tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""} -typing-extensions = ">=3.10" +typing-extensions = ">=4.6.0" [package.extras] dmypy = ["psutil (>=4.0)"] +faster-cache = ["orjson"] install-types = ["pip"] -python2 = ["typed-ast (>=1.4.0,<2)"] +mypyc = ["setuptools (>=50)"] reports = ["lxml"] [[package]] name = "mypy-extensions" -version = "1.0.0" +version = "1.1.0" description = "Type system extensions for programs checked with the mypy type checker." optional = false -python-versions = ">=3.5" +python-versions = ">=3.8" files = [ - {file = "mypy_extensions-1.0.0-py3-none-any.whl", hash = "sha256:4392f6c0eb8a5668a69e23d168ffa70f0be9ccfd32b5cc2d26a34ae5b844552d"}, - {file = "mypy_extensions-1.0.0.tar.gz", hash = "sha256:75dbf8955dc00442a438fc4d0666508a9a97b6bd41aa2f0ffe9d2f2725af0782"}, + {file = "mypy_extensions-1.1.0-py3-none-any.whl", hash = "sha256:1be4cccdb0f2482337c4743e60421de3a356cd97508abadd57d47403e94f5505"}, + {file = "mypy_extensions-1.1.0.tar.gz", hash = "sha256:52e68efc3284861e772bbcd66823fde5ae21fd2fdb51c62a211403730b916558"}, ] [[package]] name = "packaging" -version = "24.2" +version = "26.0" description = "Core utilities for Python packages" optional = false python-versions = ">=3.8" files = [ - {file = "packaging-24.2-py3-none-any.whl", hash = "sha256:09abb1bccd265c01f4a3aa3f7a7db064b36514d2cba19a2f694fe6150451a759"}, - {file = "packaging-24.2.tar.gz", hash = "sha256:c228a6dc5e932d346bc5739379109d49e8853dd8223571c7c5b55260edc0b97f"}, + {file = "packaging-26.0-py3-none-any.whl", hash = "sha256:b36f1fef9334a5588b4166f8bcd26a14e521f2b55e6b9de3aaa80d3ff7a37529"}, + {file = "packaging-26.0.tar.gz", hash = "sha256:00243ae351a257117b6a241061796684b084ed1c516a08c48a3f7e147a9d80b4"}, ] [[package]] @@ -238,13 +262,13 @@ testing = ["pytest", "pytest-benchmark"] [[package]] name = "pydantic" -version = "2.10.5" +version = "2.10.6" description = "Data validation using Python type hints" optional = false python-versions = ">=3.8" files = [ - {file = "pydantic-2.10.5-py3-none-any.whl", hash = "sha256:4dd4e322dbe55472cb7ca7e73f4b63574eecccf2835ffa2af9021ce113c83c53"}, - {file = "pydantic-2.10.5.tar.gz", hash = "sha256:278b38dbbaec562011d659ee05f63346951b3a248a6f3642e1bc68894ea2b4ff"}, + {file = "pydantic-2.10.6-py3-none-any.whl", hash = "sha256:427d664bf0b8a2b34ff5dd0f5a18df00591adcee7198fbd71981054cef37b584"}, + {file = "pydantic-2.10.6.tar.gz", hash = "sha256:ca5daa827cce33de7a42be142548b0096bf05a7e7b365aebfa5f8eeec7128236"}, ] [package.dependencies] @@ -408,6 +432,26 @@ pytest = ">=7.0.0,<9" docs = ["sphinx (>=5.3)", "sphinx-rtd-theme (>=1.0)"] testing = ["coverage (>=6.2)", "hypothesis (>=5.7.1)"] +[[package]] +name = "pytest-xdist" +version = "3.6.1" +description = "pytest xdist plugin for distributed testing, most importantly across multiple CPUs" +optional = false +python-versions = ">=3.8" +files = [ + {file = "pytest_xdist-3.6.1-py3-none-any.whl", hash = "sha256:9ed4adfb68a016610848639bb7e02c9352d5d9f03d04809919e2dafc3be4cca7"}, + {file = "pytest_xdist-3.6.1.tar.gz", hash = "sha256:ead156a4db231eec769737f57668ef58a2084a34b2e55c4a8fa20d861107300d"}, +] + +[package.dependencies] +execnet = ">=2.1" +pytest = ">=7.0.0" + +[package.extras] +psutil = ["psutil (>=3.0)"] +setproctitle = ["setproctitle"] +testing = ["filelock"] + [[package]] name = "python-dateutil" version = "2.9.0.post0" @@ -424,29 +468,29 @@ six = ">=1.5" [[package]] name = "ruff" -version = "0.5.7" +version = "0.11.5" description = "An extremely fast Python linter and code formatter, written in Rust." optional = false python-versions = ">=3.7" files = [ - {file = "ruff-0.5.7-py3-none-linux_armv6l.whl", hash = "sha256:548992d342fc404ee2e15a242cdbea4f8e39a52f2e7752d0e4cbe88d2d2f416a"}, - {file = "ruff-0.5.7-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:00cc8872331055ee017c4f1071a8a31ca0809ccc0657da1d154a1d2abac5c0be"}, - {file = "ruff-0.5.7-py3-none-macosx_11_0_arm64.whl", hash = "sha256:eaf3d86a1fdac1aec8a3417a63587d93f906c678bb9ed0b796da7b59c1114a1e"}, - {file = "ruff-0.5.7-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a01c34400097b06cf8a6e61b35d6d456d5bd1ae6961542de18ec81eaf33b4cb8"}, - {file = "ruff-0.5.7-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:fcc8054f1a717e2213500edaddcf1dbb0abad40d98e1bd9d0ad364f75c763eea"}, - {file = "ruff-0.5.7-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:7f70284e73f36558ef51602254451e50dd6cc479f8b6f8413a95fcb5db4a55fc"}, - {file = "ruff-0.5.7-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:a78ad870ae3c460394fc95437d43deb5c04b5c29297815a2a1de028903f19692"}, - {file = "ruff-0.5.7-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:9ccd078c66a8e419475174bfe60a69adb36ce04f8d4e91b006f1329d5cd44bcf"}, - {file = "ruff-0.5.7-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:7e31c9bad4ebf8fdb77b59cae75814440731060a09a0e0077d559a556453acbb"}, - {file = "ruff-0.5.7-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:8d796327eed8e168164346b769dd9a27a70e0298d667b4ecee6877ce8095ec8e"}, - {file = "ruff-0.5.7-py3-none-musllinux_1_2_aarch64.whl", hash = "sha256:4a09ea2c3f7778cc635e7f6edf57d566a8ee8f485f3c4454db7771efb692c499"}, - {file = "ruff-0.5.7-py3-none-musllinux_1_2_armv7l.whl", hash = "sha256:a36d8dcf55b3a3bc353270d544fb170d75d2dff41eba5df57b4e0b67a95bb64e"}, - {file = "ruff-0.5.7-py3-none-musllinux_1_2_i686.whl", hash = "sha256:9369c218f789eefbd1b8d82a8cf25017b523ac47d96b2f531eba73770971c9e5"}, - {file = "ruff-0.5.7-py3-none-musllinux_1_2_x86_64.whl", hash = "sha256:b88ca3db7eb377eb24fb7c82840546fb7acef75af4a74bd36e9ceb37a890257e"}, - {file = "ruff-0.5.7-py3-none-win32.whl", hash = "sha256:33d61fc0e902198a3e55719f4be6b375b28f860b09c281e4bdbf783c0566576a"}, - {file = "ruff-0.5.7-py3-none-win_amd64.whl", hash = "sha256:083bbcbe6fadb93cd86709037acc510f86eed5a314203079df174c40bbbca6b3"}, - {file = "ruff-0.5.7-py3-none-win_arm64.whl", hash = "sha256:2dca26154ff9571995107221d0aeaad0e75a77b5a682d6236cf89a58c70b76f4"}, - {file = "ruff-0.5.7.tar.gz", hash = "sha256:8dfc0a458797f5d9fb622dd0efc52d796f23f0a1493a9527f4e49a550ae9a7e5"}, + {file = "ruff-0.11.5-py3-none-linux_armv6l.whl", hash = "sha256:2561294e108eb648e50f210671cc56aee590fb6167b594144401532138c66c7b"}, + {file = "ruff-0.11.5-py3-none-macosx_10_12_x86_64.whl", hash = "sha256:ac12884b9e005c12d0bd121f56ccf8033e1614f736f766c118ad60780882a077"}, + {file = "ruff-0.11.5-py3-none-macosx_11_0_arm64.whl", hash = "sha256:4bfd80a6ec559a5eeb96c33f832418bf0fb96752de0539905cf7b0cc1d31d779"}, + {file = "ruff-0.11.5-py3-none-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:0947c0a1afa75dcb5db4b34b070ec2bccee869d40e6cc8ab25aca11a7d527794"}, + {file = "ruff-0.11.5-py3-none-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:ad871ff74b5ec9caa66cb725b85d4ef89b53f8170f47c3406e32ef040400b038"}, + {file = "ruff-0.11.5-py3-none-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e6cf918390cfe46d240732d4d72fa6e18e528ca1f60e318a10835cf2fa3dc19f"}, + {file = "ruff-0.11.5-py3-none-manylinux_2_17_ppc64.manylinux2014_ppc64.whl", hash = "sha256:56145ee1478582f61c08f21076dc59153310d606ad663acc00ea3ab5b2125f82"}, + {file = "ruff-0.11.5-py3-none-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e5f66f8f1e8c9fc594cbd66fbc5f246a8d91f916cb9667e80208663ec3728304"}, + {file = "ruff-0.11.5-py3-none-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:80b4df4d335a80315ab9afc81ed1cff62be112bd165e162b5eed8ac55bfc8470"}, + {file = "ruff-0.11.5-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3068befab73620b8a0cc2431bd46b3cd619bc17d6f7695a3e1bb166b652c382a"}, + {file = "ruff-0.11.5-py3-none-musllinux_1_2_aarch64.whl", hash = "sha256:f5da2e710a9641828e09aa98b92c9ebbc60518fdf3921241326ca3e8f8e55b8b"}, + {file = "ruff-0.11.5-py3-none-musllinux_1_2_armv7l.whl", hash = "sha256:ef39f19cb8ec98cbc762344921e216f3857a06c47412030374fffd413fb8fd3a"}, + {file = "ruff-0.11.5-py3-none-musllinux_1_2_i686.whl", hash = "sha256:b2a7cedf47244f431fd11aa5a7e2806dda2e0c365873bda7834e8f7d785ae159"}, + {file = "ruff-0.11.5-py3-none-musllinux_1_2_x86_64.whl", hash = "sha256:81be52e7519f3d1a0beadcf8e974715b2dfc808ae8ec729ecfc79bddf8dbb783"}, + {file = "ruff-0.11.5-py3-none-win32.whl", hash = "sha256:e268da7b40f56e3eca571508a7e567e794f9bfcc0f412c4b607931d3af9c4afe"}, + {file = "ruff-0.11.5-py3-none-win_amd64.whl", hash = "sha256:6c6dc38af3cfe2863213ea25b6dc616d679205732dc0fb673356c2d69608f800"}, + {file = "ruff-0.11.5-py3-none-win_arm64.whl", hash = "sha256:67e241b4314f4eacf14a601d586026a962f4002a475aa702c69980a38087aa4e"}, + {file = "ruff-0.11.5.tar.gz", hash = "sha256:cae2e2439cb88853e421901ec040a758960b576126dab520fa08e9de431d1bef"}, ] [[package]] @@ -473,43 +517,58 @@ files = [ [[package]] name = "tomli" -version = "2.2.1" +version = "2.4.0" description = "A lil' TOML parser" optional = false python-versions = ">=3.8" files = [ - {file = "tomli-2.2.1-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:678e4fa69e4575eb77d103de3df8a895e1591b48e740211bd1067378c69e8249"}, - {file = "tomli-2.2.1-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:023aa114dd824ade0100497eb2318602af309e5a55595f76b626d6d9f3b7b0a6"}, - {file = "tomli-2.2.1-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:ece47d672db52ac607a3d9599a9d48dcb2f2f735c6c2d1f34130085bb12b112a"}, - {file = "tomli-2.2.1-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6972ca9c9cc9f0acaa56a8ca1ff51e7af152a9f87fb64623e31d5c83700080ee"}, - {file = "tomli-2.2.1-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:c954d2250168d28797dd4e3ac5cf812a406cd5a92674ee4c8f123c889786aa8e"}, - {file = "tomli-2.2.1-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:8dd28b3e155b80f4d54beb40a441d366adcfe740969820caf156c019fb5c7ec4"}, - {file = "tomli-2.2.1-cp311-cp311-musllinux_1_2_i686.whl", hash = "sha256:e59e304978767a54663af13c07b3d1af22ddee3bb2fb0618ca1593e4f593a106"}, - {file = "tomli-2.2.1-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:33580bccab0338d00994d7f16f4c4ec25b776af3ffaac1ed74e0b3fc95e885a8"}, - {file = "tomli-2.2.1-cp311-cp311-win32.whl", hash = "sha256:465af0e0875402f1d226519c9904f37254b3045fc5084697cefb9bdde1ff99ff"}, - {file = "tomli-2.2.1-cp311-cp311-win_amd64.whl", hash = "sha256:2d0f2fdd22b02c6d81637a3c95f8cd77f995846af7414c5c4b8d0545afa1bc4b"}, - {file = "tomli-2.2.1-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:4a8f6e44de52d5e6c657c9fe83b562f5f4256d8ebbfe4ff922c495620a7f6cea"}, - {file = "tomli-2.2.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:8d57ca8095a641b8237d5b079147646153d22552f1c637fd3ba7f4b0b29167a8"}, - {file = "tomli-2.2.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:4e340144ad7ae1533cb897d406382b4b6fede8890a03738ff1683af800d54192"}, - {file = "tomli-2.2.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:db2b95f9de79181805df90bedc5a5ab4c165e6ec3fe99f970d0e302f384ad222"}, - {file = "tomli-2.2.1-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:40741994320b232529c802f8bc86da4e1aa9f413db394617b9a256ae0f9a7f77"}, - {file = "tomli-2.2.1-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:400e720fe168c0f8521520190686ef8ef033fb19fc493da09779e592861b78c6"}, - {file = "tomli-2.2.1-cp312-cp312-musllinux_1_2_i686.whl", hash = "sha256:02abe224de6ae62c19f090f68da4e27b10af2b93213d36cf44e6e1c5abd19fdd"}, - {file = "tomli-2.2.1-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:b82ebccc8c8a36f2094e969560a1b836758481f3dc360ce9a3277c65f374285e"}, - {file = "tomli-2.2.1-cp312-cp312-win32.whl", hash = "sha256:889f80ef92701b9dbb224e49ec87c645ce5df3fa2cc548664eb8a25e03127a98"}, - {file = "tomli-2.2.1-cp312-cp312-win_amd64.whl", hash = "sha256:7fc04e92e1d624a4a63c76474610238576942d6b8950a2d7f908a340494e67e4"}, - {file = "tomli-2.2.1-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:f4039b9cbc3048b2416cc57ab3bda989a6fcf9b36cf8937f01a6e731b64f80d7"}, - {file = "tomli-2.2.1-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:286f0ca2ffeeb5b9bd4fcc8d6c330534323ec51b2f52da063b11c502da16f30c"}, - {file = "tomli-2.2.1-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a92ef1a44547e894e2a17d24e7557a5e85a9e1d0048b0b5e7541f76c5032cb13"}, - {file = "tomli-2.2.1-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9316dc65bed1684c9a98ee68759ceaed29d229e985297003e494aa825ebb0281"}, - {file = "tomli-2.2.1-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:e85e99945e688e32d5a35c1ff38ed0b3f41f43fad8df0bdf79f72b2ba7bc5272"}, - {file = "tomli-2.2.1-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:ac065718db92ca818f8d6141b5f66369833d4a80a9d74435a268c52bdfa73140"}, - {file = "tomli-2.2.1-cp313-cp313-musllinux_1_2_i686.whl", hash = "sha256:d920f33822747519673ee656a4b6ac33e382eca9d331c87770faa3eef562aeb2"}, - {file = "tomli-2.2.1-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:a198f10c4d1b1375d7687bc25294306e551bf1abfa4eace6650070a5c1ae2744"}, - {file = "tomli-2.2.1-cp313-cp313-win32.whl", hash = "sha256:d3f5614314d758649ab2ab3a62d4f2004c825922f9e370b29416484086b264ec"}, - {file = "tomli-2.2.1-cp313-cp313-win_amd64.whl", hash = "sha256:a38aa0308e754b0e3c67e344754dff64999ff9b513e691d0e786265c93583c69"}, - {file = "tomli-2.2.1-py3-none-any.whl", hash = "sha256:cb55c73c5f4408779d0cf3eef9f762b9c9f147a77de7b258bef0a5628adc85cc"}, - {file = "tomli-2.2.1.tar.gz", hash = "sha256:cd45e1dc79c835ce60f7404ec8119f2eb06d38b1deba146f07ced3bbc44505ff"}, + {file = "tomli-2.4.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:b5ef256a3fd497d4973c11bf142e9ed78b150d36f5773f1ca6088c230ffc5867"}, + {file = "tomli-2.4.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:5572e41282d5268eb09a697c89a7bee84fae66511f87533a6f88bd2f7b652da9"}, + {file = "tomli-2.4.0-cp311-cp311-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:551e321c6ba03b55676970b47cb1b73f14a0a4dce6a3e1a9458fd6d921d72e95"}, + {file = "tomli-2.4.0-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:5e3f639a7a8f10069d0e15408c0b96a2a828cfdec6fca05296ebcdcc28ca7c76"}, + {file = "tomli-2.4.0-cp311-cp311-musllinux_1_2_aarch64.whl", hash = "sha256:1b168f2731796b045128c45982d3a4874057626da0e2ef1fdd722848b741361d"}, + {file = "tomli-2.4.0-cp311-cp311-musllinux_1_2_x86_64.whl", hash = "sha256:133e93646ec4300d651839d382d63edff11d8978be23da4cc106f5a18b7d0576"}, + {file = "tomli-2.4.0-cp311-cp311-win32.whl", hash = "sha256:b6c78bdf37764092d369722d9946cb65b8767bfa4110f902a1b2542d8d173c8a"}, + {file = "tomli-2.4.0-cp311-cp311-win_amd64.whl", hash = "sha256:d3d1654e11d724760cdb37a3d7691f0be9db5fbdaef59c9f532aabf87006dbaa"}, + {file = "tomli-2.4.0-cp311-cp311-win_arm64.whl", hash = "sha256:cae9c19ed12d4e8f3ebf46d1a75090e4c0dc16271c5bce1c833ac168f08fb614"}, + {file = "tomli-2.4.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:920b1de295e72887bafa3ad9f7a792f811847d57ea6b1215154030cf131f16b1"}, + {file = "tomli-2.4.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:7d6d9a4aee98fac3eab4952ad1d73aee87359452d1c086b5ceb43ed02ddb16b8"}, + {file = "tomli-2.4.0-cp312-cp312-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:36b9d05b51e65b254ea6c2585b59d2c4cb91c8a3d91d0ed0f17591a29aaea54a"}, + {file = "tomli-2.4.0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:1c8a885b370751837c029ef9bc014f27d80840e48bac415f3412e6593bbc18c1"}, + {file = "tomli-2.4.0-cp312-cp312-musllinux_1_2_aarch64.whl", hash = "sha256:8768715ffc41f0008abe25d808c20c3d990f42b6e2e58305d5da280ae7d1fa3b"}, + {file = "tomli-2.4.0-cp312-cp312-musllinux_1_2_x86_64.whl", hash = "sha256:7b438885858efd5be02a9a133caf5812b8776ee0c969fea02c45e8e3f296ba51"}, + {file = "tomli-2.4.0-cp312-cp312-win32.whl", hash = "sha256:0408e3de5ec77cc7f81960c362543cbbd91ef883e3138e81b729fc3eea5b9729"}, + {file = "tomli-2.4.0-cp312-cp312-win_amd64.whl", hash = "sha256:685306e2cc7da35be4ee914fd34ab801a6acacb061b6a7abca922aaf9ad368da"}, + {file = "tomli-2.4.0-cp312-cp312-win_arm64.whl", hash = "sha256:5aa48d7c2356055feef06a43611fc401a07337d5b006be13a30f6c58f869e3c3"}, + {file = "tomli-2.4.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:84d081fbc252d1b6a982e1870660e7330fb8f90f676f6e78b052ad4e64714bf0"}, + {file = "tomli-2.4.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:9a08144fa4cba33db5255f9b74f0b89888622109bd2776148f2597447f92a94e"}, + {file = "tomli-2.4.0-cp313-cp313-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:c73add4bb52a206fd0c0723432db123c0c75c280cbd67174dd9d2db228ebb1b4"}, + {file = "tomli-2.4.0-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:1fb2945cbe303b1419e2706e711b7113da57b7db31ee378d08712d678a34e51e"}, + {file = "tomli-2.4.0-cp313-cp313-musllinux_1_2_aarch64.whl", hash = "sha256:bbb1b10aa643d973366dc2cb1ad94f99c1726a02343d43cbc011edbfac579e7c"}, + {file = "tomli-2.4.0-cp313-cp313-musllinux_1_2_x86_64.whl", hash = "sha256:4cbcb367d44a1f0c2be408758b43e1ffb5308abe0ea222897d6bfc8e8281ef2f"}, + {file = "tomli-2.4.0-cp313-cp313-win32.whl", hash = "sha256:7d49c66a7d5e56ac959cb6fc583aff0651094ec071ba9ad43df785abc2320d86"}, + {file = "tomli-2.4.0-cp313-cp313-win_amd64.whl", hash = "sha256:3cf226acb51d8f1c394c1b310e0e0e61fecdd7adcb78d01e294ac297dd2e7f87"}, + {file = "tomli-2.4.0-cp313-cp313-win_arm64.whl", hash = "sha256:d20b797a5c1ad80c516e41bc1fb0443ddb5006e9aaa7bda2d71978346aeb9132"}, + {file = "tomli-2.4.0-cp314-cp314-macosx_10_15_x86_64.whl", hash = "sha256:26ab906a1eb794cd4e103691daa23d95c6919cc2fa9160000ac02370cc9dd3f6"}, + {file = "tomli-2.4.0-cp314-cp314-macosx_11_0_arm64.whl", hash = "sha256:20cedb4ee43278bc4f2fee6cb50daec836959aadaf948db5172e776dd3d993fc"}, + {file = "tomli-2.4.0-cp314-cp314-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:39b0b5d1b6dd03684b3fb276407ebed7090bbec989fa55838c98560c01113b66"}, + {file = "tomli-2.4.0-cp314-cp314-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:a26d7ff68dfdb9f87a016ecfd1e1c2bacbe3108f4e0f8bcd2228ef9a766c787d"}, + {file = "tomli-2.4.0-cp314-cp314-musllinux_1_2_aarch64.whl", hash = "sha256:20ffd184fb1df76a66e34bd1b36b4a4641bd2b82954befa32fe8163e79f1a702"}, + {file = "tomli-2.4.0-cp314-cp314-musllinux_1_2_x86_64.whl", hash = "sha256:75c2f8bbddf170e8effc98f5e9084a8751f8174ea6ccf4fca5398436e0320bc8"}, + {file = "tomli-2.4.0-cp314-cp314-win32.whl", hash = "sha256:31d556d079d72db7c584c0627ff3a24c5d3fb4f730221d3444f3efb1b2514776"}, + {file = "tomli-2.4.0-cp314-cp314-win_amd64.whl", hash = "sha256:43e685b9b2341681907759cf3a04e14d7104b3580f808cfde1dfdb60ada85475"}, + {file = "tomli-2.4.0-cp314-cp314-win_arm64.whl", hash = "sha256:3d895d56bd3f82ddd6faaff993c275efc2ff38e52322ea264122d72729dca2b2"}, + {file = "tomli-2.4.0-cp314-cp314t-macosx_10_15_x86_64.whl", hash = "sha256:5b5807f3999fb66776dbce568cc9a828544244a8eb84b84b9bafc080c99597b9"}, + {file = "tomli-2.4.0-cp314-cp314t-macosx_11_0_arm64.whl", hash = "sha256:c084ad935abe686bd9c898e62a02a19abfc9760b5a79bc29644463eaf2840cb0"}, + {file = "tomli-2.4.0-cp314-cp314t-manylinux2014_aarch64.manylinux_2_17_aarch64.manylinux_2_28_aarch64.whl", hash = "sha256:0f2e3955efea4d1cfbcb87bc321e00dc08d2bcb737fd1d5e398af111d86db5df"}, + {file = "tomli-2.4.0-cp314-cp314t-manylinux2014_x86_64.manylinux_2_17_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:0e0fe8a0b8312acf3a88077a0802565cb09ee34107813bba1c7cd591fa6cfc8d"}, + {file = "tomli-2.4.0-cp314-cp314t-musllinux_1_2_aarch64.whl", hash = "sha256:413540dce94673591859c4c6f794dfeaa845e98bf35d72ed59636f869ef9f86f"}, + {file = "tomli-2.4.0-cp314-cp314t-musllinux_1_2_x86_64.whl", hash = "sha256:0dc56fef0e2c1c470aeac5b6ca8cc7b640bb93e92d9803ddaf9ea03e198f5b0b"}, + {file = "tomli-2.4.0-cp314-cp314t-win32.whl", hash = "sha256:d878f2a6707cc9d53a1be1414bbb419e629c3d6e67f69230217bb663e76b5087"}, + {file = "tomli-2.4.0-cp314-cp314t-win_amd64.whl", hash = "sha256:2add28aacc7425117ff6364fe9e06a183bb0251b03f986df0e78e974047571fd"}, + {file = "tomli-2.4.0-cp314-cp314t-win_arm64.whl", hash = "sha256:2b1e3b80e1d5e52e40e9b924ec43d81570f0e7d09d11081b797bc4692765a3d4"}, + {file = "tomli-2.4.0-py3-none-any.whl", hash = "sha256:1f776e7d669ebceb01dee46484485f43a4048746235e683bcdffacdf1fb4785a"}, + {file = "tomli-2.4.0.tar.gz", hash = "sha256:aa89c3f6c277dd275d8e243ad24f3b5e701491a860d5121f2cdd399fbb31fc9c"}, ] [[package]] @@ -525,16 +584,16 @@ files = [ [[package]] name = "typing-extensions" -version = "4.12.2" +version = "4.13.2" description = "Backported and Experimental Type Hints for Python 3.8+" optional = false python-versions = ">=3.8" files = [ - {file = "typing_extensions-4.12.2-py3-none-any.whl", hash = "sha256:04e5ca0351e0f3f85c6853954072df659d0d13fac324d0072316b67d7794700d"}, - {file = "typing_extensions-4.12.2.tar.gz", hash = "sha256:1a7ead55c7e559dd4dee8856e3a88b41225abfe1ce8df57b7c13915fe121ffb8"}, + {file = "typing_extensions-4.13.2-py3-none-any.whl", hash = "sha256:a439e7c04b49fec3e5d3e2beaa21755cadbbdc391694e28ccdd36ca4a1408f8c"}, + {file = "typing_extensions-4.13.2.tar.gz", hash = "sha256:e6c81219bd689f51865d9e372991c540bda33a0379d5573cddb9a3a23f7caaef"}, ] [metadata] lock-version = "2.0" python-versions = "^3.8" -content-hash = "6f6c191c1028d17a97fdfa84cedfd3cef94b5d63d98b8c1d333b3398eeea9055" +content-hash = "bcf31a142c86d9e556553c8c260a93b563ac64a043076dbd48b26111d422c26e" diff --git a/pyproject.toml b/pyproject.toml index 749aa8e..786103a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,11 +1,15 @@ +[project] +name = "webflow" +dynamic = ["version"] + [tool.poetry] name = "webflow" -version = "2.0.0b1" +version = "2.0.0" description = "" readme = "README.md" authors = [] keywords = [] - +license = "MIT" classifiers = [ "Intended Audience :: Developers", "Programming Language :: Python", @@ -15,35 +19,40 @@ classifiers = [ "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", + "Programming Language :: Python :: 3.14", + "Programming Language :: Python :: 3.15", "Operating System :: OS Independent", "Operating System :: POSIX", "Operating System :: MacOS", "Operating System :: POSIX :: Linux", "Operating System :: Microsoft :: Windows", "Topic :: Software Development :: Libraries :: Python Modules", - "Typing :: Typed" + "Typing :: Typed", + "License :: OSI Approved :: MIT License" ] packages = [ { include = "webflow", from = "src"} ] -[project.urls] +[tool.poetry.urls] Repository = 'https://github.com/webflow/webflow-python' [tool.poetry.dependencies] python = "^3.8" httpx = ">=0.21.2" pydantic = ">= 1.9.2" -pydantic-core = "^2.18.2" +pydantic-core = ">=2.18.2" typing_extensions = ">= 4.0.0" -[tool.poetry.dev-dependencies] -mypy = "1.0.1" +[tool.poetry.group.dev.dependencies] +mypy = "==1.13.0" pytest = "^7.4.0" pytest-asyncio = "^0.23.5" +pytest-xdist = "^3.6.1" python-dateutil = "^2.9.0" types-python-dateutil = "^2.9.0.20240316" -ruff = "^0.5.6" +ruff = "==0.11.5" [tool.pytest.ini_options] testpaths = [ "tests" ] @@ -55,6 +64,26 @@ plugins = ["pydantic.mypy"] [tool.ruff] line-length = 120 +[tool.ruff.lint] +select = [ + "E", # pycodestyle errors + "F", # pyflakes + "I", # isort +] +ignore = [ + "E402", # Module level import not at top of file + "E501", # Line too long + "E711", # Comparison to `None` should be `cond is not None` + "E712", # Avoid equality comparisons to `True`; use `if ...:` checks + "E721", # Use `is` and `is not` for type comparisons, or `isinstance()` for insinstance checks + "E722", # Do not use bare `except` + "E731", # Do not assign a `lambda` expression, use a `def` + "F821", # Undefined name + "F841" # Local variable ... is assigned to but never used +] + +[tool.ruff.lint.isort] +section-order = ["future", "standard-library", "third-party", "first-party"] [build-system] requires = ["poetry-core"] diff --git a/reference.md b/reference.md index 5001bba..fbfbd16 100644 --- a/reference.md +++ b/reference.md @@ -1,6 +1,6 @@ # Reference ## Token -
client.token.authorized_by() +
client.token.authorized_by() -> AuthorizedUser
@@ -30,10 +30,13 @@ Required Scope | `authorized_user:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.token.authorized_by() ``` @@ -62,7 +65,7 @@ client.token.authorized_by()
-
client.token.introspect() +
client.token.introspect() -> Authorization
@@ -92,10 +95,13 @@ Information about the authorization token ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.token.introspect() ``` @@ -125,7 +131,7 @@ client.token.introspect()
## Sites -
client.sites.create(...) +
client.sites.create(...) -> Site
@@ -137,7 +143,9 @@ client.token.introspect()
-Create a site. This endpoint requires an Enterprise workspace. +Create a site. + +This endpoint requires an Enterprise workspace. Required scope | `workspace:write`
@@ -155,13 +163,16 @@ Required scope | `workspace:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.sites.create( workspace_id="580e63e98c9a982ac9b8b741", - name="The Hitchhiker's Guide to the Galaxy", + name="The Hitchhiker\'s Guide to the Galaxy", ) ``` @@ -222,7 +233,7 @@ client.sites.create(
-
client.sites.list() +
client.sites.list() -> Sites
@@ -252,10 +263,13 @@ Required scope | `sites:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.sites.list() ``` @@ -284,7 +298,7 @@ client.sites.list()
-
client.sites.get(...) +
client.sites.get(...) -> Site
@@ -314,10 +328,13 @@ Required scope | `sites:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.sites.get( site_id="580e63e98c9a982ac9b8b741", ) @@ -356,7 +373,7 @@ client.sites.get(
-
client.sites.delete(...) +
client.sites.delete(...)
@@ -368,7 +385,9 @@ client.sites.get(
-Delete a site. This endpoint requires an Enterprise workspace. +Delete a site. + +This endpoint requires an Enterprise workspace. Required scope | `sites:write`
@@ -386,10 +405,13 @@ Required scope | `sites:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.sites.delete( site_id="580e63e98c9a982ac9b8b741", ) @@ -428,7 +450,7 @@ client.sites.delete(
-
client.sites.update(...) +
client.sites.update(...) -> Site
@@ -440,7 +462,9 @@ client.sites.delete(
-Update a site. This endpoint requires an Enterprise workspace. +Update a site. + +This endpoint requires an Enterprise workspace. Required scope | `sites:write`
@@ -458,10 +482,13 @@ Required scope | `sites:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.sites.update( site_id="580e63e98c9a982ac9b8b741", ) @@ -516,7 +543,7 @@ client.sites.update(
-
client.sites.get_custom_domain(...) +
client.sites.get_custom_domain(...) -> Domains
@@ -546,10 +573,13 @@ Required scope | `sites:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.sites.get_custom_domain( site_id="580e63e98c9a982ac9b8b741", ) @@ -588,7 +618,7 @@ client.sites.get_custom_domain(
-
client.sites.publish(...) +
client.sites.publish(...) -> SitesPublishResponse
@@ -602,7 +632,9 @@ client.sites.get_custom_domain( Publishes a site to one or more more domains. -This endpoint has a limit of one successful publish queue per minute. +To publish to a specific custom domain, use the domain IDs from the [Get Custom Domains](/data/reference/sites/get-custom-domain) endpoint. + +This endpoint has a specific rate limit of one successful publish queue per minute. Required scope | `sites:write`
@@ -620,12 +652,20 @@ Required scope | `sites:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.sites.publish( site_id="580e63e98c9a982ac9b8b741", + custom_domains=[ + "660c6449dd97ebc7346ac629", + "660c6449dd97ebc7346ac62f" + ], + publish_to_webflow_subdomain=False, ) ``` @@ -650,7 +690,7 @@ client.sites.publish(
-**custom_domains:** `typing.Optional[typing.Sequence[str]]` — Array of Custom Domain IDs to publish +**custom_domains:** `typing.Optional[typing.List[str]]` — Array of Custom Domain IDs to publish
@@ -679,7 +719,7 @@ client.sites.publish(
## Collections -
client.collections.list(...) +
client.collections.list(...) -> CollectionList
@@ -709,10 +749,13 @@ Required scope | `cms:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.collections.list( site_id="580e63e98c9a982ac9b8b741", ) @@ -751,7 +794,7 @@ client.collections.list(
-
client.collections.create(...) +
client.collections.create(...) -> Collection
@@ -763,7 +806,9 @@ client.collections.list(
-Create a Collection for a site. +Create a Collection for a site with collection fields. + +Each collection includes the required _name_ and _slug_ fields, which are generated automatically. You can update the `displayName` of these fields, but the slug for them cannot be changed. Fields slugs are automatically converted to lowercase. Spaces in slugs are replaced with hyphens. Required scope | `cms:write`
@@ -780,16 +825,39 @@ Required scope | `cms:write`
```python -from webflow import Webflow +from webflow import Webflow, StaticField +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.collections.create( site_id="580e63e98c9a982ac9b8b741", display_name="Blog Posts", singular_name="Blog Post", slug="posts", + fields=[ + StaticField( + is_required=True, + type="PlainText", + display_name="Title", + help_text="The title of the blog post", + ), + StaticField( + is_required=True, + type="RichText", + display_name="Content", + help_text="The content of the blog post", + ), + StaticField( + is_required=True, + type=, + display_name="Author", + help_text="The author of the blog post", + ) + ], ) ``` @@ -838,6 +906,14 @@ client.collections.create(
+**fields:** `typing.Optional[typing.List[FieldCreate]]` — An array of custom fields to add to the collection + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -850,7 +926,7 @@ client.collections.create(
-
client.collections.get(...) +
client.collections.get(...) -> Collection
@@ -880,10 +956,13 @@ Required scope | `cms:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.collections.get( collection_id="580e63fc8c9a982ac9b8b745", ) @@ -922,7 +1001,7 @@ client.collections.get(
-
client.collections.delete(...) +
client.collections.delete(...)
@@ -952,10 +1031,13 @@ Required scope | `cms:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.collections.delete( collection_id="580e63fc8c9a982ac9b8b745", ) @@ -995,7 +1077,7 @@ client.collections.delete(
## Pages -
client.pages.list(...) +
client.pages.list(...) -> PageList
@@ -1025,13 +1107,18 @@ Required scope | `pages:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.pages.list( site_id="580e63e98c9a982ac9b8b741", locale_id="65427cf400e02b306eaa04a0", + limit=1, + offset=1, ) ``` @@ -1056,7 +1143,11 @@ client.pages.list(
-**locale_id:** `typing.Optional[str]` — Unique identifier for a specific locale. Applicable, when using localization. +**locale_id:** `typing.Optional[str]` + +Unique identifier for a specific Locale. + +[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
@@ -1064,7 +1155,7 @@ client.pages.list(
-**limit:** `typing.Optional[float]` — Maximum number of records to be returned (max limit: 100) +**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
@@ -1072,7 +1163,7 @@ client.pages.list(
-**offset:** `typing.Optional[float]` — Offset used for pagination if the results have more than limit records +**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
@@ -1092,7 +1183,7 @@ client.pages.list(
-
client.pages.get_metadata(...) +
client.pages.get_metadata(...) -> Page
@@ -1122,10 +1213,13 @@ Required scope | `pages:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.pages.get_metadata( page_id="63c720f9347c2139b248e552", locale_id="65427cf400e02b306eaa04a0", @@ -1153,7 +1247,11 @@ client.pages.get_metadata(
-**locale_id:** `typing.Optional[str]` — Unique identifier for a specific locale. Applicable, when using localization. +**locale_id:** `typing.Optional[str]` + +Unique identifier for a specific Locale. + +[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
@@ -1173,7 +1271,7 @@ client.pages.get_metadata(
-
client.pages.update_page_settings(...) +
client.pages.update_page_settings(...) -> Page
@@ -1202,42 +1300,30 @@ Required scope | `pages:write`
```python -import datetime - -from webflow import PageOpenGraph, PageSeo, Webflow +from webflow import Webflow +from webflow.environment import WebflowEnvironment +from webflow.pages import PageMetadataWriteSeo, PageMetadataWriteOpenGraph client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.pages.update_page_settings( page_id="63c720f9347c2139b248e552", locale_id="65427cf400e02b306eaa04a0", - id="6596da6045e56dee495bcbba", - site_id="6258612d1ee792848f805dcf", title="Guide to the Galaxy", slug="guide-to-the-galaxy", - created_on=datetime.datetime.fromisoformat( - "2024-03-11 10:42:00+00:00", - ), - last_updated=datetime.datetime.fromisoformat( - "2024-03-11 10:42:42+00:00", - ), - archived=False, - draft=False, - can_branch=True, - is_branch=False, - seo=PageSeo( - title="The Ultimate Hitchhiker's Guide to the Galaxy", + seo=PageMetadataWriteSeo( + title="The Ultimate Hitchhiker\'s Guide to the Galaxy", description="Everything you need to know about the galaxy, from avoiding Vogon poetry to the importance of towels.", ), - open_graph=PageOpenGraph( + open_graph=PageMetadataWriteOpenGraph( title="Explore the Cosmos with The Ultimate Guide", title_copied=False, description="Dive deep into the mysteries of the universe with your guide to everything galactic.", description_copied=False, ), - page_locale_id="653fd9af6a07fc9cfd7a5e57", - published_path="/en-us/guide-to-the-galaxy", ) ``` @@ -1262,95 +1348,11 @@ client.pages.update_page_settings(
-**id:** `str` — Unique identifier for the Page - -
-
- -
-
- -**locale_id:** `typing.Optional[str]` — Unique identifier for a specific locale. Applicable, when using localization. - -
-
- -
-
- -**site_id:** `typing.Optional[str]` — Unique identifier for the Site - -
-
- -
-
- -**title:** `typing.Optional[str]` — Title of the Page - -
-
- -
-
- -**slug:** `typing.Optional[str]` — slug of the Page (derived from title) - -
-
- -
-
- -**parent_id:** `typing.Optional[str]` — Identifier of the parent folder - -
-
- -
-
- -**collection_id:** `typing.Optional[str]` — Unique identifier for a linked Collection, value will be null if the Page is not part of a Collection. - -
-
- -
-
- -**created_on:** `typing.Optional[dt.datetime]` — The date the Page was created - -
-
- -
-
- -**last_updated:** `typing.Optional[dt.datetime]` — The date the Page was most recently updated - -
-
- -
-
- -**archived:** `typing.Optional[bool]` — Whether the Page has been archived - -
-
- -
-
- -**draft:** `typing.Optional[bool]` — Whether the Page is a draft - -
-
+**locale_id:** `typing.Optional[str]` -
-
+Unique identifier for a specific Locale. -**can_branch:** `typing.Optional[bool]` — Indicates whether the Page supports [Page Branching](https://university.webflow.com/lesson/page-branching) +[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
@@ -1358,7 +1360,7 @@ client.pages.update_page_settings(
-**is_branch:** `typing.Optional[bool]` — Indicates whether the Page is a Branch of another Page [Page Branching](https://university.webflow.com/lesson/page-branching) +**title:** `typing.Optional[str]` — Title for the page
@@ -1366,23 +1368,12 @@ client.pages.update_page_settings(
-**is_members_only:** `typing.Optional[bool]` — Indicates whether the Page is restricted by [Memberships Controls](https://university.webflow.com/lesson/webflow-memberships-overview#how-to-manage-page-restrictions) - -
-
- -
-
+**slug:** `typing.Optional[str]` -**seo:** `typing.Optional[PageSeo]` — SEO-related fields for the Page - -
-
+Slug for the page. -
-
-**open_graph:** `typing.Optional[PageOpenGraph]` — Open Graph fields for the Page +**Note:** Updating slugs in secondary locales is only supported in Advanced and Enterprise localization add-on plans.
@@ -1390,7 +1381,7 @@ client.pages.update_page_settings(
-**page_locale_id:** `typing.Optional[str]` — Unique ID of the page locale +**seo:** `typing.Optional[PageMetadataWriteSeo]` — SEO-related fields for the Page
@@ -1398,7 +1389,7 @@ client.pages.update_page_settings(
-**published_path:** `typing.Optional[str]` — Relative path of the published page URL +**open_graph:** `typing.Optional[PageMetadataWriteOpenGraph]` — Open Graph fields for the Page
@@ -1418,7 +1409,7 @@ client.pages.update_page_settings(
-
client.pages.get_content(...) +
client.pages.get_content(...) -> Dom
@@ -1430,10 +1421,9 @@ client.pages.update_page_settings(
-Get static content from a static page. This includes text nodes, image nodes and component instances. -To retrieve the contents of components in the page use the [get component content](/data/reference/pages-and-components/components/get-content) endpoint. +Get text and component instance content from a static page. -If you do not provide a Locale ID in your request, the response will return any content that can be localized from the Primary locale. +Localization Required scope | `pages:read`
@@ -1451,13 +1441,18 @@ Required scope | `pages:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.pages.get_content( page_id="63c720f9347c2139b248e552", locale_id="65427cf400e02b306eaa04a0", + limit=1, + offset=1, ) ``` @@ -1482,7 +1477,11 @@ client.pages.get_content(
-**locale_id:** `typing.Optional[str]` — Unique identifier for a specific locale. Applicable, when using localization. +**locale_id:** `typing.Optional[str]` + +Unique identifier for a specific Locale. + +[Lear more about localization.](/data/v2.0.0/docs/working-with-localization)
@@ -1490,7 +1489,7 @@ client.pages.get_content(
-**limit:** `typing.Optional[float]` — Maximum number of records to be returned (max limit: 100) +**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
@@ -1498,7 +1497,7 @@ client.pages.get_content(
-**offset:** `typing.Optional[float]` — Offset used for pagination if the results have more than limit records +**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
@@ -1518,7 +1517,7 @@ client.pages.get_content(
-
client.pages.update_static_content(...) +
client.pages.update_static_content(...) -> UpdateStaticContentResponse
@@ -1533,8 +1532,9 @@ client.pages.get_content( This endpoint updates content on a static page in **secondary locales**. It supports updating up to 1000 nodes in a single request. Before making updates: -1. Use the [get page content](/data/reference/pages-and-components/pages/get-content) endpoint to identify available content nodes and their types -2. If the page has component instances, retrieve the component's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint +1. Use the [get page content](/data/reference/pages-and-components/pages/get-content) endpoint to identify available content nodes and their types. +2. If the page has component instances, retrieve the component's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint. +3. DOM elements may include a `data-w-id` attribute. This attribute is used by Webflow to maintain custom attributes and links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales. This endpoint is specifically for localized pages. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail. @@ -1555,41 +1555,38 @@ Required scope | `pages:write`
```python -from webflow import ( - ComponentInstanceNodePropertyOverridesWrite, - ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem, - TextNodeWrite, - Webflow, -) +from webflow import Webflow, TextNodeWrite +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.pages.update_static_content( page_id="63c720f9347c2139b248e552", locale_id="localeId", nodes=[ TextNodeWrite( node_id="a245c12d-995b-55ee-5ec7-aa36a6cad623", - text="

The Hitchhiker's Guide to the Galaxy

", + text="

The Hitchhiker\'s Guide to the Galaxy

", ), TextNodeWrite( node_id="a245c12d-995b-55ee-5ec7-aa36a6cad627", - text="

Don't Panic!

Always know where your towel is.

", + text="

Don\'t Panic!

Always know where your towel is.

", ), - ComponentInstanceNodePropertyOverridesWrite( - node_id="a245c12d-995b-55ee-5ec7-aa36a6cad629", - property_overrides=[ - ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem( - property_id="7dd14c08-2e96-8d3d-2b19-b5c03642a0f0", - text="

Time is an illusion

", - ), - ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem( - property_id="7dd14c08-2e96-8d3d-2b19-b5c03642a0f1", - text="Life, the Universe and Everything", - ), - ], + TextNodeWrite( + node_id="a245c12d-995b-55ee-5ec7-aa36a6cad635", + ), + TextNodeWrite( + node_id="a245c12d-995b-55ee-5ec7-aa36a6cad642", + ), + TextNodeWrite( + node_id="a245c12d-995b-55ee-5ec7-aa36a6cad671", ), + TextNodeWrite( + node_id="a245c12d-995b-55ee-5ec7-aa36a6cad629", + ) ], ) @@ -1623,7 +1620,7 @@ client.pages.update_static_content(
-**nodes:** `typing.Sequence[PageDomWriteNodesItem]` — List of DOM Nodes with the new content that will be updated in each node. +**nodes:** `typing.List[PageDomWriteNodesItem]` — List of DOM Nodes with the new content that will be updated in each node.
@@ -1644,7 +1641,7 @@ client.pages.update_static_content(
## Components -
client.components.list(...) +
client.components.list(...) -> ComponentList
@@ -1674,12 +1671,18 @@ Required scope | `components:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.components.list( site_id="580e63e98c9a982ac9b8b741", + branch_id="68026fa68ef6dc744c75b833", + limit=1, + offset=1, ) ``` @@ -1704,7 +1707,15 @@ client.components.list(
-**limit:** `typing.Optional[float]` — Maximum number of records to be returned (max limit: 100) +**branch_id:** `typing.Optional[str]` — Scope the operation to work on a specific branch. + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
@@ -1712,7 +1723,7 @@ client.components.list(
-**offset:** `typing.Optional[float]` — Offset used for pagination if the results have more than limit records +**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
@@ -1732,7 +1743,7 @@ client.components.list(
-
client.components.get_content(...) +
client.components.get_content(...) -> ComponentDom
@@ -1744,7 +1755,7 @@ client.components.list(
-Get static content from a component definition. This includes text nodes, image nodes and nested component instances. +Get static content from a component definition. This includes text nodes, image nodes, select nodes, text input nodes, submit button nodes, and nested component instances. To retrieve dynamic content set by component properties, use the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint. If you do not provide a Locale ID in your request, the response will return any content that can be localized from the Primary locale. @@ -1765,14 +1776,20 @@ Required scope | `components:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.components.get_content( site_id="580e63e98c9a982ac9b8b741", component_id="8505ba55-ef72-629e-f85c-33e4b703d48b", locale_id="65427cf400e02b306eaa04a0", + branch_id="68026fa68ef6dc744c75b833", + limit=1, + offset=1, ) ``` @@ -1805,7 +1822,19 @@ client.components.get_content(
-**locale_id:** `typing.Optional[str]` — Unique identifier for a specific locale. Applicable, when using localization. +**locale_id:** `typing.Optional[str]` + +Unique identifier for a specific Locale. + +[Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + +
+
+ +
+
+ +**branch_id:** `typing.Optional[str]` — Scope the operation to work on a specific branch.
@@ -1813,7 +1842,7 @@ client.components.get_content(
-**limit:** `typing.Optional[float]` — Maximum number of records to be returned (max limit: 100) +**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
@@ -1821,7 +1850,7 @@ client.components.get_content(
-**offset:** `typing.Optional[float]` — Offset used for pagination if the results have more than limit records +**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
@@ -1841,7 +1870,7 @@ client.components.get_content(
-
client.components.update_content(...) +
client.components.update_content(...) -> ComponentsUpdateContentResponse
@@ -1856,8 +1885,9 @@ client.components.get_content( This endpoint updates content within a component defintion for **secondary locales**. It supports updating up to 1000 nodes in a single request. Before making updates: -1. Use the [get component content](/data/reference/pages-and-components/components/get-content) endpoint to identify available content nodes and their types -2. If your component definition has a component instance nested within it, retrieve the nested component instance's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint +1. Use the [get component content](/data/reference/pages-and-components/components/get-content) endpoint to identify available content nodes and their types. +2. If your component definition has a component instance nested within it, retrieve the nested component instance's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint. +3. DOM elements may include a `data-w-id` attribute. This attribute is used by Webflow to maintain custom attributes and links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales. This endpoint is specifically for localizing component definitions. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail. @@ -1878,42 +1908,40 @@ Required scope | `components:write`
```python -from webflow import ( - ComponentInstanceNodePropertyOverridesWrite, - ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem, - TextNodeWrite, - Webflow, -) +from webflow import Webflow, TextNodeWrite +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.components.update_content( site_id="580e63e98c9a982ac9b8b741", component_id="8505ba55-ef72-629e-f85c-33e4b703d48b", locale_id="65427cf400e02b306eaa04a0", + branch_id="68026fa68ef6dc744c75b833", nodes=[ TextNodeWrite( node_id="a245c12d-995b-55ee-5ec7-aa36a6cad623", - text="

The Hitchhiker's Guide to the Galaxy

", + text="

The Hitchhiker\'s Guide to the Galaxy

", ), TextNodeWrite( node_id="a245c12d-995b-55ee-5ec7-aa36a6cad627", - text="

Don't Panic!

Always know where your towel is.

", + text="

Don\'t Panic!

Always know where your towel is.

", ), - ComponentInstanceNodePropertyOverridesWrite( - node_id="a245c12d-995b-55ee-5ec7-aa36a6cad629", - property_overrides=[ - ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem( - property_id="7dd14c08-2e96-8d3d-2b19-b5c03642a0f0", - text="

Time is an illusion

", - ), - ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem( - property_id="7dd14c08-2e96-8d3d-2b19-b5c03642a0f1", - text="Life, the Universe and Everything", - ), - ], + TextNodeWrite( + node_id="a245c12d-995b-55ee-5ec7-aa36a6cad635", + ), + TextNodeWrite( + node_id="a245c12d-995b-55ee-5ec7-aa36a6cad642", + ), + TextNodeWrite( + node_id="a245c12d-995b-55ee-5ec7-aa36a6cad671", ), + TextNodeWrite( + node_id="a245c12d-995b-55ee-5ec7-aa36a6cad629", + ) ], ) @@ -1947,7 +1975,7 @@ client.components.update_content(
-**nodes:** `typing.Sequence[ComponentDomWriteNodesItem]` — List of DOM Nodes with the new content that will be updated in each node. +**nodes:** `typing.List[ComponentDomWriteNodesItem]` — List of DOM Nodes with the new content that will be updated in each node.
@@ -1955,7 +1983,19 @@ client.components.update_content(
-**locale_id:** `typing.Optional[str]` — Unique identifier for a specific locale. Applicable, when using localization. +**locale_id:** `typing.Optional[str]` + +Unique identifier for a specific Locale. + +[Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + +
+
+ +
+
+ +**branch_id:** `typing.Optional[str]` — Scope the operation to work on a specific branch.
@@ -1975,7 +2015,7 @@ client.components.update_content(
-
client.components.get_properties(...) +
client.components.get_properties(...) -> ComponentProperties
@@ -1987,9 +2027,9 @@ client.components.update_content(
-Get the property default values of a component definition. +Get the default property values of a component definition. -If you do not provide a Locale ID in your request, the response will return any properties that can be localized from the Primary locale. +If you do not include a `localeId` in your request, the response will return any properties that can be localized from the Primary locale. Required scope | `components:read`
@@ -2007,14 +2047,20 @@ Required scope | `components:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.components.get_properties( site_id="580e63e98c9a982ac9b8b741", component_id="8505ba55-ef72-629e-f85c-33e4b703d48b", locale_id="65427cf400e02b306eaa04a0", + branch_id="68026fa68ef6dc744c75b833", + limit=1, + offset=1, ) ``` @@ -2047,7 +2093,19 @@ client.components.get_properties(
-**locale_id:** `typing.Optional[str]` — Unique identifier for a specific locale. Applicable, when using localization. +**locale_id:** `typing.Optional[str]` + +Unique identifier for a specific Locale. + +[Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + +
+
+ +
+
+ +**branch_id:** `typing.Optional[str]` — Scope the operation to work on a specific branch.
@@ -2055,7 +2113,7 @@ client.components.get_properties(
-**limit:** `typing.Optional[float]` — Maximum number of records to be returned (max limit: 100) +**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
@@ -2063,7 +2121,7 @@ client.components.get_properties(
-**offset:** `typing.Optional[float]` — Offset used for pagination if the results have more than limit records +**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
@@ -2083,7 +2141,7 @@ client.components.get_properties(
-
client.components.update_properties(...) +
client.components.update_properties(...) -> ComponentsUpdatePropertiesResponse
@@ -2095,12 +2153,13 @@ client.components.get_properties(
-Update the property default values of a component definition in a specificed locale. +Update the default property values of a component definition in a specificed locale. Before making updates: -1. Use the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint to identify available properties +1. Use the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint to identify properties that can be updated in a secondary locale. +2. Rich Text properties may include a `data-w-id` attribute. This attribute is used by Webflow to maintain links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales. -The request requires a secondary locale ID. If a locale is missing, the request will not be processed and will result in an error. +The request requires a secondary locale ID. If a `localeId` is missing, the request will not be processed and will result in an error. Required scope | `components:write`
@@ -2118,15 +2177,19 @@ Required scope | `components:write` ```python from webflow import Webflow -from webflow.resources.components import ComponentPropertiesWritePropertiesItem +from webflow.environment import WebflowEnvironment +from webflow.components import ComponentPropertiesWritePropertiesItem client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.components.update_properties( site_id="580e63e98c9a982ac9b8b741", component_id="8505ba55-ef72-629e-f85c-33e4b703d48b", locale_id="65427cf400e02b306eaa04a0", + branch_id="68026fa68ef6dc744c75b833", properties=[ ComponentPropertiesWritePropertiesItem( property_id="a245c12d-995b-55ee-5ec7-aa36a6cad623", @@ -2135,7 +2198,7 @@ client.components.update_properties( ComponentPropertiesWritePropertiesItem( property_id="a245c12d-995b-55ee-5ec7-aa36a6cad627", text="

Dont Panic!

Always know where your towel is.

", - ), + ) ], ) @@ -2169,7 +2232,7 @@ client.components.update_properties(
-**properties:** `typing.Sequence[ComponentPropertiesWritePropertiesItem]` — A list of component properties to update within the specified secondary locale. +**properties:** `typing.List[ComponentPropertiesWritePropertiesItem]` — A list of component properties to update within the specified secondary locale.
@@ -2177,7 +2240,19 @@ client.components.update_properties(
-**locale_id:** `typing.Optional[str]` — Unique identifier for a specific locale. Applicable, when using localization. +**locale_id:** `typing.Optional[str]` + +Unique identifier for a specific Locale. + +[Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + +
+
+ +
+
+ +**branch_id:** `typing.Optional[str]` — Scope the operation to work on a specific branch.
@@ -2198,7 +2273,7 @@ client.components.update_properties(
## Scripts -
client.scripts.list(...) +
client.scripts.list(...) -> RegisteredScriptList
@@ -2210,14 +2285,11 @@ client.components.update_properties(
-List of scripts registered to a Site. +Get a list of scripts that have been registered to a site. A site can have a maximum of 800 registered scripts. -In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered -to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate -`custom_code` endpoints. -Additionally, Scripts can be remotely hosted, or registered as inline snippets. - -Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + Required scope | `custom_code:read`
@@ -2235,10 +2307,13 @@ Required scope | `custom_code:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.scripts.list( site_id="580e63e98c9a982ac9b8b741", ) @@ -2277,7 +2352,7 @@ client.scripts.list(
-
client.scripts.register_hosted(...) +
client.scripts.register_hosted(...) -> CustomCodeHostedResponse
@@ -2289,14 +2364,11 @@ client.scripts.list(
-Add a script to a Site's Custom Code registry. - -In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered -to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate -`custom_code` endpoints. -Additionally, Scripts can be remotely hosted, or registered as inline snippets. +Register a hosted script to a site. -Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + Required scope | `custom_code:write`
@@ -2314,10 +2386,13 @@ Required scope | `custom_code:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.scripts.register_hosted( site_id="580e63e98c9a982ac9b8b741", hosted_location="hostedLocation", @@ -2400,7 +2475,7 @@ client.scripts.register_hosted(
-
client.scripts.register_inline(...) +
client.scripts.register_inline(...) -> CustomCodeInlineResponse
@@ -2412,13 +2487,11 @@ client.scripts.register_hosted(
-Add a script to a Site's Custom Code registry. Inline scripts can be between 1 and 2000 characters. +Register an inline script to a site. Inline scripts are limited to 2000 characters. -In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered -to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate -`custom_code` endpoints. - -Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + Required scope | `custom_code:write`
@@ -2436,13 +2509,16 @@ Required scope | `custom_code:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.scripts.register_inline( site_id="580e63e98c9a982ac9b8b741", - source_code="alert('hello world');", + source_code="alert(\'hello world\');", version="0.0.1", display_name="Alert", ) @@ -2522,7 +2598,7 @@ client.scripts.register_inline(
## Assets -
client.assets.list(...) +
client.assets.list(...) -> Assets
@@ -2534,7 +2610,7 @@ client.scripts.register_inline(
-List assets for a given site +List of assets uploaded to a site Required scope | `assets:read`
@@ -2552,12 +2628,17 @@ Required scope | `assets:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.assets.list( site_id="580e63e98c9a982ac9b8b741", + offset=1, + limit=1, ) ``` @@ -2582,6 +2663,22 @@ client.assets.list(
+**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100) + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -2594,7 +2691,7 @@ client.assets.list(
-
client.assets.create(...) +
client.assets.create(...) -> AssetUpload
@@ -2606,15 +2703,18 @@ client.assets.list(
-Create a new asset entry. +The first step in uploading an asset to a site. -This endpoint generates a response with the following information: `uploadUrl` and `uploadDetails`. -You can use these two properties to [upload the file to Amazon s3 by making a POST](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html) -request to the `uploadUrl` with the `uploadDetails` object as your header information in the request. +This endpoint generates a response with the following information: `uploadUrl` and `uploadDetails`. - -Required scope | `assets:write` + +Use these properties in the header of a [POST request to Amazson s3](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html) to complete the upload. + + +To learn more about how to upload assets to Webflow, see our [assets guide](/data/docs/working-with-assets). + + Required scope | `assets:write`
@@ -2630,10 +2730,13 @@ Required scope | `assets:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.assets.create( site_id="580e63e98c9a982ac9b8b741", file_name="file.png", @@ -2698,7 +2801,7 @@ client.assets.create(
-
client.assets.get(...) +
client.assets.get(...) -> Asset
@@ -2710,7 +2813,7 @@ client.assets.create(
-Get an Asset +Get details about an asset Required scope | `assets:read`
@@ -2728,10 +2831,13 @@ Required scope | `assets:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.assets.get( asset_id="580e63fc8c9a982ac9b8b745", ) @@ -2770,7 +2876,7 @@ client.assets.get(
-
client.assets.delete(...) +
client.assets.delete(...)
@@ -2800,10 +2906,13 @@ Required Scope: `assets: write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.assets.delete( asset_id="580e63fc8c9a982ac9b8b745", ) @@ -2842,7 +2951,7 @@ client.assets.delete(
-
client.assets.update(...) +
client.assets.update(...) -> Asset
@@ -2854,7 +2963,7 @@ client.assets.delete(
-Update an Asset +Update details of an Asset. Required scope | `assets:write`
@@ -2872,10 +2981,13 @@ Required scope | `assets:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.assets.update( asset_id="580e63fc8c9a982ac9b8b745", ) @@ -2930,7 +3042,7 @@ client.assets.update(
-
client.assets.list_folders(...) +
client.assets.list_folders(...) -> AssetFolderList
@@ -2960,10 +3072,13 @@ Required scope | `assets:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.assets.list_folders( site_id="580e63e98c9a982ac9b8b741", ) @@ -3002,7 +3117,7 @@ client.assets.list_folders(
-
client.assets.create_folder(...) +
client.assets.create_folder(...) -> AssetFolder
@@ -3032,10 +3147,13 @@ Required scope | `assets:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.assets.create_folder( site_id="580e63e98c9a982ac9b8b741", display_name="my asset folder", @@ -3091,7 +3209,7 @@ client.assets.create_folder(
-
client.assets.get_folder(...) +
client.assets.get_folder(...) -> AssetFolder
@@ -3121,10 +3239,13 @@ Required scope | `assets:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.assets.get_folder( asset_folder_id="6390c49774a71f0e3c1a08ee", ) @@ -3164,7 +3285,7 @@ client.assets.get_folder(
## Webhooks -
client.webhooks.list(...) +
client.webhooks.list(...) -> WebhookList
@@ -3194,10 +3315,13 @@ Required scope | `sites:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.webhooks.list( site_id="580e63e98c9a982ac9b8b741", ) @@ -3236,7 +3360,7 @@ client.webhooks.list(
-
client.webhooks.create(...) +
client.webhooks.create(...) -> Webhook
@@ -3268,13 +3392,15 @@ Required scope | `sites:write`
```python -import datetime - from webflow import Webflow +from webflow.environment import WebflowEnvironment +import datetime client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.webhooks.create( site_id_="580e63e98c9a982ac9b8b741", id="582266e0cd48de0f0e3c6d8b", @@ -3282,12 +3408,8 @@ client.webhooks.create( url="https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f", workspace_id="4f4e46fd476ea8c507000001", site_id="562ac0395358780a1f5e6fbd", - last_triggered=datetime.datetime.fromisoformat( - "2023-02-08 23:59:28+00:00", - ), - created_on=datetime.datetime.fromisoformat( - "2022-11-08 23:59:28+00:00", - ), + last_triggered=datetime.datetime.fromisoformat("2023-02-08T23:59:28+00:00"), + created_on=datetime.datetime.fromisoformat("2022-11-08T23:59:28+00:00"), ) ``` @@ -3304,63 +3426,7 @@ client.webhooks.create(
-**site_id_:** `str` — Unique identifier for a Site - -
-
- -
-
- -**id:** `typing.Optional[str]` — Unique identifier for the Webhook registration - -
-
- -
-
- -**trigger_type:** `typing.Optional[TriggerType]` - -
-
- -
-
- -**url:** `typing.Optional[str]` — URL to send the Webhook payload to - -
-
- -
-
- -**workspace_id:** `typing.Optional[str]` — Unique identifier for the Workspace the Webhook is registered in - -
-
- -
-
- -**site_id:** `typing.Optional[str]` — Unique identifier for the Site the Webhook is registered in - -
-
- -
-
- -**filter:** `typing.Optional[WebhookFilter]` — Only supported for the `form_submission` trigger type. Filter for the form you want Webhooks to be sent for. - -
-
- -
-
- -**last_triggered:** `typing.Optional[dt.datetime]` — Date the Webhook instance was last triggered +**site_id:** `str` — Unique identifier for a Site
@@ -3368,7 +3434,7 @@ client.webhooks.create(
-**created_on:** `typing.Optional[dt.datetime]` — Date the Webhook registration was created +**request:** `Webhook`
@@ -3388,7 +3454,7 @@ client.webhooks.create(
-
client.webhooks.get(...) +
client.webhooks.get(...) -> Webhook
@@ -3418,10 +3484,13 @@ Required scope: `sites:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.webhooks.get( webhook_id="580e64008c9a982ac9b8b754", ) @@ -3460,7 +3529,7 @@ client.webhooks.get(
-
client.webhooks.delete(...) +
client.webhooks.delete(...)
@@ -3490,10 +3559,13 @@ Required scope: `sites:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.webhooks.delete( webhook_id="580e64008c9a982ac9b8b754", ) @@ -3533,7 +3605,7 @@ client.webhooks.delete(
## Forms -
client.forms.list(...) +
client.forms.list(...) -> FormList
@@ -3563,12 +3635,17 @@ Required scope | `forms:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.forms.list( site_id="580e63e98c9a982ac9b8b741", + limit=1, + offset=1, ) ``` @@ -3593,7 +3670,7 @@ client.forms.list(
-**limit:** `typing.Optional[float]` — Maximum number of records to be returned (max limit: 100) +**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
@@ -3601,7 +3678,7 @@ client.forms.list(
-**offset:** `typing.Optional[float]` — Offset used for pagination if the results have more than limit records +**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
@@ -3621,7 +3698,7 @@ client.forms.list(
-
client.forms.get(...) +
client.forms.get(...) -> Form
@@ -3651,10 +3728,13 @@ Required scope | `forms:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.forms.get( form_id="580e63e98c9a982ac9b8b741", ) @@ -3693,7 +3773,7 @@ client.forms.get(
-
client.forms.list_submissions(...) +
client.forms.list_submissions(...) -> FormSubmissionList
@@ -3707,6 +3787,12 @@ client.forms.get( List form submissions for a given form + + When a form is used in a component definition, each instance of the form is considered a unique form. + + To get a combined list of submissions for a form that appears across multiple component instances, use the [List Form Submissions by Site](/data/reference/forms/form-submissions/list-submissions-by-site) endpoint. + + Required scope | `forms:read`
@@ -3723,12 +3809,17 @@ Required scope | `forms:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.forms.list_submissions( form_id="580e63e98c9a982ac9b8b741", + offset=1, + limit=1, ) ``` @@ -3753,7 +3844,7 @@ client.forms.list_submissions(
-**offset:** `typing.Optional[float]` — Offset used for pagination if the results have more than limit records +**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
@@ -3761,7 +3852,7 @@ client.forms.list_submissions(
-**limit:** `typing.Optional[float]` — Maximum number of records to be returned (max limit: 100) +**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
@@ -3781,7 +3872,7 @@ client.forms.list_submissions(
-
client.forms.get_submission(...) +
client.forms.get_submission(...) -> FormSubmission
@@ -3811,10 +3902,13 @@ Required scope | `forms:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) + client.forms.get_submission( form_submission_id="580e63e98c9a982ac9b8b741", ) @@ -3853,7 +3947,7 @@ client.forms.get_submission(
-
client.forms.update_submission(...) +
client.forms.delete_submission(...)
@@ -3865,7 +3959,8 @@ client.forms.get_submission(
-Update hidden fields on a form submission +Delete a form submission + Required scope | `forms:write`
@@ -3883,11 +3978,14 @@ Required scope | `forms:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.forms.update_submission( + +client.forms.delete_submission( form_submission_id="580e63e98c9a982ac9b8b741", ) @@ -3913,14 +4011,6 @@ client.forms.update_submission(
-**form_submission_data:** `typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]]` — An existing **hidden field** defined on the form schema, and the corresponding value to set - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -3933,8 +4023,7 @@ client.forms.update_submission(
-## Users -
client.users.list(...) +
client.forms.update_submission(...) -> FormSubmission
@@ -3946,9 +4035,9 @@ client.forms.update_submission(
-Get a list of users for a site +Update hidden fields on a form submission -Required scope | `users:read` +Required scope | `forms:write`
@@ -3964,12 +4053,15 @@ Required scope | `users:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.users.list( - site_id="580e63e98c9a982ac9b8b741", + +client.forms.update_submission( + form_submission_id="580e63e98c9a982ac9b8b741", ) ``` @@ -3986,23 +4078,7 @@ client.users.list(
-**site_id:** `str` — Unique identifier for a Site - -
-
- -
-
- -**offset:** `typing.Optional[float]` — Offset used for pagination if the results have more than limit records - -
-
- -
-
- -**limit:** `typing.Optional[float]` — Maximum number of records to be returned (max limit: 100) +**form_submission_id:** `str` — Unique identifier for a Form Submission
@@ -4010,13 +4086,7 @@ client.users.list(
-**sort:** `typing.Optional[UsersListRequestSort]` - -Sort string to use when ordering users - -Example(`CreatedOn`, `Email`, `Status`, `LastLogin`, `UpdatedOn`). - -Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) +**form_submission_data:** `typing.Optional[typing.Dict[str, typing.Any]]` — An existing **hidden field** defined on the form schema, and the corresponding value to set
@@ -4036,7 +4106,8 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`)
-
client.users.get(...) +## Products +
client.products.list(...) -> ProductAndSkUsList
@@ -4048,9 +4119,12 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`)
-Get a User by ID +Retrieve all products for a site. + +Use `limit` and `offset` to page through all products with subsequent requests. All SKUs for each product +will also be fetched and returned. The `limit`, `offset` and `total` values represent Products only and do not include any SKUs. -Required scope | `users:read` +Required scope | `ecommerce:read`
@@ -4066,13 +4140,17 @@ Required scope | `users:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.users.get( + +client.products.list( site_id="580e63e98c9a982ac9b8b741", - user_id="580e63e98c9a982ac9b8b741", + offset=1, + limit=1, ) ``` @@ -4097,7 +4175,15 @@ client.users.get(
-**user_id:** `str` — Unique identifier for a User +**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
@@ -4117,7 +4203,7 @@ client.users.get(
-
client.users.delete(...) +
client.products.create(...) -> ProductAndSkUs
@@ -4129,9 +4215,16 @@ client.users.get(
-Delete a User by ID +Create a new ecommerce product and defaultSKU. A product, at minimum, must have a single SKU. + +To create a product with multiple SKUs: + - First, create a list of `sku-properties`, also known as [product options](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants). For example, a T-shirt product may have a "color" `sku-property`, with a list of enum values: red, yellow, and blue, another `sku-property` may be "size", with a list of enum values: small, medium, and large. + - Once, a product is created with a list of `sku-properties`, Webflow will create a **default SKU**, which is always a combination of the first `enum` values of each `sku-property`. (e.g. Small - Red - T-Shirt) + - After creation, you can create additional SKUs for the product, using the [Create SKUs endpoint.](/data/reference/ecommerce/products/create-sku) + +Upon creation, the default product type will be `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer. -Required scope | `users:write` +Required scope | `ecommerce:write`
@@ -4146,14 +4239,81 @@ Required scope | `users:write`
```python -from webflow import Webflow +from webflow import Webflow, ProductFieldData, SkuPropertyList, SkuPropertyListEnumItem, SkuFieldData, SkuFieldDataPrice +from webflow.environment import WebflowEnvironment +from webflow.products import ProductSkuCreateProduct, ProductSkuCreateSku client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.users.delete( + +client.products.create( site_id="580e63e98c9a982ac9b8b741", - user_id="580e63e98c9a982ac9b8b741", + publish_status="staging", + product=ProductSkuCreateProduct( + field_data=ProductFieldData( + name="Colorful T-shirt", + slug="colorful-t-shirt", + description="Our best-selling t-shirt available in multiple colors and sizes", + sku_properties=[ + SkuPropertyList( + id="color", + name="Color", + enum=[ + SkuPropertyListEnumItem( + id="red", + name="Red", + slug="red", + ), + SkuPropertyListEnumItem( + id="yellow", + name="Yellow", + slug="yellow", + ), + SkuPropertyListEnumItem( + id="blue", + name="Blue", + slug="blue", + ) + ], + ), + SkuPropertyList( + id="size", + name="Size", + enum=[ + SkuPropertyListEnumItem( + id="small", + name="Small", + slug="small", + ), + SkuPropertyListEnumItem( + id="medium", + name="Medium", + slug="medium", + ), + SkuPropertyListEnumItem( + id="large", + name="Large", + slug="large", + ) + ], + ) + ], + ), + ), + sku=ProductSkuCreateSku( + field_data=SkuFieldData( + name="Colorful T-shirt - Red Small", + slug="colorful-t-shirt-red-small", + price=SkuFieldDataPrice( + value=2499, + unit="USD", + currency="USD", + ), + main_image="https://rocketamp-sample-store.myshopify.com/cdn/shop/products/Gildan_2000_Antique_Cherry_Red_Front_1024x1024.jpg?v=1527232987", + ), + ), ) ``` @@ -4178,7 +4338,23 @@ client.users.delete(
-**user_id:** `str` — Unique identifier for a User +**product:** `ProductSkuCreateProduct` + +
+
+ +
+
+ +**sku:** `ProductSkuCreateSku` + +
+
+ +
+
+ +**publish_status:** `typing.Optional[PublishStatus]`
@@ -4198,7 +4374,7 @@ client.users.delete(
-
client.users.update(...) +
client.products.get(...) -> ProductAndSkUs
@@ -4210,12 +4386,10 @@ client.users.delete(
-Update a User by ID - - Required scope | `users:write` +Retrieve a single product by its ID. All of its SKUs will also be +retrieved. -The email and password -fields cannot be updated using this endpoint +Required scope | `ecommerce:read`
@@ -4231,20 +4405,16 @@ fields cannot be updated using this endpoint ```python from webflow import Webflow -from webflow.resources.users import UsersUpdateRequestData +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.users.update( + +client.products.get( site_id="580e63e98c9a982ac9b8b741", - user_id="580e63e98c9a982ac9b8b741", - data=UsersUpdateRequestData( - name="Some One", - accept_privacy=False, - accept_communications=False, - ), - access_groups=["webflowers", "platinum", "free-tier"], + product_id="580e63fc8c9a982ac9b8b745", ) ``` @@ -4269,24 +4439,7 @@ client.users.update(
-**user_id:** `str` — Unique identifier for a User - -
-
- -
-
- -**data:** `typing.Optional[UsersUpdateRequestData]` - -
-
- -
-
- -**access_groups:** `typing.Optional[typing.Sequence[str]]` — An array of access group slugs. Access groups are assigned to the user as type `admin` and the user remains in the group until removed. - +**product_id:** `str` — Unique identifier for a Product
@@ -4306,7 +4459,7 @@ client.users.update(
-
client.users.invite(...) +
client.products.update(...) -> Product
@@ -4318,11 +4471,11 @@ client.users.update(
-Create and invite a user with an email address. +Update an existing Product. -The user will be sent and invite via email, which they will need to accept in order to join paid any paid access group. +Updating an existing Product will set the product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer. -Required scope | `users:write` +Required scope | `ecommerce:write`
@@ -4338,14 +4491,16 @@ Required scope | `users:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.users.invite( + +client.products.update( site_id="580e63e98c9a982ac9b8b741", - email="some.one@home.com", - access_groups=["webflowers"], + product_id="580e63fc8c9a982ac9b8b745", ) ``` @@ -4370,7 +4525,15 @@ client.users.invite(
-**email:** `str` — Email address of user to send invite to +**product_id:** `str` — Unique identifier for a Product + +
+
+ +
+
+ +**publish_status:** `typing.Optional[PublishStatus]`
@@ -4378,8 +4541,15 @@ client.users.invite(
-**access_groups:** `typing.Optional[typing.Sequence[str]]` — An array of access group slugs. Access groups are assigned to the user as type `admin` and the user remains in the group until removed. +**product:** `typing.Optional[Product]` + +
+
+ +
+
+**sku:** `typing.Optional[Sku]`
@@ -4399,8 +4569,7 @@ client.users.invite(
-## AccessGroups -
client.access_groups.list(...) +
client.products.create_sku(...) -> ProductsCreateSkuResponse
@@ -4412,9 +4581,11 @@ client.users.invite(
-Get a list of access groups for a site +Create additional SKUs to manage every [option and variant of your Product.](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants) + +Creating SKUs through the API will set the product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer. -Required scope | `users:read` +Required scope | `ecommerce:write`
@@ -4429,13 +4600,36 @@ Required scope | `users:read`
```python -from webflow import Webflow +from webflow import Webflow, Sku, SkuFieldData, SkuFieldDataPrice +from webflow.environment import WebflowEnvironment +import datetime client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.access_groups.list( + +client.products.create_sku( site_id="580e63e98c9a982ac9b8b741", + product_id="580e63fc8c9a982ac9b8b745", + skus=[ + Sku( + id="66072fb71b89448912e2681c", + cms_locale_id="653ad57de882f528b32e810e", + last_published=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"), + last_updated=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"), + created_on=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"), + field_data=SkuFieldData( + name="Colorful T-shirt - Default", + slug="colorful-t-shirt-default", + price=SkuFieldDataPrice( + value=2499, + unit="USD", + currency="USD", + ), + ), + ) + ], ) ``` @@ -4460,7 +4654,7 @@ client.access_groups.list(
-**offset:** `typing.Optional[float]` — Offset used for pagination if the results have more than limit records +**product_id:** `str` — Unique identifier for a Product
@@ -4468,7 +4662,7 @@ client.access_groups.list(
-**limit:** `typing.Optional[float]` — Maximum number of records to be returned (max limit: 100) +**skus:** `typing.List[Sku]` — An array of the SKU data your are adding
@@ -4476,10 +4670,7 @@ client.access_groups.list(
-**sort:** `typing.Optional[AccessGroupsListRequestSort]` - -Sort string to use when ordering access groups -Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) +**publish_status:** `typing.Optional[PublishStatus]`
@@ -4499,8 +4690,7 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`)
-## Products -
client.products.list(...) +
client.products.update_sku(...) -> Sku
@@ -4512,12 +4702,11 @@ Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`)
-Retrieve all products for a site. +Update a specified SKU. -Use `limit` and `offset` to page through all products with subsequent requests. All SKUs for each product -will also be fetched and returned. The `limit`, `offset` and `total` values represent Products only and do not include any SKUs. +Updating an existing SKU will set the Product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer. -Required scope | `ecommerce:read` +Required scope | `ecommerce:write`
@@ -4532,13 +4721,35 @@ Required scope | `ecommerce:read`
```python -from webflow import Webflow +from webflow import Webflow, Sku, SkuFieldData, SkuFieldDataPrice +from webflow.environment import WebflowEnvironment +import datetime client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.products.list( + +client.products.update_sku( site_id="580e63e98c9a982ac9b8b741", + product_id="580e63fc8c9a982ac9b8b745", + sku_id="5e8518516e147040726cc415", + sku=Sku( + id="66072fb71b89448912e2681c", + cms_locale_id="653ad57de882f528b32e810e", + last_published=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"), + last_updated=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"), + created_on=datetime.datetime.fromisoformat("2023-03-17T18:47:35+00:00"), + field_data=SkuFieldData( + name="Colorful T-shirt - Default", + slug="colorful-t-shirt-default", + price=SkuFieldDataPrice( + value=2499, + unit="USD", + currency="USD", + ), + ), + ), ) ``` @@ -4563,7 +4774,23 @@ client.products.list(
-**offset:** `typing.Optional[float]` — Offset used for pagination if the results have more than limit records +**product_id:** `str` — Unique identifier for a Product + +
+
+ +
+
+ +**sku_id:** `str` — Unique identifier for a SKU + +
+
+ +
+
+ +**sku:** `Sku`
@@ -4571,7 +4798,7 @@ client.products.list(
-**limit:** `typing.Optional[float]` — Maximum number of records to be returned (max limit: 100) +**publish_status:** `typing.Optional[PublishStatus]`
@@ -4591,7 +4818,8 @@ client.products.list(
-
client.products.create(...) +## Orders +
client.orders.list(...) -> OrderList
@@ -4603,20 +4831,9 @@ client.products.list(
-Create a new product and SKU. - -When you create a product, you will always create a SKU, since a Product Item must have, at minimum, a single SKU. - -To create a Product with multiple SKUs - for example a T-shirt in sizes small, medium and large: - - Create parameters in `sku-properties`, also known as [product options and variants.](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants). - - A single `sku-property` would be `color`. Within the `color` property, list the various colors of T-shirts as an array of `enum` values: `royal-blue`, `crimson-red`, and `forrest-green`. - - Once, you've created a Product and its `sku-properties` with `enum` values, Webflow will create a **default SKU**, which will automatically be a combination of the first `sku-properties` you've created. - - In our example, the default SKU will be a Royal Blue T-Shirt, because our first `enum` of our Color `sku-property` is Royal Blue. - - After you've created your product, you can create additional SKUs using the [Create SKU endpoint.](/data/reference/ecommerce/products/create-sku) - -Upon creation, the default product type will be `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer. +List all orders created for a given site. -Required scope | `ecommerce:write` +Required scope | `ecommerce:read`
@@ -4632,12 +4849,18 @@ Required scope | `ecommerce:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.products.create( + +client.orders.list( site_id="580e63e98c9a982ac9b8b741", + status="pending", + offset=1, + limit=1, ) ``` @@ -4662,7 +4885,7 @@ client.products.create(
-**publish_status:** `typing.Optional[PublishStatus]` +**status:** `typing.Optional[OrdersListRequestStatus]` — Filter the orders by status
@@ -4670,7 +4893,7 @@ client.products.create(
-**product:** `typing.Optional[Product]` +**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
@@ -4678,7 +4901,7 @@ client.products.create(
-**sku:** `typing.Optional[Sku]` +**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
@@ -4698,7 +4921,7 @@ client.products.create(
-
client.products.get(...) +
client.orders.get(...) -> Order
@@ -4729,13 +4952,16 @@ Required scope | `ecommerce:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.products.get( + +client.orders.get( site_id="580e63e98c9a982ac9b8b741", - product_id="580e63fc8c9a982ac9b8b745", + order_id="5e8518516e147040726cc415", ) ``` @@ -4760,7 +4986,7 @@ client.products.get(
-**product_id:** `str` — Unique identifier for a Product +**order_id:** `str` — Unique identifier for an Order
@@ -4780,7 +5006,7 @@ client.products.get(
-
client.products.update(...) +
client.orders.update(...) -> Order
@@ -4792,9 +5018,9 @@ client.products.get(
-Update an existing Product. - -Updating an existing Product will set the product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer. +This API lets you update the fields, `comment`, `shippingProvider`, +and/or `shippingTracking` for a given order. All three fields can be +updated simultaneously or independently. Required scope | `ecommerce:write`
@@ -4812,13 +5038,16 @@ Required scope | `ecommerce:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.products.update( + +client.orders.update( site_id="580e63e98c9a982ac9b8b741", - product_id="580e63fc8c9a982ac9b8b745", + order_id="5e8518516e147040726cc415", ) ``` @@ -4843,7 +5072,7 @@ client.products.update(
-**product_id:** `str` — Unique identifier for a Product +**order_id:** `str` — Unique identifier for an Order
@@ -4851,7 +5080,7 @@ client.products.update(
-**publish_status:** `typing.Optional[PublishStatus]` +**comment:** `typing.Optional[str]` — Arbitrary data for your records
@@ -4859,7 +5088,7 @@ client.products.update(
-**product:** `typing.Optional[Product]` +**shipping_provider:** `typing.Optional[str]` — Company or method used to ship order
@@ -4867,7 +5096,15 @@ client.products.update(
-**sku:** `typing.Optional[Sku]` +**shipping_tracking:** `typing.Optional[str]` — Tracking number for order shipment + +
+
+ +
+
+ +**shipping_tracking_url:** `typing.Optional[str]` — URL to track order shipment
@@ -4887,7 +5124,7 @@ client.products.update(
-
client.products.create_sku(...) +
client.orders.update_fulfill(...) -> Order
@@ -4899,9 +5136,7 @@ client.products.update(
-Create additional SKUs to manage every [option and variant of your Product.](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants) - -Creating SKUs through the API will set the product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer. +Updates an order's status to fulfilled Required scope | `ecommerce:write`
@@ -4918,15 +5153,17 @@ Required scope | `ecommerce:write`
```python -from webflow import Sku, Webflow +from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.products.create_sku( + +client.orders.update_fulfill( site_id="580e63e98c9a982ac9b8b741", - product_id="580e63fc8c9a982ac9b8b745", - skus=[Sku()], + order_id="5e8518516e147040726cc415", ) ``` @@ -4951,15 +5188,7 @@ client.products.create_sku(
-**product_id:** `str` — Unique identifier for a Product - -
-
- -
-
- -**skus:** `typing.Sequence[Sku]` — An array of the SKU data your are adding +**order_id:** `str` — Unique identifier for an Order
@@ -4967,7 +5196,7 @@ client.products.create_sku(
-**publish_status:** `typing.Optional[PublishStatus]` +**send_order_fulfilled_email:** `typing.Optional[bool]` — Whether or not the Order Fulfilled email should be sent
@@ -4987,7 +5216,7 @@ client.products.create_sku(
-
client.products.update_sku(...) +
client.orders.update_unfulfill(...) -> Order
@@ -4999,9 +5228,7 @@ client.products.create_sku(
-Update a specified SKU. - -Updating an existing SKU will set the Product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer. +Updates an order's status to unfulfilled Required scope | `ecommerce:write`
@@ -5018,16 +5245,17 @@ Required scope | `ecommerce:write`
```python -from webflow import Sku, Webflow +from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.products.update_sku( + +client.orders.update_unfulfill( site_id="580e63e98c9a982ac9b8b741", - product_id="580e63fc8c9a982ac9b8b745", - sku_id="5e8518516e147040726cc415", - sku=Sku(), + order_id="5e8518516e147040726cc415", ) ``` @@ -5052,31 +5280,7 @@ client.products.update_sku(
-**product_id:** `str` — Unique identifier for a Product - -
-
- -
-
- -**sku_id:** `str` — Unique identifier for a SKU - -
-
- -
-
- -**sku:** `Sku` - -
-
- -
-
- -**publish_status:** `typing.Optional[PublishStatus]` +**order_id:** `str` — Unique identifier for an Order
@@ -5096,8 +5300,7 @@ client.products.update_sku(
-## Orders -
client.orders.list(...) +
client.orders.refund(...) -> Order
@@ -5109,9 +5312,10 @@ client.products.update_sku(
-List all orders created for a given site. +This API will reverse a Stripe charge and refund an order back to a +customer. It will also set the order's status to `refunded`. -Required scope | `ecommerce:read` +Required scope | `ecommerce:write`
@@ -5127,12 +5331,16 @@ Required scope | `ecommerce:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.orders.list( + +client.orders.refund( site_id="580e63e98c9a982ac9b8b741", + order_id="5e8518516e147040726cc415", ) ``` @@ -5157,15 +5365,7 @@ client.orders.list(
-**status:** `typing.Optional[OrdersListRequestStatus]` — Filter the orders by status - -
-
- -
-
- -**offset:** `typing.Optional[float]` — Offset used for pagination if the results have more than limit records +**order_id:** `str` — Unique identifier for an Order
@@ -5173,7 +5373,7 @@ client.orders.list(
-**limit:** `typing.Optional[float]` — Maximum number of records to be returned (max limit: 100) +**reason:** `typing.Optional[OrdersRefundRequestReason]` — The reason for the refund
@@ -5193,7 +5393,8 @@ client.orders.list(
-
client.orders.get(...) +## Inventory +
client.inventory.list(...) -> InventoryItem
@@ -5205,8 +5406,7 @@ client.orders.list(
-Retrieve a single product by its ID. All of its SKUs will also be -retrieved. +List the current inventory levels for a particular SKU item. Required scope | `ecommerce:read`
@@ -5224,13 +5424,16 @@ Required scope | `ecommerce:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.orders.get( - site_id="580e63e98c9a982ac9b8b741", - order_id="5e8518516e147040726cc415", + +client.inventory.list( + sku_collection_id="6377a7c4b7a79608c34a46f7", + sku_id="5e8518516e147040726cc415", ) ``` @@ -5247,7 +5450,7 @@ client.orders.get(
-**site_id:** `str` — Unique identifier for a Site +**sku_collection_id:** `str` — Unique identifier for a SKU collection. Use the List Collections API to find this ID.
@@ -5255,7 +5458,7 @@ client.orders.get(
-**order_id:** `str` — Unique identifier for an Order +**sku_id:** `str` — Unique identifier for a SKU
@@ -5275,7 +5478,7 @@ client.orders.get(
-
client.orders.update(...) +
client.inventory.update(...) -> InventoryItem
@@ -5287,9 +5490,11 @@ client.orders.get(
-This API lets you update the fields, `comment`, `shippingProvider`, -and/or `shippingTracking` for a given order. All three fields can be -updated simultaneously or independently. +Updates the current inventory levels for a particular SKU item. + +Updates may be given in one or two methods, absolutely or incrementally. +- Absolute updates are done by setting `quantity` directly. +- Incremental updates are by specifying the inventory delta in `updateQuantity` which is then added to the `quantity` stored on the server. Required scope | `ecommerce:write`
@@ -5307,13 +5512,17 @@ Required scope | `ecommerce:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.orders.update( - site_id="580e63e98c9a982ac9b8b741", - order_id="5e8518516e147040726cc415", + +client.inventory.update( + sku_collection_id="6377a7c4b7a79608c34a46f7", + sku_id="5e8518516e147040726cc415", + inventory_type="infinite", ) ``` @@ -5330,15 +5539,7 @@ client.orders.update(
-**site_id:** `str` — Unique identifier for a Site - -
-
- -
-
- -**order_id:** `str` — Unique identifier for an Order +**sku_collection_id:** `str` — Unique identifier for a SKU collection. Use the List Collections API to find this ID.
@@ -5346,7 +5547,7 @@ client.orders.update(
-**comment:** `typing.Optional[str]` — Arbitrary data for your records +**sku_id:** `str` — Unique identifier for a SKU
@@ -5354,7 +5555,7 @@ client.orders.update(
-**shipping_provider:** `typing.Optional[str]` — Company or method used to ship order +**inventory_type:** `InventoryUpdateRequestInventoryType` — infinite or finite
@@ -5362,7 +5563,7 @@ client.orders.update(
-**shipping_tracking:** `typing.Optional[str]` — Tracking number for order shipment +**update_quantity:** `typing.Optional[float]` — Adds this quantity to currently store quantity. Can be negative.
@@ -5370,7 +5571,7 @@ client.orders.update(
-**shipping_tracking_url:** `typing.Optional[str]` — URL to track order shipment +**quantity:** `typing.Optional[float]` — Immediately sets quantity to this value.
@@ -5390,7 +5591,8 @@ client.orders.update(
-
client.orders.update_fulfill(...) +## Ecommerce +
client.ecommerce.get_settings(...) -> EcommerceSettings
@@ -5402,9 +5604,9 @@ client.orders.update(
-Updates an order's status to fulfilled +Retrieve ecommerce settings for a site. -Required scope | `ecommerce:write` +Required scope | `ecommerce:read`
@@ -5420,13 +5622,15 @@ Required scope | `ecommerce:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.orders.update_fulfill( + +client.ecommerce.get_settings( site_id="580e63e98c9a982ac9b8b741", - order_id="5e8518516e147040726cc415", ) ``` @@ -5451,22 +5655,6 @@ client.orders.update_fulfill(
-**order_id:** `str` — Unique identifier for an Order - -
-
- -
-
- -**send_order_fulfilled_email:** `typing.Optional[bool]` — Whether or not the Order Fulfilled email should be sent - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -5479,7 +5667,8 @@ client.orders.update_fulfill(
-
client.orders.update_unfulfill(...) +## Collections Fields +
client.collections.fields.create(...) -> FieldCreate
@@ -5491,9 +5680,13 @@ client.orders.update_fulfill(
-Updates an order's status to unfulfilled +Create a custom field in a collection. -Required scope | `ecommerce:write` +Field validation is currently not available through the API. + +Bulk creation of fields is not supported with this endpoint. To add multiple fields at once, include them when you [create the collection.](/data/v2.0.0/reference/cms/collections/create) + +Required scope | `cms:write`
@@ -5508,14 +5701,24 @@ Required scope | `ecommerce:write`
```python -from webflow import Webflow +from webflow import Webflow, StaticField +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.orders.update_unfulfill( - site_id="580e63e98c9a982ac9b8b741", - order_id="5e8518516e147040726cc415", + +client.collections.fields.create( + collection_id="580e63fc8c9a982ac9b8b745", + request=StaticField( + id="562ac0395358780a1f5e6fbc", + is_editable=True, + is_required=False, + type="RichText", + display_name="Post Body", + help_text="Add the body of your post here", + ), ) ``` @@ -5532,7 +5735,7 @@ client.orders.update_unfulfill(
-**site_id:** `str` — Unique identifier for a Site +**collection_id:** `str` — Unique identifier for a Collection
@@ -5540,7 +5743,7 @@ client.orders.update_unfulfill(
-**order_id:** `str` — Unique identifier for an Order +**request:** `FieldCreate`
@@ -5560,7 +5763,7 @@ client.orders.update_unfulfill(
-
client.orders.refund(...) +
client.collections.fields.delete(...)
@@ -5572,10 +5775,9 @@ client.orders.update_unfulfill(
-This API will reverse a Stripe charge and refund an order back to a -customer. It will also set the order's status to `refunded`. +Delete a custom field in a collection. This endpoint does not currently support bulk deletion. -Required scope | `ecommerce:write` +Required scope | `cms:write`
@@ -5591,13 +5793,16 @@ Required scope | `ecommerce:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.orders.refund( - site_id="580e63e98c9a982ac9b8b741", - order_id="5e8518516e147040726cc415", + +client.collections.fields.delete( + collection_id="580e63fc8c9a982ac9b8b745", + field_id="580e63fc8c9a982ac9b8b745", ) ``` @@ -5614,15 +5819,7 @@ client.orders.refund(
-**site_id:** `str` — Unique identifier for a Site - -
-
- -
-
- -**order_id:** `str` — Unique identifier for an Order +**collection_id:** `str` — Unique identifier for a Collection
@@ -5630,7 +5827,7 @@ client.orders.refund(
-**reason:** `typing.Optional[OrdersRefundRequestReason]` — The reason for the refund +**field_id:** `str` — Unique identifier for a Field in a collection
@@ -5650,8 +5847,7 @@ client.orders.refund(
-## Inventory -
client.inventory.list(...) +
client.collections.fields.update(...) -> Field
@@ -5663,9 +5859,9 @@ client.orders.refund(
-List the current inventory levels for a particular SKU item. +Update a custom field in a collection. -Required scope | `ecommerce:read` +Required scope | `cms:write`
@@ -5681,13 +5877,19 @@ Required scope | `ecommerce:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.inventory.list( + +client.collections.fields.update( collection_id="580e63fc8c9a982ac9b8b745", - item_id="580e64008c9a982ac9b8b754", + field_id="580e63fc8c9a982ac9b8b745", + is_required=False, + display_name="Post Body", + help_text="Add the body of your post here", ) ``` @@ -5712,7 +5914,31 @@ client.inventory.list(
-**item_id:** `str` — Unique identifier for an Item +**field_id:** `str` — Unique identifier for a Field in a collection + +
+
+ +
+
+ +**is_required:** `typing.Optional[bool]` — Define whether a field is required in a collection + +
+
+ +
+
+ +**display_name:** `typing.Optional[str]` — The name of a field + +
+
+ +
+
+ +**help_text:** `typing.Optional[str]` — Additional text to help anyone filling out this field
@@ -5732,7 +5958,8 @@ client.inventory.list(
-
client.inventory.update(...) +## Collections Items +
client.collections.items.list_items(...) -> CollectionItemList
@@ -5744,13 +5971,9 @@ client.inventory.list(
-Updates the current inventory levels for a particular SKU item. +List of all Items within a Collection. -Updates may be given in one or two methods, absolutely or incrementally. -- Absolute updates are done by setting `quantity` directly. -- Incremental updates are by specifying the inventory delta in `updateQuantity` which is then added to the `quantity` stored on the server. - -Required scope | `ecommerce:write` +Required scope | `CMS:read`
@@ -5766,14 +5989,22 @@ Required scope | `ecommerce:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.inventory.update( + +client.collections.items.list_items( collection_id="580e63fc8c9a982ac9b8b745", - item_id="580e64008c9a982ac9b8b754", - inventory_type="infinite", + cms_locale_id="cmsLocaleId", + offset=1, + limit=1, + name="name", + slug="slug", + sort_by="lastPublished", + sort_order="asc", ) ``` @@ -5798,7 +6029,7 @@ client.inventory.update(
-**item_id:** `str` — Unique identifier for an Item +**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
@@ -5806,7 +6037,7 @@ client.inventory.update(
-**inventory_type:** `InventoryUpdateRequestInventoryType` — infinite or finite +**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
@@ -5814,7 +6045,7 @@ client.inventory.update(
-**update_quantity:** `typing.Optional[float]` — Adds this quantity to currently store quantity. Can be negative. +**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
@@ -5822,7 +6053,7 @@ client.inventory.update(
-**quantity:** `typing.Optional[float]` — Immediately sets quantity to this value. +**name:** `typing.Optional[str]` — Filter by the exact name of the item(s)
@@ -5830,72 +6061,31 @@ client.inventory.update(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**slug:** `typing.Optional[str]` — Filter by the exact slug of the item
- -
- - - - -
- -## Ecommerce -
client.ecommerce.get_settings(...) -
-
- -#### 📝 Description
-
-
- -Retrieve ecommerce settings for a site. - -Required scope | `ecommerce:read` -
-
+**last_published:** `typing.Optional[ItemsListItemsRequestLastPublished]` — Filter by the last published date of the item(s) +
-#### 🔌 Usage - -
-
-
-```python -from webflow import Webflow - -client = Webflow( - access_token="YOUR_ACCESS_TOKEN", -) -client.ecommerce.get_settings( - site_id="580e63e98c9a982ac9b8b741", -) - -``` -
-
+**sort_by:** `typing.Optional[ItemsListItemsRequestSortBy]` — Sort results by the provided value +
-#### ⚙️ Parameters - -
-
-
-**site_id:** `str` — Unique identifier for a Site +**sort_order:** `typing.Optional[ItemsListItemsRequestSortOrder]` — Sorts the results by asc or desc
@@ -5915,8 +6105,7 @@ client.ecommerce.get_settings(
-## Collections Fields -
client.collections.fields.create(...) +
client.collections.items.create_item(...) -> CollectionItem
@@ -5928,16 +6117,12 @@ client.ecommerce.get_settings(
-Create a custom field in a collection. +Create Item(s) in a Collection. -Slugs must be all lowercase letters without spaces. -If you pass a string with uppercase letters and/or spaces to the "Slug" property, Webflow will -convert the slug to lowercase and replace spaces with "-." -Only some field types can be created through the API. -This endpoint does not currently support bulk creation. +To create items across multiple locales, please use [this endpoint.](/data/reference/cms/collection-items/staged-items/create-items) -Required scope | `cms:write` +Required scope | `CMS:write`
@@ -5952,17 +6137,25 @@ Required scope | `cms:write`
```python -from webflow import Webflow +from webflow import Webflow, CollectionItemPostSingle, CollectionItemPostSingleFieldData +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.collections.fields.create( + +client.collections.items.create_item( collection_id="580e63fc8c9a982ac9b8b745", - is_required=False, - type="RichText", - display_name="Post Body", - help_text="Add the body of your post here", + skip_invalid_files=True, + request=CollectionItemPostSingle( + is_archived=False, + is_draft=False, + field_data=CollectionItemPostSingleFieldData( + name="The Hitchhiker\'s Guide to the Galaxy", + slug="hitchhikers-guide-to-the-galaxy", + ), + ), ) ``` @@ -5987,23 +6180,7 @@ client.collections.fields.create(
-**type:** `FieldCreateType` — Choose these appropriate field type for your collection data - -
-
- -
-
- -**display_name:** `str` — The name of a field - -
-
- -
-
- -**is_required:** `typing.Optional[bool]` — define whether a field is required in a collection +**request:** `ItemsCreateItemRequestBody`
@@ -6011,7 +6188,7 @@ client.collections.fields.create(
-**help_text:** `typing.Optional[str]` — Additional text to help anyone filling out this field +**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
@@ -6031,7 +6208,7 @@ client.collections.fields.create(
-
client.collections.fields.delete(...) +
client.collections.items.delete_items(...)
@@ -6043,9 +6220,11 @@ client.collections.fields.create(
-Delete a custom field in a collection. This endpoint does not currently support bulk deletion. +Delete Items from a Collection. -Required scope | `cms:write` +Items will only be deleted in the primary locale unless a `cmsLocaleId` is included in the request. + +Required scope | `CMS:write`
@@ -6061,13 +6240,21 @@ Required scope | `cms:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment +from webflow.collections.items import ItemsDeleteItemsRequestItemsItem client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.collections.fields.delete( + +client.collections.items.delete_items( collection_id="580e63fc8c9a982ac9b8b745", - field_id="580e63fc8c9a982ac9b8b745", + items=[ + ItemsDeleteItemsRequestItemsItem( + id="580e64008c9a982ac9b8b754", + ) + ], ) ``` @@ -6092,7 +6279,7 @@ client.collections.fields.delete(
-**field_id:** `str` — Unique identifier for a Field in a collection +**items:** `typing.List[ItemsDeleteItemsRequestItemsItem]`
@@ -6112,7 +6299,7 @@ client.collections.fields.delete(
-
client.collections.fields.update(...) +
client.collections.items.update_items(...) -> ItemsUpdateItemsResponse
@@ -6124,9 +6311,13 @@ client.collections.fields.delete(
-Update a custom field in a collection. +Update a single item or multiple items in a Collection. -Required scope | `cms:write` +The limit for this endpoint is 100 items. + +Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request. + +Required scope | `CMS:write`
@@ -6141,17 +6332,51 @@ Required scope | `cms:write`
```python -from webflow import Webflow +from webflow import Webflow, CollectionItemWithIdInput, CollectionItemWithIdInputFieldData +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.collections.fields.update( + +client.collections.items.update_items( collection_id="580e63fc8c9a982ac9b8b745", - field_id="580e63fc8c9a982ac9b8b745", - is_required=False, - display_name="Post Body", - help_text="Add the body of your post here", + skip_invalid_files=True, + items=[ + CollectionItemWithIdInput( + id="66f6ed9576ddacf3149d5ea6", + cms_locale_id="66f6e966c9e1dc700a857ca5", + field_data=CollectionItemWithIdInputFieldData( + name="Ne Paniquez Pas", + slug="ne-paniquez-pas", + ), + ), + CollectionItemWithIdInput( + id="66f6ed9576ddacf3149d5ea6", + cms_locale_id="66f6e966c9e1dc700a857ca4", + field_data=CollectionItemWithIdInputFieldData( + name="No Entrar en Pánico", + slug="no-entrar-en-panico", + ), + ), + CollectionItemWithIdInput( + id="66f6ed9576ddacf3149d5eaa", + cms_locale_id="66f6e966c9e1dc700a857ca5", + field_data=CollectionItemWithIdInputFieldData( + name="Au Revoir et Merci pour Tous les Poissons", + slug="au-revoir-et-merci", + ), + ), + CollectionItemWithIdInput( + id="66f6ed9576ddacf3149d5eaa", + cms_locale_id="66f6e966c9e1dc700a857ca4", + field_data=CollectionItemWithIdInputFieldData( + name="Hasta Luego y Gracias por Todo el Pescado", + slug="hasta-luego-y-gracias", + ), + ) + ], ) ``` @@ -6176,23 +6401,7 @@ client.collections.fields.update(
-**field_id:** `str` — Unique identifier for a Field in a collection - -
-
- -
-
- -**is_required:** `typing.Optional[bool]` — Define whether a field is required in a collection - -
-
- -
-
- -**display_name:** `typing.Optional[str]` — The name of a field +**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
@@ -6200,7 +6409,7 @@ client.collections.fields.update(
-**help_text:** `typing.Optional[str]` — Additional text to help anyone filling out this field +**items:** `typing.Optional[typing.List[CollectionItemWithIdInput]]`
@@ -6220,8 +6429,7 @@ client.collections.fields.update(
-## Collections Items -
client.collections.items.list_items(...) +
client.collections.items.list_items_live(...) -> CollectionItemList
@@ -6233,7 +6441,11 @@ client.collections.fields.update(
-List of all Items within a Collection. +List all published items in a collection. + + + Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations. + Required scope | `CMS:read`
@@ -6251,12 +6463,22 @@ Required scope | `CMS:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.collections.items.list_items( + +client.collections.items.list_items_live( collection_id="580e63fc8c9a982ac9b8b745", + cms_locale_id="cmsLocaleId", + offset=1, + limit=1, + name="name", + slug="slug", + sort_by="lastPublished", + sort_order="asc", ) ``` @@ -6289,7 +6511,7 @@ client.collections.items.list_items(
-**offset:** `typing.Optional[float]` — Offset used for pagination if the results have more than limit records +**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
@@ -6297,7 +6519,7 @@ client.collections.items.list_items(
-**limit:** `typing.Optional[float]` — Maximum number of records to be returned (max limit: 100) +**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
@@ -6305,7 +6527,7 @@ client.collections.items.list_items(
-**name:** `typing.Optional[str]` — The name of the item(s) +**name:** `typing.Optional[str]` — Filter by the exact name of the item(s)
@@ -6313,7 +6535,7 @@ client.collections.items.list_items(
-**slug:** `typing.Optional[str]` — The slug of the item +**slug:** `typing.Optional[str]` — Filter by the exact slug of the item
@@ -6321,7 +6543,7 @@ client.collections.items.list_items(
-**sort_by:** `typing.Optional[ItemsListItemsRequestSortBy]` — Sort results by the provided value +**last_published:** `typing.Optional[ItemsListItemsLiveRequestLastPublished]` — Filter by the last published date of the item(s)
@@ -6329,7 +6551,15 @@ client.collections.items.list_items(
-**sort_order:** `typing.Optional[ItemsListItemsRequestSortOrder]` — Sorts the results by asc or desc +**sort_by:** `typing.Optional[ItemsListItemsLiveRequestSortBy]` — Sort results by the provided value + +
+
+ +
+
+ +**sort_order:** `typing.Optional[ItemsListItemsLiveRequestSortOrder]` — Sorts the results by asc or desc
@@ -6349,7 +6579,7 @@ client.collections.items.list_items(
-
client.collections.items.create_item(...) +
client.collections.items.create_item_live(...) -> CollectionItem
@@ -6361,10 +6591,11 @@ client.collections.items.list_items(
-Create Item(s) in a Collection. +Create item(s) in a collection that will be immediately published to the live site. + +To create items across multiple locales, [please use this endpoint.](/data/reference/cms/collection-items/staged-items/create-items) -To create items across multiple locales, please use [this endpoint.](/v2.0.0/data/reference/cms/collection-items/staged-items/create-items) Required scope | `CMS:write`
@@ -6381,37 +6612,24 @@ Required scope | `CMS:write`
```python -from webflow import ( - CollectionItemPostSingle, - CollectionItemPostSingleFieldData, - Webflow, -) -from webflow.resources.collections.resources.items import MultipleItems +from webflow import Webflow, CollectionItem, CollectionItemFieldData +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.collections.items.create_item( + +client.collections.items.create_item_live( collection_id="580e63fc8c9a982ac9b8b745", - request=MultipleItems( - items=[ - CollectionItemPostSingle( - is_archived=False, - is_draft=False, - field_data=CollectionItemPostSingleFieldData( - name="Senior Data Analyst", - slug="senior-data-analyst", - ), - ), - CollectionItemPostSingle( - is_archived=False, - is_draft=False, - field_data=CollectionItemPostSingleFieldData( - name="Product Manager", - slug="product-manager", - ), - ), - ], + skip_invalid_files=True, + request=CollectionItem( + is_archived=False, + is_draft=False, + field_data=CollectionItemFieldData( + name="The Hitchhiker\'s Guide to the Galaxy", + slug="hitchhikers-guide-to-the-galaxy", + ), ), ) @@ -6437,7 +6655,15 @@ client.collections.items.create_item(
-**request:** `ItemsCreateItemRequest` +**request:** `ItemsCreateItemLiveRequestBody` + +
+
+ +
+
+ +**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
@@ -6457,7 +6683,7 @@ client.collections.items.create_item(
-
client.collections.items.delete_items(...) +
client.collections.items.delete_items_live(...)
@@ -6469,9 +6695,9 @@ client.collections.items.create_item(
-Delete Items from a Collection. +Unpublish up to 100 items from the live site and set the `isDraft` property to `true`. -**Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be deleted only in the primary locale. +Items will only be unpublished in the primary locale unless a `cmsLocaleId` is included in the request. Required scope | `CMS:write`
@@ -6489,12 +6715,21 @@ Required scope | `CMS:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment +from webflow.collections.items import ItemsDeleteItemsLiveRequestItemsItem client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.collections.items.delete_items( + +client.collections.items.delete_items_live( collection_id="580e63fc8c9a982ac9b8b745", + items=[ + ItemsDeleteItemsLiveRequestItemsItem( + id="580e64008c9a982ac9b8b754", + ) + ], ) ``` @@ -6519,7 +6754,7 @@ client.collections.items.delete_items(
-**items:** `typing.Optional[typing.Sequence[ItemsDeleteItemsRequestItemsItem]]` +**items:** `typing.List[ItemsDeleteItemsLiveRequestItemsItem]`
@@ -6539,7 +6774,7 @@ client.collections.items.delete_items(
-
client.collections.items.update_items(...) +
client.collections.items.update_items_live(...) -> CollectionItemListNoPagination
@@ -6551,9 +6786,9 @@ client.collections.items.delete_items(
-Update a single item or multiple items (up to 100) in a Collection. +Update a single published item or multiple published items (up to 100) in a Collection -**Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be updated only in the primary locale. +Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request. Required scope | `CMS:write`
@@ -6570,17 +6805,17 @@ Required scope | `CMS:write`
```python -from webflow import ( - CollectionItemWithIdInput, - CollectionItemWithIdInputFieldData, - Webflow, -) +from webflow import Webflow, CollectionItemWithIdInput, CollectionItemWithIdInputFieldData +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.collections.items.update_items( + +client.collections.items.update_items_live( collection_id="580e63fc8c9a982ac9b8b745", + skip_invalid_files=True, items=[ CollectionItemWithIdInput( id="66f6ed9576ddacf3149d5ea6", @@ -6613,7 +6848,7 @@ client.collections.items.update_items( name="Hasta Luego y Gracias por Todo el Pescado", slug="hasta-luego-y-gracias", ), - ), + ) ], ) @@ -6639,7 +6874,15 @@ client.collections.items.update_items(
-**items:** `typing.Optional[typing.Sequence[CollectionItemWithIdInput]]` +**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + +
+
+ +
+
+ +**items:** `typing.Optional[typing.List[CollectionItemWithIdInput]]`
@@ -6659,7 +6902,7 @@ client.collections.items.update_items(
-
client.collections.items.list_items_live(...) +
client.collections.items.create_items(...) -> BulkCollectionItem
@@ -6671,9 +6914,14 @@ client.collections.items.update_items(
-List of all live Items within a Collection. +Create an item or multiple items in a CMS Collection across multiple corresponding locales. -Required scope | `CMS:read` + + - This endpoint can create up to 100 items in a request. + - If the `cmsLocaleIds` parameter is not included in the request, an item will only be created in the primary locale. + + +Required scope | `CMS:write`
@@ -6689,12 +6937,28 @@ Required scope | `CMS:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment +from webflow.collections.items import SingleCmsItem client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.collections.items.list_items_live( + +client.collections.items.create_items( collection_id="580e63fc8c9a982ac9b8b745", + skip_invalid_files=True, + cms_locale_ids=[ + "66f6e966c9e1dc700a857ca3", + "66f6e966c9e1dc700a857ca4", + "66f6e966c9e1dc700a857ca5" + ], + is_archived=False, + is_draft=False, + field_data=SingleCmsItem( + name="Don’t Panic", + slug="dont-panic", + ), ) ``` @@ -6719,7 +6983,7 @@ client.collections.items.list_items_live(
-**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string. +**field_data:** `CreateBulkCollectionItemRequestBodyFieldData`
@@ -6727,7 +6991,7 @@ client.collections.items.list_items_live(
-**offset:** `typing.Optional[float]` — Offset used for pagination if the results have more than limit records +**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
@@ -6735,7 +6999,7 @@ client.collections.items.list_items_live(
-**limit:** `typing.Optional[float]` — Maximum number of records to be returned (max limit: 100) +**cms_locale_ids:** `typing.Optional[typing.List[str]]` — Array of identifiers for the locales where the item will be created
@@ -6743,7 +7007,7 @@ client.collections.items.list_items_live(
-**name:** `typing.Optional[str]` — The name of the item(s) +**is_archived:** `typing.Optional[bool]` — Indicates whether the item is archived.
@@ -6751,7 +7015,7 @@ client.collections.items.list_items_live(
-**slug:** `typing.Optional[str]` — The slug of the item +**is_draft:** `typing.Optional[bool]` — Indicates whether the item is in draft state.
@@ -6759,35 +7023,19 @@ client.collections.items.list_items_live(
-**sort_by:** `typing.Optional[ItemsListItemsLiveRequestSortBy]` — Sort results by the provided value +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+ +
-
-
-**sort_order:** `typing.Optional[ItemsListItemsLiveRequestSortOrder]` — Sorts the results by asc or desc -
+
-
-
- -**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. - -
-
- - - - - - -
- -
client.collections.items.create_item_live(...) +
client.collections.items.get_item(...) -> CollectionItem
@@ -6799,13 +7047,9 @@ client.collections.items.list_items_live(
-Create live Item(s) in a Collection. The Item(s) will be published to the live site. - - -To create items across multiple locales, [please use this endpoint.](/v2.0.0/data/reference/cms/collection-items/staged-items/create-items) - +Get details of a selected Collection Item. -Required scope | `CMS:write` +Required scope | `CMS:read`
@@ -6820,34 +7064,18 @@ Required scope | `CMS:write`
```python -from webflow import CollectionItem, CollectionItemFieldData, Webflow -from webflow.resources.collections.resources.items import MultipleLiveItems +from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.collections.items.create_item_live( + +client.collections.items.get_item( collection_id="580e63fc8c9a982ac9b8b745", - request=MultipleLiveItems( - items=[ - CollectionItem( - is_archived=False, - is_draft=False, - field_data=CollectionItemFieldData( - name="Senior Data Analyst", - slug="senior-data-analyst", - ), - ), - CollectionItem( - is_archived=False, - is_draft=False, - field_data=CollectionItemFieldData( - name="Product Manager", - slug="product-manager", - ), - ), - ], - ), + item_id="580e64008c9a982ac9b8b754", + cms_locale_id="cmsLocaleId", ) ``` @@ -6872,7 +7100,15 @@ client.collections.items.create_item_live(
-**request:** `ItemsCreateItemLiveRequest` +**item_id:** `str` — Unique identifier for an Item + +
+
+ +
+
+ +**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
@@ -6892,7 +7128,7 @@ client.collections.items.create_item_live(
-
client.collections.items.delete_items_live(...) +
client.collections.items.delete_item(...)
@@ -6904,9 +7140,7 @@ client.collections.items.create_item_live(
-Remove an item or multiple items (up to 100 items) from the live site. Deleting published items will unpublish the items from the live site and set them to draft. - -**Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be unpublished only in the primary locale. +Delete an item from a collection. Required scope | `CMS:write`
@@ -6924,12 +7158,17 @@ Required scope | `CMS:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.collections.items.delete_items_live( + +client.collections.items.delete_item( collection_id="580e63fc8c9a982ac9b8b745", + item_id="580e64008c9a982ac9b8b754", + cms_locale_id="cmsLocaleId", ) ``` @@ -6954,7 +7193,15 @@ client.collections.items.delete_items_live(
-**items:** `typing.Optional[typing.Sequence[ItemsDeleteItemsLiveRequestItemsItem]]` +**item_id:** `str` — Unique identifier for an Item + +
+
+ +
+
+ +**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
@@ -6974,7 +7221,7 @@ client.collections.items.delete_items_live(
-
client.collections.items.update_items_live(...) +
client.collections.items.update_item(...) -> CollectionItem
@@ -6986,9 +7233,7 @@ client.collections.items.delete_items_live(
-Update a single live item or multiple live items (up to 100) in a Collection - -**Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be updated only in the primary locale. +Update a selected Item in a Collection. Required scope | `CMS:write`
@@ -7005,51 +7250,24 @@ Required scope | `CMS:write`
```python -from webflow import ( - CollectionItemWithIdInput, - CollectionItemWithIdInputFieldData, - Webflow, -) +from webflow import Webflow, CollectionItemPatchSingleFieldData +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.collections.items.update_items_live( + +client.collections.items.update_item( collection_id="580e63fc8c9a982ac9b8b745", - items=[ - CollectionItemWithIdInput( - id="66f6ed9576ddacf3149d5ea6", - cms_locale_id="66f6e966c9e1dc700a857ca5", - field_data=CollectionItemWithIdInputFieldData( - name="Ne Paniquez Pas", - slug="ne-paniquez-pas", - ), - ), - CollectionItemWithIdInput( - id="66f6ed9576ddacf3149d5ea6", - cms_locale_id="66f6e966c9e1dc700a857ca4", - field_data=CollectionItemWithIdInputFieldData( - name="No Entrar en Pánico", - slug="no-entrar-en-panico", - ), - ), - CollectionItemWithIdInput( - id="66f6ed9576ddacf3149d5eaa", - cms_locale_id="66f6e966c9e1dc700a857ca5", - field_data=CollectionItemWithIdInputFieldData( - name="Au Revoir et Merci pour Tous les Poissons", - slug="au-revoir-et-merci", - ), - ), - CollectionItemWithIdInput( - id="66f6ed9576ddacf3149d5eaa", - cms_locale_id="66f6e966c9e1dc700a857ca4", - field_data=CollectionItemWithIdInputFieldData( - name="Hasta Luego y Gracias por Todo el Pescado", - slug="hasta-luego-y-gracias", - ), - ), - ], + item_id="580e64008c9a982ac9b8b754", + skip_invalid_files=True, + is_archived=False, + is_draft=False, + field_data=CollectionItemPatchSingleFieldData( + name="The Hitchhiker\'s Guide to the Galaxy", + slug="hitchhikers-guide-to-the-galaxy", + ), ) ``` @@ -7074,7 +7292,23 @@ client.collections.items.update_items_live(
-**items:** `typing.Optional[typing.Sequence[CollectionItemWithIdInput]]` +**item_id:** `str` — Unique identifier for an Item + +
+
+ +
+
+ +**request:** `CollectionItemPatchSingle` + +
+
+ +
+
+ +**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
@@ -7094,7 +7328,7 @@ client.collections.items.update_items_live(
-
client.collections.items.create_items(...) +
client.collections.items.get_item_live(...) -> CollectionItem
@@ -7106,13 +7340,13 @@ client.collections.items.update_items_live(
-Create an item or multiple items in a CMS Collection across multiple corresponding locales. +Get details of a selected Collection live Item. -**Notes:** - - This endpoint can create up to 100 items in a request. - - If the `cmsLocaleIds` parameter is undefined or empty and localization is enabled, items will only be created in the primary locale. + + Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations. + -Required scope | `CMS:write` +Required scope | `CMS:read`
@@ -7128,24 +7362,17 @@ Required scope | `CMS:write` ```python from webflow import Webflow -from webflow.resources.collections.resources.items import SingleCmsItem +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.collections.items.create_items( + +client.collections.items.get_item_live( collection_id="580e63fc8c9a982ac9b8b745", - cms_locale_ids=[ - "66f6e966c9e1dc700a857ca3", - "66f6e966c9e1dc700a857ca4", - "66f6e966c9e1dc700a857ca5", - ], - is_archived=False, - is_draft=False, - field_data=SingleCmsItem( - name="Don’t Panic", - slug="dont-panic", - ), + item_id="580e64008c9a982ac9b8b754", + cms_locale_id="cmsLocaleId", ) ``` @@ -7170,23 +7397,7 @@ client.collections.items.create_items(
-**field_data:** `CreateBulkCollectionItemRequestBodyFieldData` - -
-
- -
-
- -**cms_locale_ids:** `typing.Optional[typing.Sequence[str]]` — Array of identifiers for the locales where the item will be created - -
-
- -
-
- -**is_archived:** `typing.Optional[bool]` — Indicates whether the item is archived. +**item_id:** `str` — Unique identifier for an Item
@@ -7194,7 +7405,7 @@ client.collections.items.create_items(
-**is_draft:** `typing.Optional[bool]` — Indicates whether the item is in draft state. +**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string.
@@ -7214,7 +7425,7 @@ client.collections.items.create_items(
-
client.collections.items.get_item(...) +
client.collections.items.delete_item_live(...)
@@ -7226,9 +7437,11 @@ client.collections.items.create_items(
-Get details of a selected Collection Item. +Unpublish a live item from the site and set the `isDraft` property to `true`. -Required scope | `CMS:read` +For bulk unpublishing, please use [this endpoint.](/data/v2.0.0/reference/cms/collection-items/live-items/delete-items-live) + +Required scope | `CMS:write`
@@ -7244,13 +7457,17 @@ Required scope | `CMS:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.collections.items.get_item( + +client.collections.items.delete_item_live( collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754", + cms_locale_id="cmsLocaleId", ) ``` @@ -7303,7 +7520,7 @@ client.collections.items.get_item(
-
client.collections.items.delete_item(...) +
client.collections.items.update_item_live(...) -> CollectionItem
@@ -7315,7 +7532,7 @@ client.collections.items.get_item(
-Delete an Item from a Collection. This endpoint does not currently support bulk deletion. +Update a selected live Item in a Collection. The updates for this Item will be published to the live site. Required scope | `CMS:write`
@@ -7332,14 +7549,24 @@ Required scope | `CMS:write`
```python -from webflow import Webflow +from webflow import Webflow, CollectionItemPatchSingleFieldData +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.collections.items.delete_item( + +client.collections.items.update_item_live( collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754", + skip_invalid_files=True, + is_archived=False, + is_draft=False, + field_data=CollectionItemPatchSingleFieldData( + name="The Hitchhiker\'s Guide to the Galaxy", + slug="hitchhikers-guide-to-the-galaxy", + ), ) ``` @@ -7372,7 +7599,15 @@ client.collections.items.delete_item(
-**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string. +**request:** `CollectionItemPatchSingle` + +
+
+ +
+
+ +**skip_invalid_files:** `typing.Optional[bool]` — When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid.
@@ -7392,7 +7627,7 @@ client.collections.items.delete_item(
-
client.collections.items.update_item(...) +
client.collections.items.publish_item(...) -> ItemsPublishItemResponse
@@ -7404,9 +7639,9 @@ client.collections.items.delete_item(
-Update a selected Item in a Collection. +Publish an item or multiple items. -Required scope | `CMS:write` +Required scope | `cms:write`
@@ -7421,19 +7656,23 @@ Required scope | `CMS:write`
```python -from webflow import CollectionItemPatchSingleFieldData, Webflow +from webflow import Webflow +from webflow.environment import WebflowEnvironment +from webflow.collections.items import ItemIDs client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.collections.items.update_item( + +client.collections.items.publish_item( collection_id="580e63fc8c9a982ac9b8b745", - item_id="580e64008c9a982ac9b8b754", - is_archived=False, - is_draft=False, - field_data=CollectionItemPatchSingleFieldData( - name="Pan Galactic Gargle Blaster Recipe", - slug="pan-galactic-gargle-blaster", + request=ItemIDs( + item_ids=[ + "643fd856d66b6528195ee2ca", + "643fd856d66b6528195ee2cb", + "643fd856d66b6528195ee2cc" + ], ), ) @@ -7459,7 +7698,7 @@ client.collections.items.update_item(
-**item_id:** `str` — Unique identifier for an Item +**request:** `ItemsPublishItemRequest`
@@ -7467,63 +7706,75 @@ client.collections.items.update_item(
-**id:** `typing.Optional[str]` — Unique identifier for the Item +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
-
-**cms_locale_id:** `typing.Optional[str]` — Identifier for the locale of the CMS item -
+
+## Pages Scripts +
client.pages.scripts.get_custom_code(...) -> ScriptApplyList
-**last_published:** `typing.Optional[str]` — The date the item was last published - -
-
+#### 📝 Description
-**last_updated:** `typing.Optional[str]` — The date the item was last updated - -
-
-
-**created_on:** `typing.Optional[str]` — The date the item was created - +Get all scripts applied to a page. + +Required scope | `custom_code:read`
+ + + +#### 🔌 Usage
-**is_archived:** `typing.Optional[bool]` — Boolean determining if the Item is set to archived - -
-
-
-**is_draft:** `typing.Optional[bool]` — Boolean determining if the Item is set to draft - +```python +from webflow import Webflow +from webflow.environment import WebflowEnvironment + +client = Webflow( + access_token="", + environment=WebflowEnvironment.DATA_API, +) + +client.pages.scripts.get_custom_code( + page_id="63c720f9347c2139b248e552", +) + +```
+ + + +#### ⚙️ Parameters
-**field_data:** `typing.Optional[CollectionItemPatchSingleFieldData]` +
+
+ +**page_id:** `str` — Unique identifier for a Page
@@ -7543,7 +7794,7 @@ client.collections.items.update_item(
-
client.collections.items.get_item_live(...) +
client.pages.scripts.upsert_custom_code(...) -> ScriptApplyList
@@ -7555,9 +7806,13 @@ client.collections.items.update_item(
-Get details of a selected Collection live Item. +Apply registered scripts to a page. If you have multiple scripts your App needs to apply or maintain on a page, ensure they are always included in the request body for this endpoint. To remove individual scripts, simply call this endpoint without the script in the request body. -Required scope | `CMS:read` + + To apply a script to a page, the script must first be registered to a Site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + + +Required scope | `custom_code:write`
@@ -7572,39 +7827,932 @@ Required scope | `CMS:read`
```python -from webflow import Webflow +from webflow import Webflow, ScriptApply +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", -) -client.collections.items.get_item_live( - collection_id="580e63fc8c9a982ac9b8b745", - item_id="580e64008c9a982ac9b8b754", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -``` -
-
- - - -#### ⚙️ Parameters - -
-
+client.pages.scripts.upsert_custom_code( + page_id="63c720f9347c2139b248e552", + scripts=[ + ScriptApply( + id="cms_slider", + location="header", + version="1.0.0", + attributes={ + "my-attribute": "some-value" + }, + ), + ScriptApply( + id="alert", + location="header", + version="0.0.1", + ) + ], +) + +``` +
+
+ + + +#### ⚙️ Parameters + +
+
+ +
+
+ +**page_id:** `str` — Unique identifier for a Page + +
+
+ +
+
+ +**request:** `ScriptApplyList` + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + + + +
+ +
client.pages.scripts.delete_custom_code(...) +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Remove all scripts from a page applied by the App. This endpoint will not remove scripts from the site's registered scripts. + +To remove individual scripts applied by the App, use the [Add/Update Custom Code](/data/reference/custom-code/custom-code-pages/upsert-custom-code) endpoint. + +Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app). + +Required scope | `custom_code:write` +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from webflow import Webflow +from webflow.environment import WebflowEnvironment + +client = Webflow( + access_token="", + environment=WebflowEnvironment.DATA_API, +) + +client.pages.scripts.delete_custom_code( + page_id="63c720f9347c2139b248e552", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**page_id:** `str` — Unique identifier for a Page + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Sites Redirects +
client.sites.redirects.list(...) -> Redirects +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Fetch a list of all 301 redirect rules configured for a specific site. + +Use this endpoint to review, audit, or manage the redirection rules that control how traffic is rerouted on your site. + +This endpoint requires an Enterprise workspace. + +Required scope: `sites:read` +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from webflow import Webflow +from webflow.environment import WebflowEnvironment + +client = Webflow( + access_token="", + environment=WebflowEnvironment.DATA_API, +) + +client.sites.redirects.list( + site_id="580e63e98c9a982ac9b8b741", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**site_id:** `str` — Unique identifier for a Site + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.sites.redirects.create(...) -> Redirect +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Add a new 301 redirection rule to a site. + +This endpoint allows you to define a source path (`fromUrl`) and its corresponding destination path (`toUrl`), which will dictate how traffic is rerouted on your site. This is useful for managing site changes, restructuring URLs, or handling outdated links. + +This endpoint requires an Enterprise workspace. + +Required scope: `sites:write` +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from webflow import Webflow +from webflow.environment import WebflowEnvironment + +client = Webflow( + access_token="", + environment=WebflowEnvironment.DATA_API, +) + +client.sites.redirects.create( + site_id="580e63e98c9a982ac9b8b741", + id="42e1a2b7aa1a13f768a0042a", + from_url="/mostly-harmless", + to_url="/earth", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**site_id:** `str` — Unique identifier for a Site + +
+
+ +
+
+ +**request:** `Redirect` + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.sites.redirects.delete(...) -> Redirects +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Remove a 301 redirection rule from a site. + +This is useful for cleaning up outdated or unnecessary redirects, ensuring that your site's routing behavior remains efficient and up-to-date. + +This endpoint requires an Enterprise workspace. + +Required scope: `sites:write` +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from webflow import Webflow +from webflow.environment import WebflowEnvironment + +client = Webflow( + access_token="", + environment=WebflowEnvironment.DATA_API, +) + +client.sites.redirects.delete( + site_id="580e63e98c9a982ac9b8b741", + redirect_id="66c4cb9a20cac35ed19500e6", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**site_id:** `str` — Unique identifier for a Site + +
+
+ +
+
+ +**redirect_id:** `str` — Unique identifier site redirect + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.sites.redirects.update(...) -> Redirect +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Update a 301 redirection rule from a site. + +This endpoint requires an Enterprise workspace. + +Required scope: `sites:write` +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from webflow import Webflow +from webflow.environment import WebflowEnvironment + +client = Webflow( + access_token="", + environment=WebflowEnvironment.DATA_API, +) + +client.sites.redirects.update( + site_id="580e63e98c9a982ac9b8b741", + redirect_id="66c4cb9a20cac35ed19500e6", + id="42e1a2b7aa1a13f768a0042a", + from_url="/mostly-harmless", + to_url="/earth", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**site_id:** `str` — Unique identifier for a Site + +
+
+ +
+
+ +**redirect_id:** `str` — Unique identifier site redirect + +
+
+ +
+
+ +**request:** `Redirect` + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Sites Plans +
client.sites.plans.get_site_plan(...) -> SitePlan +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Get site plan details for the specified Site. + +This endpoint requires an Enterprise workspace. + +Required scope | `sites:read` +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from webflow import Webflow +from webflow.environment import WebflowEnvironment + +client = Webflow( + access_token="", + environment=WebflowEnvironment.DATA_API, +) + +client.sites.plans.get_site_plan( + site_id="580e63e98c9a982ac9b8b741", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**site_id:** `str` — Unique identifier for a Site + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +## Sites RobotsTxt +
client.sites.robots_txt.get(...) -> Robots +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Retrieve the robots.txt configuration for various user agents. + +This endpoint requires an Enterprise workspace. + +Required scope: `site_config:read` +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from webflow import Webflow +from webflow.environment import WebflowEnvironment + +client = Webflow( + access_token="", + environment=WebflowEnvironment.DATA_API, +) + +client.sites.robots_txt.get( + site_id="580e63e98c9a982ac9b8b741", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**site_id:** `str` — Unique identifier for a Site + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.sites.robots_txt.put(...) -> Robots +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Replace the `robots.txt` configuration for various user agents. + +This endpoint requires an Enterprise workspace. + +Required scope | `site_config:write` +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from webflow import Webflow, RobotsRulesItem +from webflow.environment import WebflowEnvironment + +client = Webflow( + access_token="", + environment=WebflowEnvironment.DATA_API, +) + +client.sites.robots_txt.put( + site_id="580e63e98c9a982ac9b8b741", + rules=[ + RobotsRulesItem( + user_agent="googlebot", + allows=[ + "/public" + ], + disallows=[ + "/vogon-poetry", + "/total-perspective-vortex" + ], + ) + ], + sitemap="https://heartofgold.ship/sitemap.xml", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**site_id:** `str` — Unique identifier for a Site + +
+
+ +
+
+ +**request:** `Robots` + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.sites.robots_txt.delete(...) -> Robots +
+
+ +#### 📝 Description + +
+
+ +
+
+ +Remove specific rules for a user-agent in your `robots.txt` file. To delete all rules for a user-agent, provide an empty rule set. This will remove the user-agent's entry entirely, leaving it subject to your site's default crawling behavior. + +**Note:** Deleting a user-agent with no rules will make the user-agent's access unrestricted unless other directives apply. + +This endpoint requires an Enterprise workspace. + +Required scope: `site_config:write` +
+
+
+
+ +#### 🔌 Usage + +
+
+ +
+
+ +```python +from webflow import Webflow, RobotsRulesItem +from webflow.environment import WebflowEnvironment + +client = Webflow( + access_token="", + environment=WebflowEnvironment.DATA_API, +) + +client.sites.robots_txt.delete( + site_id="580e63e98c9a982ac9b8b741", + rules=[ + RobotsRulesItem( + user_agent="*", + allows=[ + "/public" + ], + disallows=[ + "/bubbles" + ], + ) + ], +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**site_id:** `str` — Unique identifier for a Site + +
+
+ +
+
+ +**request:** `Robots` + +
+
+ +
+
+ +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. + +
+
+
+
+ + +
+
+
+ +
client.sites.robots_txt.patch(...) -> Robots +
+
+ +#### 📝 Description + +
+
-**collection_id:** `str` — Unique identifier for a Collection - +Update the `robots.txt` configuration for various user agents. + +This endpoint requires an Enterprise workspace. + +Required scope | `site_config:write`
+
+
+ +#### 🔌 Usage
-**item_id:** `str` — Unique identifier for an Item +
+
+ +```python +from webflow import Webflow, RobotsRulesItem +from webflow.environment import WebflowEnvironment + +client = Webflow( + access_token="", + environment=WebflowEnvironment.DATA_API, +) + +client.sites.robots_txt.patch( + site_id="580e63e98c9a982ac9b8b741", + rules=[ + RobotsRulesItem( + user_agent="googlebot", + allows=[ + "/public" + ], + disallows=[ + "/vogon-poetry", + "/total-perspective-vortex" + ], + ) + ], + sitemap="https://heartofgold.ship/sitemap.xml", +) + +``` +
+
+
+
+ +#### ⚙️ Parameters + +
+
+ +
+
+ +**site_id:** `str` — Unique identifier for a Site
@@ -7612,7 +8760,7 @@ client.collections.items.get_item_live(
-**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string. +**request:** `Robots`
@@ -7632,7 +8780,8 @@ client.collections.items.get_item_live(
-
client.collections.items.delete_item_live(...) +## Sites WellKnown +
client.sites.well_known.put(...)
@@ -7644,11 +8793,20 @@ client.collections.items.get_item_live(
-Remove a live item from the site. Removing a published item will unpublish the item from the live site and set it to draft. +Upload a supported well-known file to a site. -This endpoint does not currently support bulk deletion. +The current restrictions on well-known files are as follows: + - Each file must be smaller than 100kb + - Less than 30 total files + - Have one of the following file extensions (or no extension): `.txt`, `.json`, `.noext` -Required scope | `CMS:write` + + `.noext` is a special file extension that removes other extensions. For example, `apple-app-site-association.noext.txt` will be uploaded as `apple-app-site-association`. Use this extension for tools that have trouble uploading extensionless files. + + +This endpoint requires an Enterprise workspace. + +Required scope: `site_config:write`
@@ -7664,13 +8822,18 @@ Required scope | `CMS:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.collections.items.delete_item_live( - collection_id="580e63fc8c9a982ac9b8b745", - item_id="580e64008c9a982ac9b8b754", + +client.sites.well_known.put( + site_id="580e63e98c9a982ac9b8b741", + file_name="apple-app-site-association.txt", + file_data="{\n \"applinks\": {\n \"apps\": [],\n \"details\": [\n {\n \"appID\": \"ABCDE12345.com.example.app\",\n \"paths\": [ \"/*\", \"/some/path/*\" ]\n }\n ]\n }\n}\n", + content_type="application/json", ) ``` @@ -7687,7 +8850,7 @@ client.collections.items.delete_item_live(
-**collection_id:** `str` — Unique identifier for a Collection +**site_id:** `str` — Unique identifier for a Site
@@ -7695,7 +8858,7 @@ client.collections.items.delete_item_live(
-**item_id:** `str` — Unique identifier for an Item +**file_name:** `str` — The name of the file
@@ -7703,7 +8866,15 @@ client.collections.items.delete_item_live(
-**cms_locale_id:** `typing.Optional[str]` — Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string. +**file_data:** `str` — The contents of the file + +
+
+ +
+
+ +**content_type:** `typing.Optional[WellKnownFileContentType]` — The content type of the file. Defaults to application/json
@@ -7723,7 +8894,7 @@ client.collections.items.delete_item_live(
-
client.collections.items.update_item_live(...) +
client.sites.well_known.delete(...)
@@ -7735,9 +8906,11 @@ client.collections.items.delete_item_live(
-Update a selected live Item in a Collection. The updates for this Item will be published to the live site. +Delete existing well-known files from a site. -Required scope | `CMS:write` +This endpoint requires an Enterprise workspace. + +Required scope: `site_config:write`
@@ -7752,20 +8925,16 @@ Required scope | `CMS:write`
```python -from webflow import CollectionItemPatchSingleFieldData, Webflow +from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.collections.items.update_item_live( - collection_id="580e63fc8c9a982ac9b8b745", - item_id="580e64008c9a982ac9b8b754", - is_archived=False, - is_draft=False, - field_data=CollectionItemPatchSingleFieldData( - name="Pan Galactic Gargle Blaster Recipe", - slug="pan-galactic-gargle-blaster", - ), + +client.sites.well_known.delete( + site_id="580e63e98c9a982ac9b8b741", ) ``` @@ -7782,7 +8951,7 @@ client.collections.items.update_item_live(
-**collection_id:** `str` — Unique identifier for a Collection +**site_id:** `str` — Unique identifier for a Site
@@ -7790,7 +8959,7 @@ client.collections.items.update_item_live(
-**item_id:** `str` — Unique identifier for an Item +**file_names:** `typing.Optional[typing.List[str]]` — A list of file names to delete
@@ -7798,47 +8967,79 @@ client.collections.items.update_item_live(
-**id:** `typing.Optional[str]` — Unique identifier for the Item +**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
+
+
-
-
-**cms_locale_id:** `typing.Optional[str]` — Identifier for the locale of the CMS item -
+
+## Sites ActivityLogs +
client.sites.activity_logs.list(...) -> SiteActivityLogResponse
-**last_published:** `typing.Optional[str]` — The date the item was last published - -
-
+#### 📝 Description
-**last_updated:** `typing.Optional[str]` — The date the item was last updated - +
+
+ +Retrieve Activity Logs for a specific Site. + +This endpoint requires an Enterprise workspace. + +Required scope: `site_activity:read`
+
+
+ +#### 🔌 Usage
-**created_on:** `typing.Optional[str]` — The date the item was created - +
+
+ +```python +from webflow import Webflow +from webflow.environment import WebflowEnvironment + +client = Webflow( + access_token="", + environment=WebflowEnvironment.DATA_API, +) + +client.sites.activity_logs.list( + site_id="580e63e98c9a982ac9b8b741", + limit=1, + offset=1, +) + +``` +
+
+#### ⚙️ Parameters + +
+
+
-**is_archived:** `typing.Optional[bool]` — Boolean determining if the Item is set to archived +**site_id:** `str` — Unique identifier for a Site
@@ -7846,7 +9047,7 @@ client.collections.items.update_item_live(
-**is_draft:** `typing.Optional[bool]` — Boolean determining if the Item is set to draft +**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
@@ -7854,7 +9055,7 @@ client.collections.items.update_item_live(
-**field_data:** `typing.Optional[CollectionItemPatchSingleFieldData]` +**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
@@ -7874,7 +9075,8 @@ client.collections.items.update_item_live(
-
client.collections.items.publish_item(...) +## Sites Comments +
client.sites.comments.list_comment_threads(...) -> CommentThreadList
@@ -7886,9 +9088,13 @@ client.collections.items.update_item_live(
-Publish an item or multiple items. +List all comment threads for a site. -Required scope | `cms:write` + + There may be a delay of up to 5 minutes before new comments appear in the system. + + +Required scope | `comments:read`
@@ -7904,13 +9110,20 @@ Required scope | `cms:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.collections.items.publish_item( - collection_id="580e63fc8c9a982ac9b8b745", - item_ids=["itemIds"], + +client.sites.comments.list_comment_threads( + site_id="580e63e98c9a982ac9b8b741", + locale_id="65427cf400e02b306eaa04a0", + offset=1, + limit=1, + sort_by="createdOn", + sort_order="asc", ) ``` @@ -7927,7 +9140,43 @@ client.collections.items.publish_item(
-**collection_id:** `str` — Unique identifier for a Collection +**site_id:** `str` — Unique identifier for a Site + +
+
+ +
+
+ +**locale_id:** `typing.Optional[str]` + +Unique identifier for a specific Locale. + +[Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + +
+
+ +
+
+ +**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100) + +
+
+ +
+
+ +**sort_by:** `typing.Optional[CommentsListCommentThreadsRequestSortBy]` — Sort results by the provided value. Only allowed when sortOrder is provided.
@@ -7935,7 +9184,7 @@ client.collections.items.publish_item(
-**item_ids:** `typing.Sequence[str]` +**sort_order:** `typing.Optional[CommentsListCommentThreadsRequestSortOrder]` — Sorts the results by asc or desc
@@ -7955,8 +9204,7 @@ client.collections.items.publish_item(
-## Pages Scripts -
client.pages.scripts.get_custom_code(...) +
client.sites.comments.get_comment_thread(...) -> CommentThread
@@ -7968,15 +9216,13 @@ client.collections.items.publish_item(
-Get all registered scripts that have been applied to a specific Page. - -In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered -to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate -`custom_code` endpoints. +Get details of a specific comment thread. -Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + + There may be a delay of up to 5 minutes before new comments appear in the system. + -Required scope | `custom_code:read` +Required scope | `comments:read`
@@ -7992,12 +9238,21 @@ Required scope | `custom_code:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.pages.scripts.get_custom_code( - page_id="63c720f9347c2139b248e552", + +client.sites.comments.get_comment_thread( + site_id="580e63e98c9a982ac9b8b741", + comment_thread_id="580e63e98c9a982ac9b8b741", + locale_id="65427cf400e02b306eaa04a0", + offset=1, + limit=1, + sort_by="createdOn", + sort_order="asc", ) ``` @@ -8014,7 +9269,59 @@ client.pages.scripts.get_custom_code(
-**page_id:** `str` — Unique identifier for a Page +**site_id:** `str` — Unique identifier for a Site + +
+
+ +
+
+ +**comment_thread_id:** `str` — Unique identifier for a Comment Thread + +
+
+ +
+
+ +**locale_id:** `typing.Optional[str]` + +Unique identifier for a specific Locale. + +[Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + +
+
+ +
+
+ +**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100) + +
+
+ +
+
+ +**sort_by:** `typing.Optional[CommentsGetCommentThreadRequestSortBy]` — Sort results by the provided value. Only allowed when sortOrder is provided. + +
+
+ +
+
+ +**sort_order:** `typing.Optional[CommentsGetCommentThreadRequestSortOrder]` — Sorts the results by asc or desc
@@ -8034,7 +9341,7 @@ client.pages.scripts.get_custom_code(
-
client.pages.scripts.upsert_custom_code(...) +
client.sites.comments.list_comment_replies(...) -> CommentReplyList
@@ -8046,17 +9353,13 @@ client.pages.scripts.get_custom_code(
-Add a registered script to a Page. - -In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered -to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate -`custom_code` endpoints. +List all replies to a specific comment thread. -A site can have a maximum of 800 registered scripts. - -Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + + There may be a delay of up to 5 minutes before new comments appear in the system. + -Required scope | `custom_code:write` +Required scope | `comments:read`
@@ -8071,26 +9374,22 @@ Required scope | `custom_code:write`
```python -from webflow import ScriptApply, Webflow +from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.pages.scripts.upsert_custom_code( - page_id="63c720f9347c2139b248e552", - scripts=[ - ScriptApply( - id="cms_slider", - location="header", - version="1.0.0", - attributes={"my-attribute": "some-value"}, - ), - ScriptApply( - id="alert", - location="header", - version="0.0.1", - ), - ], + +client.sites.comments.list_comment_replies( + site_id="580e63e98c9a982ac9b8b741", + comment_thread_id="580e63e98c9a982ac9b8b741", + locale_id="65427cf400e02b306eaa04a0", + offset=1, + limit=1, + sort_by="createdOn", + sort_order="asc", ) ``` @@ -8107,7 +9406,35 @@ client.pages.scripts.upsert_custom_code(
-**page_id:** `str` — Unique identifier for a Page +**site_id:** `str` — Unique identifier for a Site + +
+
+ +
+
+ +**comment_thread_id:** `str` — Unique identifier for a Comment Thread + +
+
+ +
+
+ +**locale_id:** `typing.Optional[str]` + +Unique identifier for a specific Locale. + +[Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + +
+
+ +
+
+ +**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
@@ -8115,7 +9442,7 @@ client.pages.scripts.upsert_custom_code(
-**scripts:** `typing.Optional[typing.Sequence[ScriptApply]]` — A list of scripts applied to a Site or a Page +**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
@@ -8123,7 +9450,7 @@ client.pages.scripts.upsert_custom_code(
-**last_updated:** `typing.Optional[str]` — Date when the Site's scripts were last updated +**sort_by:** `typing.Optional[CommentsListCommentRepliesRequestSortBy]` — Sort results by the provided value. Only allowed when sortOrder is provided.
@@ -8131,7 +9458,7 @@ client.pages.scripts.upsert_custom_code(
-**created_on:** `typing.Optional[str]` — Date when the Site's scripts were created +**sort_order:** `typing.Optional[CommentsListCommentRepliesRequestSortOrder]` — Sorts the results by asc or desc
@@ -8151,7 +9478,8 @@ client.pages.scripts.upsert_custom_code(
-
client.pages.scripts.delete_custom_code(...) +## Sites Scripts +
client.sites.scripts.get_custom_code(...) -> ScriptApplyList
@@ -8163,15 +9491,13 @@ client.pages.scripts.upsert_custom_code(
-Delete the custom code block that an app has created for a page +Get all scripts applied to a site by the App. -In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered -to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate -`custom_code` endpoints. - -Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + -Required scope | `custom_code:write` +Required scope | `custom_code:read`
@@ -8187,12 +9513,15 @@ Required scope | `custom_code:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.pages.scripts.delete_custom_code( - page_id="63c720f9347c2139b248e552", + +client.sites.scripts.get_custom_code( + site_id="580e63e98c9a982ac9b8b741", ) ``` @@ -8209,7 +9538,7 @@ client.pages.scripts.delete_custom_code(
-**page_id:** `str` — Unique identifier for a Page +**site_id:** `str` — Unique identifier for a Site
@@ -8229,8 +9558,7 @@ client.pages.scripts.delete_custom_code(
-## Sites Redirects -
client.sites.redirects.list(...) +
client.sites.scripts.upsert_custom_code(...) -> ScriptApplyList
@@ -8242,12 +9570,13 @@ client.pages.scripts.delete_custom_code(
-Fetch a list of all URL redirect rules configured for a specific site. - -Use this endpoint to review, audit, or manage the redirection rules that control how traffic is rerouted on your site. +Apply registered scripts to a site. If you have multiple scripts your App needs to apply or maintain on a site, ensure they are always included in the request body for this endpoint. To remove individual scripts, simply call this endpoint without the script in the request body. + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + -Required scope: `sites:read` +Required scope | `custom_code:write`
@@ -8262,13 +9591,31 @@ Required scope: `sites:read`
```python -from webflow import Webflow +from webflow import Webflow, ScriptApply +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.sites.redirects.list( + +client.sites.scripts.upsert_custom_code( site_id="580e63e98c9a982ac9b8b741", + scripts=[ + ScriptApply( + id="cms_slider", + location="header", + version="1.0.0", + attributes={ + "my-attribute": "some-value" + }, + ), + ScriptApply( + id="alert", + location="header", + version="0.0.1", + ) + ], ) ``` @@ -8293,6 +9640,14 @@ client.sites.redirects.list(
+**request:** `ScriptApplyList` + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -8305,7 +9660,7 @@ client.sites.redirects.list(
-
client.sites.redirects.create(...) +
client.sites.scripts.delete_custom_code(...)
@@ -8317,11 +9672,13 @@ client.sites.redirects.list(
-Add a new URL redirection rule to a site. +Remove all scripts from a site applied by the App. This endpoint will not remove scripts from the site's registered scripts. -This endpoint allows you to define a source path (`fromUrl`) and its corresponding destination path (`toUrl`), which will dictate how traffic is rerouted on your site. This is useful for managing site changes, restructuring URLs, or handling outdated links. +To remove individual scripts applied by the App, use the [Add/Update Custom Code](/data/reference/custom-code/custom-code-sites/upsert-custom-code) endpoint. -Required scope: `sites:write` +Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app). + +Required scope | `custom_code:write`
@@ -8337,15 +9694,15 @@ Required scope: `sites:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.sites.redirects.create( + +client.sites.scripts.delete_custom_code( site_id="580e63e98c9a982ac9b8b741", - id="42e1a2b7aa1a13f768a0042a", - from_url="/mostly-harmless", - to_url="/earth", ) ``` @@ -8370,30 +9727,6 @@ client.sites.redirects.create(
-**id:** `typing.Optional[str]` — The ID of the specific redirect rule - -
-
- -
-
- -**from_url:** `typing.Optional[str]` — The source URL path that will be redirected. - -
-
- -
-
- -**to_url:** `typing.Optional[str]` — The target URL path where the user or client will be redirected. - -
-
- -
-
- **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -8406,7 +9739,7 @@ client.sites.redirects.create(
-
client.sites.redirects.delete(...) +
client.sites.scripts.list_custom_code_blocks(...) -> ListCustomCodeBlocks
@@ -8418,9 +9751,15 @@ client.sites.redirects.create(
-Remove a URL redirection rule from a site. -This is useful for cleaning up outdated or unnecessary redirects, ensuring that your site's routing behavior remains efficient and up-to-date. -Required scope: `sites:write` +Get a list of scripts that have been applied to a site and/or individual pages. + + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. + + See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + + +Required scope | `custom_code:read`
@@ -8436,13 +9775,17 @@ Required scope: `sites:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.sites.redirects.delete( + +client.sites.scripts.list_custom_code_blocks( site_id="580e63e98c9a982ac9b8b741", - redirect_id="66c4cb9a20cac35ed19500e6", + offset=1, + limit=1, ) ``` @@ -8467,7 +9810,15 @@ client.sites.redirects.delete(
-**redirect_id:** `str` — Unique identifier site rediect +**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
@@ -8487,7 +9838,8 @@ client.sites.redirects.delete(
-
client.sites.redirects.update(...) +## Sites Forms +
client.sites.forms.list_submissions_by_site(...) -> FormSubmissionList
@@ -8499,8 +9851,17 @@ client.sites.redirects.delete(
-Update a URL redirection rule from a site. -Required scope: `sites:write` +List all form submissions for a given site with the ability to filter submissions by a centralized `elementId`. + +Add `elementId` when you want to filter form submissions to a specific form in a site. You can get the `elementId` from the [List forms endpoint](/data/reference/forms/forms/list) (displayed as `formElementId` in the response). + + +When a form is used in a Webflow component definition, each instance of the component will yield a unique form. Adding the `elementId` in this request ensures this API response includes all submissions from that core form, wherever that form is used in instantiated components. + + +Use the [List Form Submissions endpoint](/data/reference/forms/form-submissions/list-submissions) to list form submissions for a given form ID. + +Required scope | `forms:read`
@@ -8516,16 +9877,18 @@ Required scope: `sites:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.sites.redirects.update( + +client.sites.forms.list_submissions_by_site( site_id="580e63e98c9a982ac9b8b741", - redirect_id="66c4cb9a20cac35ed19500e6", - id="42e1a2b7aa1a13f768a0042a", - from_url="/mostly-harmless", - to_url="/earth", + element_id="18259716-3e5a-646a-5f41-5dc4b9405aa0", + offset=1, + limit=1, ) ``` @@ -8550,15 +9913,7 @@ client.sites.redirects.update(
-**redirect_id:** `str` — Unique identifier site rediect - -
-
- -
-
- -**id:** `typing.Optional[str]` — The ID of the specific redirect rule +**element_id:** `typing.Optional[str]` — Identifier for an element
@@ -8566,7 +9921,7 @@ client.sites.redirects.update(
-**from_url:** `typing.Optional[str]` — The source URL path that will be redirected. +**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records
@@ -8574,7 +9929,7 @@ client.sites.redirects.update(
-**to_url:** `typing.Optional[str]` — The target URL path where the user or client will be redirected. +**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
@@ -8594,8 +9949,7 @@ client.sites.redirects.update(
-## Sites Plans -
client.sites.plans.get_site_plan(...) +
client.sites.forms.list_submissions(...) -> FormSubmissionList
@@ -8607,9 +9961,11 @@ client.sites.redirects.update(
-Get site plan details for the specified Site. +List form submissions for a given form ID within a specific site. -Required scope | `sites:read` +Use the [List Form Submissions by Site endpoint](/data/reference/forms/form-submissions/list-submissions-by-site) to list form submissions for a given site with the ability to filter by a `formElementId`. + +Required scope | `forms:read`
@@ -8625,12 +9981,18 @@ Required scope | `sites:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.sites.plans.get_site_plan( + +client.sites.forms.list_submissions( site_id="580e63e98c9a982ac9b8b741", + form_id="580e63e98c9a982ac9b8b741", + offset=1, + limit=1, ) ``` @@ -8655,6 +10017,30 @@ client.sites.plans.get_site_plan(
+**form_id:** `str` — Unique identifier for a Form + +
+
+ +
+
+ +**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records + +
+
+ +
+
+ +**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100) + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -8667,8 +10053,7 @@ client.sites.plans.get_site_plan(
-## Sites ActivityLogs -
client.sites.activity_logs.list(...) +
client.sites.forms.get_submission(...) -> FormSubmission
@@ -8680,7 +10065,9 @@ client.sites.plans.get_site_plan(
-Retrieve Activity Logs for a specific Site. Requires Site to be on an Enterprise plan.

Required scope | `site_activity:read` +Get information about a form submission within a specific site. + +Required scope | `forms:read`
@@ -8696,12 +10083,16 @@ Retrieve Activity Logs for a specific Site. Requires Site to be on an Enterprise ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.sites.activity_logs.list( + +client.sites.forms.get_submission( site_id="580e63e98c9a982ac9b8b741", + form_submission_id="580e63e98c9a982ac9b8b741", ) ``` @@ -8726,15 +10117,7 @@ client.sites.activity_logs.list(
-**limit:** `typing.Optional[float]` — Maximum number of records to be returned (max limit: 100) - -
-
- -
-
- -**offset:** `typing.Optional[float]` — Offset used for pagination if the results have more than limit records +**form_submission_id:** `str` — Unique identifier for a Form Submission
@@ -8754,8 +10137,7 @@ client.sites.activity_logs.list(
-## Sites Scripts -
client.sites.scripts.get_custom_code(...) +
client.sites.forms.delete_submission(...)
@@ -8767,11 +10149,9 @@ client.sites.activity_logs.list(
-Get all registered scripts that have been applied to a specific Site. +Delete a form submission within a specific site. -Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). - -Required scope | `custom_code:read` +Required scope | `forms:write`
@@ -8787,12 +10167,16 @@ Required scope | `custom_code:read` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.sites.scripts.get_custom_code( + +client.sites.forms.delete_submission( site_id="580e63e98c9a982ac9b8b741", + form_submission_id="580e63e98c9a982ac9b8b741", ) ``` @@ -8817,6 +10201,14 @@ client.sites.scripts.get_custom_code(
+**form_submission_id:** `str` — Unique identifier for a Form Submission + +
+
+ +
+
+ **request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration.
@@ -8829,7 +10221,7 @@ client.sites.scripts.get_custom_code(
-
client.sites.scripts.upsert_custom_code(...) +
client.sites.forms.update_submission(...) -> FormSubmission
@@ -8841,15 +10233,9 @@ client.sites.scripts.get_custom_code(
-Add a registered script to a Site. +Update hidden fields on a form submission within a specific site. -In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered -to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate -`custom_code` endpoints. - -Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). - -Required scope | `custom_code:write` +Required scope | `forms:write`
@@ -8864,26 +10250,17 @@ Required scope | `custom_code:write`
```python -from webflow import ScriptApply, Webflow +from webflow import Webflow +from webflow.environment import WebflowEnvironment client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.sites.scripts.upsert_custom_code( + +client.sites.forms.update_submission( site_id="580e63e98c9a982ac9b8b741", - scripts=[ - ScriptApply( - id="cms_slider", - location="header", - version="1.0.0", - attributes={"my-attribute": "some-value"}, - ), - ScriptApply( - id="alert", - location="header", - version="0.0.1", - ), - ], + form_submission_id="580e63e98c9a982ac9b8b741", ) ``` @@ -8908,15 +10285,7 @@ client.sites.scripts.upsert_custom_code(
-**scripts:** `typing.Optional[typing.Sequence[ScriptApply]]` — A list of scripts applied to a Site or a Page - -
-
- -
-
- -**last_updated:** `typing.Optional[str]` — Date when the Site's scripts were last updated +**form_submission_id:** `str` — Unique identifier for a Form Submission
@@ -8924,7 +10293,7 @@ client.sites.scripts.upsert_custom_code(
-**created_on:** `typing.Optional[str]` — Date when the Site's scripts were created +**form_submission_data:** `typing.Optional[typing.Dict[str, typing.Any]]` — An existing **hidden field** defined on the form schema, and the corresponding value to set
@@ -8944,7 +10313,8 @@ client.sites.scripts.upsert_custom_code(
-
client.sites.scripts.delete_custom_code(...) +## Workspaces AuditLogs +
client.workspaces.audit_logs.get_workspace_audit_logs(...) -> WorkspaceAuditLogResponse
@@ -8956,11 +10326,11 @@ client.sites.scripts.upsert_custom_code(
-Delete the custom code block that an app created for a Site +Get audit logs for a workspace. -Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). +This endpoint requires an Enterprise workspace and a workspace token with the `workspace_activity:read` scope. Create a workspace token from your workspace dashboard integrations page to use this endpoint. -Required scope | `custom_code:write` +Required scope | `workspace_activity:read`
@@ -8976,12 +10346,22 @@ Required scope | `custom_code:write` ```python from webflow import Webflow +from webflow.environment import WebflowEnvironment +import datetime client = Webflow( - access_token="YOUR_ACCESS_TOKEN", + access_token="", + environment=WebflowEnvironment.DATA_API, ) -client.sites.scripts.delete_custom_code( - site_id="580e63e98c9a982ac9b8b741", + +client.workspaces.audit_logs.get_workspace_audit_logs( + workspace_id_or_slug="hitchhikers-workspace", + limit=1, + offset=1, + sort_order="asc", + event_type="user_access", + from_=datetime.datetime.fromisoformat("2025-06-22T16:00:31+00:00"), + to=datetime.datetime.fromisoformat("2025-07-22T16:00:31+00:00"), ) ``` @@ -8998,7 +10378,7 @@ client.sites.scripts.delete_custom_code(
-**site_id:** `str` — Unique identifier for a Site +**workspace_id_or_slug:** `str` — Unique identifier or slug for a Workspace
@@ -9006,73 +10386,31 @@ client.sites.scripts.delete_custom_code(
-**request_options:** `typing.Optional[RequestOptions]` — Request-specific configuration. +**limit:** `typing.Optional[int]` — Maximum number of records to be returned (max limit: 100)
- -
- - - - -
- -
client.sites.scripts.list_custom_code_blocks(...) -
-
- -#### 📝 Description - -
-
-Get all instances of Custom Code applied to a Site or Pages. - -Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). - -Required scope | `custom_code:read` -
-
+**offset:** `typing.Optional[int]` — Offset used for pagination if the results have more than limit records +
-#### 🔌 Usage - -
-
-
-```python -from webflow import Webflow - -client = Webflow( - access_token="YOUR_ACCESS_TOKEN", -) -client.sites.scripts.list_custom_code_blocks( - site_id="580e63e98c9a982ac9b8b741", -) - -``` -
-
+**sort_order:** `typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestSortOrder]` — Sorts the results by asc or desc +
-#### ⚙️ Parameters -
-
-
- -**site_id:** `str` — Unique identifier for a Site +**event_type:** `typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestEventType]` — The event type to filter by
@@ -9080,7 +10418,7 @@ client.sites.scripts.list_custom_code_blocks(
-**offset:** `typing.Optional[float]` — Offset used for pagination if the results have more than limit records +**from:** `typing.Optional[datetime.datetime]` — The start date to filter by
@@ -9088,7 +10426,7 @@ client.sites.scripts.list_custom_code_blocks(
-**limit:** `typing.Optional[float]` — Maximum number of records to be returned (max limit: 100) +**to:** `typing.Optional[datetime.datetime]` — The end date to filter by
diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..e80f640 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +httpx>=0.21.2 +pydantic>= 1.9.2 +pydantic-core>=2.18.2 +typing_extensions>= 4.0.0 diff --git a/src/webflow/__init__.py b/src/webflow/__init__.py index 0d82d59..48d0673 100644 --- a/src/webflow/__init__.py +++ b/src/webflow/__init__.py @@ -1,216 +1,658 @@ # 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, - BadRequestErrorBody, - BulkCollectionItem, - BulkCollectionItemFieldData, - Collection, - CollectionItem, - CollectionItemFieldData, - CollectionItemList, - CollectionItemListNoPagination, - CollectionItemListPagination, - CollectionItemPatchSingle, - CollectionItemPatchSingleFieldData, - CollectionItemPostSingle, - CollectionItemPostSingleFieldData, - CollectionItemWithIdInput, - CollectionItemWithIdInputFieldData, - CollectionList, - CollectionListArrayItem, - Component, - ComponentDom, - ComponentInstanceNodePropertyOverridesWrite, - ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem, - ComponentList, - ComponentNode, - ComponentProperties, - ComponentProperty, - ComponentPropertyType, - ConflictErrorBody, - CustomCodeBlock, - CustomCodeBlockType, - CustomCodeHostedResponse, - CustomCodeInlineResponse, - Dom, - Domain, - Domains, - DuplicateUserEmail, - EcommerceSettings, - Error, - ErrorCode, - Field, - FieldType, - ForbiddenErrorBody, - Form, - FormField, - FormFieldValue, - FormFieldValueType, - FormList, - FormResponseSettings, - FormSubmission, - FormSubmissionList, - ImageNode, - ImageNodeImage, - InvalidDomain, - InvalidScopes, - InventoryItem, - InventoryItemInventoryType, - ListCustomCodeBlocks, - Locale, - Locales, - NoDomains, - Node, - Node_ComponentInstance, - Node_Image, - Node_Text, - NotEnterprisePlanSite, - NotEnterprisePlanWorkspace, - Order, - OrderAddress, - OrderAddressJapanType, - OrderAddressType, - OrderCustomerInfo, - OrderDisputeLastStatus, - OrderDownloadFilesItem, - OrderList, - OrderMetadata, - OrderPrice, - OrderPurchasedItem, - OrderPurchasedItemVariantImage, - OrderPurchasedItemVariantImageFile, - OrderPurchasedItemVariantImageFileVariantsItem, - OrderStatus, - OrderTotals, - OrderTotalsExtrasItem, - OrderTotalsExtrasItemType, - Page, - PageList, - PageOpenGraph, - PageSeo, - Pagination, - PaypalDetails, - Product, - ProductAndSkUs, - ProductAndSkUsList, - ProductFieldData, - ProductFieldDataEcProductType, - ProductFieldDataTaxCategory, - PublishStatus, - Redirect, - Redirects, - RegisteredScriptList, - ScriptApply, - ScriptApplyList, - ScriptApplyLocation, - Scripts, - Site, - SiteActivityLogItem, - SiteActivityLogItemEvent, - SiteActivityLogItemResourceOperation, - SiteActivityLogItemUser, - SiteActivityLogResponse, - SiteDataCollectionType, - SitePlan, - SitePlanId, - SitePlanName, - Sites, - Sku, - SkuFieldData, - SkuFieldDataCompareAtPrice, - SkuFieldDataEcSkuBillingMethod, - SkuFieldDataEcSkuSubscriptionPlan, - SkuFieldDataEcSkuSubscriptionPlanInterval, - SkuFieldDataEcSkuSubscriptionPlanPlansItem, - SkuFieldDataEcSkuSubscriptionPlanPlansItemStatus, - SkuFieldDataPrice, - SkuPropertyList, - SkuPropertyListEnumItem, - SkuValueList, - StripeCard, - StripeCardBrand, - StripeCardExpires, - StripeDetails, - Text, - TextNode, - TextNodeText, - TextNodeWrite, - TriggerType, - User, - UserAccessGroupsItem, - UserAccessGroupsItemType, - UserData, - UserDataData, - UserLimitReached, - UserList, - UserStatus, - UsersNotEnabled, - Webhook, - WebhookFilter, - WebhookList, -) -from .errors import ( - BadRequestError, - ConflictError, - ForbiddenError, - InternalServerError, - NotFoundError, - TooManyRequestsError, - UnauthorizedError, -) -from .resources import ( - AccessGroupsListRequestSort, - ComponentDomWriteNodesItem, - ComponentPropertiesWritePropertiesItem, - ComponentsUpdateContentResponse, - ComponentsUpdatePropertiesResponse, - InventoryUpdateRequestInventoryType, - OrdersListRequestStatus, - OrdersRefundRequestReason, - PageDomWriteNodesItem, - ProductsCreateSkuResponse, - SitesPublishResponse, - UpdateStaticContentResponse, - UsersListRequestSort, - UsersUpdateRequestData, - access_groups, - assets, - collections, - components, - ecommerce, - forms, - inventory, - orders, - pages, - products, - scripts, - sites, - token, - users, - webhooks, -) -from .client import AsyncWebflow, Webflow -from .environment import WebflowEnvironment -from .version import __version__ +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .types import ( + Application, + Asset, + AssetFolder, + AssetFolderList, + AssetUpload, + AssetUploadUploadDetails, + AssetVariant, + Assets, + Authorization, + AuthorizationAuthorization, + AuthorizationAuthorizationAuthorizedTo, + AuthorizedUser, + BadRequestErrorBody, + BulkCollectionItem, + BulkCollectionItemFieldData, + Collection, + CollectionItem, + CollectionItemChanged, + CollectionItemCreated, + CollectionItemFieldData, + CollectionItemList, + CollectionItemListNoPagination, + CollectionItemListPagination, + CollectionItemPatchSingle, + CollectionItemPatchSingleFieldData, + CollectionItemPostSingle, + CollectionItemPostSingleFieldData, + CollectionItemPublished, + CollectionItemRemoved, + CollectionItemRemovedPayload, + CollectionItemRemovedPayloadFieldData, + CollectionItemUnpublished, + CollectionItemUnpublishedPayload, + CollectionItemUnpublishedPayloadFieldData, + CollectionItemWithIdInput, + CollectionItemWithIdInputFieldData, + CollectionList, + CollectionListArrayItem, + Comment, + CommentPayload, + CommentPayloadAuthor, + CommentPayloadMentionedUsersItem, + CommentReply, + CommentReplyAuthor, + CommentReplyList, + CommentReplyListPagination, + CommentReplyMentionedUsersItem, + CommentThread, + CommentThreadAuthor, + CommentThreadList, + CommentThreadListPagination, + CommentThreadMentionedUsersItem, + Component, + ComponentDom, + ComponentInstanceNodePropertyOverridesWrite, + ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem, + ComponentList, + ComponentNode, + ComponentProperties, + ComponentProperty, + ComponentPropertyType, + Conflict, + CustomCodeBlock, + CustomCodeBlockType, + CustomCodeHostedResponse, + CustomCodeInlineResponse, + CustomRole, + CustomRoleAuditLogItem, + CustomRoleAuditLogItemEventSubType, + Dom, + Domain, + Domains, + EcommerceSettings, + Error, + ErrorCode, + Field, + FieldCreate, + FieldType, + FieldValidations, + FieldValidationsAdditionalProperties, + FieldValidationsAdditionalPropertiesAdditionalProperties, + ForbiddenErrorBody, + Form, + FormField, + FormFieldValue, + FormFieldValueType, + FormList, + FormResponseSettings, + FormSubmission, + FormSubmissionList, + FormSubmissionTrigger, + FormSubmissionTriggerPayload, + FormSubmissionTriggerPayloadSchemaItem, + FormSubmissionTriggerPayloadSchemaItemFieldType, + ImageNode, + ImageNodeImage, + InvalidDomain, + InvalidScopes, + InventoryItem, + InventoryItemInventoryType, + ItemsListItemsLiveRequestLastPublished, + ItemsListItemsRequestLastPublished, + ListCustomCodeBlocks, + Locale, + Locales, + Metadata, + MetadataOptionsItem, + NewOrder, + NoDomains, + Node, + Node_ComponentInstance, + Node_Image, + Node_SearchButton, + Node_Select, + Node_SubmitButton, + Node_Text, + Node_TextInput, + NotEnterprisePlanSite, + NotEnterprisePlanWorkspace, + OptionField, + Order, + OrderAddress, + OrderAddressJapanType, + OrderAddressType, + OrderBillingAddress, + OrderBillingAddressJapanType, + OrderBillingAddressType, + OrderCustomerInfo, + OrderDisputeLastStatus, + OrderDownloadFilesItem, + OrderList, + OrderMetadata, + OrderPrice, + OrderPurchasedItem, + OrderPurchasedItemVariantImage, + OrderPurchasedItemVariantImageFile, + OrderPurchasedItemVariantImageFileVariantsItem, + OrderShippingAddress, + OrderShippingAddressJapanType, + OrderShippingAddressType, + OrderStatus, + OrderTotals, + OrderTotalsExtrasItem, + OrderTotalsExtrasItemType, + Page, + PageCreatedWebhook, + PageCreatedWebhookPayload, + PageDeletedWebhook, + PageDeletedWebhookPayload, + PageList, + PageMetadataUpdatedWebhook, + PageMetadataUpdatedWebhookPayload, + PageOpenGraph, + PageSeo, + Pagination, + Payload, + PayloadFieldData, + PaypalDetails, + Product, + ProductAndSkUs, + ProductAndSkUsList, + ProductFieldData, + ProductFieldDataEcProductType, + ProductFieldDataTaxCategory, + PublishStatus, + Redirect, + Redirects, + ReferenceField, + ReferenceFieldMetadata, + ReferenceFieldType, + RegisteredScriptList, + Robots, + RobotsRulesItem, + ScriptApply, + ScriptApplyList, + ScriptApplyLocation, + Scripts, + SearchButtonNode, + SearchButtonNodeWrite, + Select, + SelectNode, + SelectNodeChoicesItem, + SelectNodeWriteChoicesItem, + SettingChange, + SettingChangeAuditLogItem, + SingleLocaleCreatedPayload, + SingleLocaleCreatedPayloadFieldData, + Site, + SiteActivityLogItem, + SiteActivityLogItemEvent, + SiteActivityLogItemResourceOperation, + SiteActivityLogItemUser, + SiteActivityLogResponse, + SiteDataCollectionType, + SiteMembership, + SiteMembershipAuditLogItem, + SiteMembershipAuditLogItemEventSubType, + SitePlan, + SitePlanId, + SitePlanName, + SitePublish, + SitePublishPayload, + Sites, + Sku, + SkuFieldData, + SkuFieldDataCompareAtPrice, + SkuFieldDataEcSkuBillingMethod, + SkuFieldDataEcSkuSubscriptionPlan, + SkuFieldDataEcSkuSubscriptionPlanInterval, + SkuFieldDataEcSkuSubscriptionPlanPlansItem, + SkuFieldDataEcSkuSubscriptionPlanPlansItemStatus, + SkuFieldDataPrice, + SkuPropertyList, + SkuPropertyListEnumItem, + SkuValueList, + StaticField, + StaticFieldType, + StripeCard, + StripeCardBrand, + StripeCardExpires, + StripeDetails, + SubmitButtonNode, + SubmitButtonNodeWrite, + Text, + TextInputNode, + TextInputNodeWrite, + TextNode, + TextNodeText, + TextNodeWrite, + TriggerType, + UpdatedOrder, + UserAccess, + UserAccessAuditLogItem, + UserAccessAuditLogItemEventSubType, + Webhook, + WebhookFilter, + WebhookList, + WorkspaceAuditLogItem, + WorkspaceAuditLogItemActor, + WorkspaceAuditLogItemPayloadSettingChangeMethod, + WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess, + WorkspaceAuditLogItemPayloadSiteMembershipMethod, + WorkspaceAuditLogItemPayloadSiteMembershipSite, + WorkspaceAuditLogItemPayloadSiteMembershipTargetUser, + WorkspaceAuditLogItemPayloadSiteMembershipUserType, + WorkspaceAuditLogItemPayloadUserAccessMethod, + WorkspaceAuditLogItemPayloadWorkspaceInvitationMethod, + WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUser, + WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUsersItem, + WorkspaceAuditLogItemPayloadWorkspaceInvitationUserType, + WorkspaceAuditLogItemPayloadWorkspaceMembershipMethod, + WorkspaceAuditLogItemPayloadWorkspaceMembershipTargetUser, + WorkspaceAuditLogItemPayloadWorkspaceMembershipUserType, + WorkspaceAuditLogItemWorkspace, + WorkspaceAuditLogItem_CustomRole, + WorkspaceAuditLogItem_SiteMembership, + WorkspaceAuditLogItem_UserAccess, + WorkspaceAuditLogItem_WorkspaceInvitation, + WorkspaceAuditLogItem_WorkspaceMembership, + WorkspaceAuditLogItem_WorkspaceSetting, + WorkspaceAuditLogResponse, + WorkspaceInvitation, + WorkspaceInvitationAuditLogItem, + WorkspaceInvitationAuditLogItemEventSubType, + WorkspaceMembership, + WorkspaceMembershipAuditLogItem, + WorkspaceMembershipAuditLogItemEventSubType, + ) + from .errors import ( + BadRequestError, + ConflictError, + ForbiddenError, + InternalServerError, + NotFoundError, + TooManyRequestsError, + UnauthorizedError, + ) + from .resources import ( + ComponentDomWriteNodesItem, + ComponentPropertiesWritePropertiesItem, + ComponentsUpdateContentResponse, + ComponentsUpdatePropertiesResponse, + EcommInventoryChangedPayload, + InventoryUpdateRequestInventoryType, + OrdersListRequestStatus, + OrdersRefundRequestReason, + PageDomWriteNodesItem, + PageMetadataWriteOpenGraph, + PageMetadataWriteSeo, + ProductSkuCreateProduct, + ProductSkuCreateSku, + ProductsCreateSkuResponse, + SitesPublishResponse, + UpdateStaticContentResponse, + assets, + collections, + components, + ecommerce, + forms, + inventory, + orders, + pages, + products, + scripts, + sites, + token, + webhooks, + workspaces, + ) + from .client import AsyncWebflow, Webflow + from .environment import WebflowEnvironment + from .version import __version__ +_dynamic_imports: typing.Dict[str, str] = { + "Application": ".types", + "Asset": ".types", + "AssetFolder": ".types", + "AssetFolderList": ".types", + "AssetUpload": ".types", + "AssetUploadUploadDetails": ".types", + "AssetVariant": ".types", + "Assets": ".types", + "AsyncWebflow": ".client", + "Authorization": ".types", + "AuthorizationAuthorization": ".types", + "AuthorizationAuthorizationAuthorizedTo": ".types", + "AuthorizedUser": ".types", + "BadRequestError": ".errors", + "BadRequestErrorBody": ".types", + "BulkCollectionItem": ".types", + "BulkCollectionItemFieldData": ".types", + "Collection": ".types", + "CollectionItem": ".types", + "CollectionItemChanged": ".types", + "CollectionItemCreated": ".types", + "CollectionItemFieldData": ".types", + "CollectionItemList": ".types", + "CollectionItemListNoPagination": ".types", + "CollectionItemListPagination": ".types", + "CollectionItemPatchSingle": ".types", + "CollectionItemPatchSingleFieldData": ".types", + "CollectionItemPostSingle": ".types", + "CollectionItemPostSingleFieldData": ".types", + "CollectionItemPublished": ".types", + "CollectionItemRemoved": ".types", + "CollectionItemRemovedPayload": ".types", + "CollectionItemRemovedPayloadFieldData": ".types", + "CollectionItemUnpublished": ".types", + "CollectionItemUnpublishedPayload": ".types", + "CollectionItemUnpublishedPayloadFieldData": ".types", + "CollectionItemWithIdInput": ".types", + "CollectionItemWithIdInputFieldData": ".types", + "CollectionList": ".types", + "CollectionListArrayItem": ".types", + "Comment": ".types", + "CommentPayload": ".types", + "CommentPayloadAuthor": ".types", + "CommentPayloadMentionedUsersItem": ".types", + "CommentReply": ".types", + "CommentReplyAuthor": ".types", + "CommentReplyList": ".types", + "CommentReplyListPagination": ".types", + "CommentReplyMentionedUsersItem": ".types", + "CommentThread": ".types", + "CommentThreadAuthor": ".types", + "CommentThreadList": ".types", + "CommentThreadListPagination": ".types", + "CommentThreadMentionedUsersItem": ".types", + "Component": ".types", + "ComponentDom": ".types", + "ComponentDomWriteNodesItem": ".resources", + "ComponentInstanceNodePropertyOverridesWrite": ".types", + "ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem": ".types", + "ComponentList": ".types", + "ComponentNode": ".types", + "ComponentProperties": ".types", + "ComponentPropertiesWritePropertiesItem": ".resources", + "ComponentProperty": ".types", + "ComponentPropertyType": ".types", + "ComponentsUpdateContentResponse": ".resources", + "ComponentsUpdatePropertiesResponse": ".resources", + "Conflict": ".types", + "ConflictError": ".errors", + "CustomCodeBlock": ".types", + "CustomCodeBlockType": ".types", + "CustomCodeHostedResponse": ".types", + "CustomCodeInlineResponse": ".types", + "CustomRole": ".types", + "CustomRoleAuditLogItem": ".types", + "CustomRoleAuditLogItemEventSubType": ".types", + "Dom": ".types", + "Domain": ".types", + "Domains": ".types", + "EcommInventoryChangedPayload": ".resources", + "EcommerceSettings": ".types", + "Error": ".types", + "ErrorCode": ".types", + "Field": ".types", + "FieldCreate": ".types", + "FieldType": ".types", + "FieldValidations": ".types", + "FieldValidationsAdditionalProperties": ".types", + "FieldValidationsAdditionalPropertiesAdditionalProperties": ".types", + "ForbiddenError": ".errors", + "ForbiddenErrorBody": ".types", + "Form": ".types", + "FormField": ".types", + "FormFieldValue": ".types", + "FormFieldValueType": ".types", + "FormList": ".types", + "FormResponseSettings": ".types", + "FormSubmission": ".types", + "FormSubmissionList": ".types", + "FormSubmissionTrigger": ".types", + "FormSubmissionTriggerPayload": ".types", + "FormSubmissionTriggerPayloadSchemaItem": ".types", + "FormSubmissionTriggerPayloadSchemaItemFieldType": ".types", + "ImageNode": ".types", + "ImageNodeImage": ".types", + "InternalServerError": ".errors", + "InvalidDomain": ".types", + "InvalidScopes": ".types", + "InventoryItem": ".types", + "InventoryItemInventoryType": ".types", + "InventoryUpdateRequestInventoryType": ".resources", + "ItemsListItemsLiveRequestLastPublished": ".types", + "ItemsListItemsRequestLastPublished": ".types", + "ListCustomCodeBlocks": ".types", + "Locale": ".types", + "Locales": ".types", + "Metadata": ".types", + "MetadataOptionsItem": ".types", + "NewOrder": ".types", + "NoDomains": ".types", + "Node": ".types", + "Node_ComponentInstance": ".types", + "Node_Image": ".types", + "Node_SearchButton": ".types", + "Node_Select": ".types", + "Node_SubmitButton": ".types", + "Node_Text": ".types", + "Node_TextInput": ".types", + "NotEnterprisePlanSite": ".types", + "NotEnterprisePlanWorkspace": ".types", + "NotFoundError": ".errors", + "OptionField": ".types", + "Order": ".types", + "OrderAddress": ".types", + "OrderAddressJapanType": ".types", + "OrderAddressType": ".types", + "OrderBillingAddress": ".types", + "OrderBillingAddressJapanType": ".types", + "OrderBillingAddressType": ".types", + "OrderCustomerInfo": ".types", + "OrderDisputeLastStatus": ".types", + "OrderDownloadFilesItem": ".types", + "OrderList": ".types", + "OrderMetadata": ".types", + "OrderPrice": ".types", + "OrderPurchasedItem": ".types", + "OrderPurchasedItemVariantImage": ".types", + "OrderPurchasedItemVariantImageFile": ".types", + "OrderPurchasedItemVariantImageFileVariantsItem": ".types", + "OrderShippingAddress": ".types", + "OrderShippingAddressJapanType": ".types", + "OrderShippingAddressType": ".types", + "OrderStatus": ".types", + "OrderTotals": ".types", + "OrderTotalsExtrasItem": ".types", + "OrderTotalsExtrasItemType": ".types", + "OrdersListRequestStatus": ".resources", + "OrdersRefundRequestReason": ".resources", + "Page": ".types", + "PageCreatedWebhook": ".types", + "PageCreatedWebhookPayload": ".types", + "PageDeletedWebhook": ".types", + "PageDeletedWebhookPayload": ".types", + "PageDomWriteNodesItem": ".resources", + "PageList": ".types", + "PageMetadataUpdatedWebhook": ".types", + "PageMetadataUpdatedWebhookPayload": ".types", + "PageMetadataWriteOpenGraph": ".resources", + "PageMetadataWriteSeo": ".resources", + "PageOpenGraph": ".types", + "PageSeo": ".types", + "Pagination": ".types", + "Payload": ".types", + "PayloadFieldData": ".types", + "PaypalDetails": ".types", + "Product": ".types", + "ProductAndSkUs": ".types", + "ProductAndSkUsList": ".types", + "ProductFieldData": ".types", + "ProductFieldDataEcProductType": ".types", + "ProductFieldDataTaxCategory": ".types", + "ProductSkuCreateProduct": ".resources", + "ProductSkuCreateSku": ".resources", + "ProductsCreateSkuResponse": ".resources", + "PublishStatus": ".types", + "Redirect": ".types", + "Redirects": ".types", + "ReferenceField": ".types", + "ReferenceFieldMetadata": ".types", + "ReferenceFieldType": ".types", + "RegisteredScriptList": ".types", + "Robots": ".types", + "RobotsRulesItem": ".types", + "ScriptApply": ".types", + "ScriptApplyList": ".types", + "ScriptApplyLocation": ".types", + "Scripts": ".types", + "SearchButtonNode": ".types", + "SearchButtonNodeWrite": ".types", + "Select": ".types", + "SelectNode": ".types", + "SelectNodeChoicesItem": ".types", + "SelectNodeWriteChoicesItem": ".types", + "SettingChange": ".types", + "SettingChangeAuditLogItem": ".types", + "SingleLocaleCreatedPayload": ".types", + "SingleLocaleCreatedPayloadFieldData": ".types", + "Site": ".types", + "SiteActivityLogItem": ".types", + "SiteActivityLogItemEvent": ".types", + "SiteActivityLogItemResourceOperation": ".types", + "SiteActivityLogItemUser": ".types", + "SiteActivityLogResponse": ".types", + "SiteDataCollectionType": ".types", + "SiteMembership": ".types", + "SiteMembershipAuditLogItem": ".types", + "SiteMembershipAuditLogItemEventSubType": ".types", + "SitePlan": ".types", + "SitePlanId": ".types", + "SitePlanName": ".types", + "SitePublish": ".types", + "SitePublishPayload": ".types", + "Sites": ".types", + "SitesPublishResponse": ".resources", + "Sku": ".types", + "SkuFieldData": ".types", + "SkuFieldDataCompareAtPrice": ".types", + "SkuFieldDataEcSkuBillingMethod": ".types", + "SkuFieldDataEcSkuSubscriptionPlan": ".types", + "SkuFieldDataEcSkuSubscriptionPlanInterval": ".types", + "SkuFieldDataEcSkuSubscriptionPlanPlansItem": ".types", + "SkuFieldDataEcSkuSubscriptionPlanPlansItemStatus": ".types", + "SkuFieldDataPrice": ".types", + "SkuPropertyList": ".types", + "SkuPropertyListEnumItem": ".types", + "SkuValueList": ".types", + "StaticField": ".types", + "StaticFieldType": ".types", + "StripeCard": ".types", + "StripeCardBrand": ".types", + "StripeCardExpires": ".types", + "StripeDetails": ".types", + "SubmitButtonNode": ".types", + "SubmitButtonNodeWrite": ".types", + "Text": ".types", + "TextInputNode": ".types", + "TextInputNodeWrite": ".types", + "TextNode": ".types", + "TextNodeText": ".types", + "TextNodeWrite": ".types", + "TooManyRequestsError": ".errors", + "TriggerType": ".types", + "UnauthorizedError": ".errors", + "UpdateStaticContentResponse": ".resources", + "UpdatedOrder": ".types", + "UserAccess": ".types", + "UserAccessAuditLogItem": ".types", + "UserAccessAuditLogItemEventSubType": ".types", + "Webflow": ".client", + "WebflowEnvironment": ".environment", + "Webhook": ".types", + "WebhookFilter": ".types", + "WebhookList": ".types", + "WorkspaceAuditLogItem": ".types", + "WorkspaceAuditLogItemActor": ".types", + "WorkspaceAuditLogItemPayloadSettingChangeMethod": ".types", + "WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess": ".types", + "WorkspaceAuditLogItemPayloadSiteMembershipMethod": ".types", + "WorkspaceAuditLogItemPayloadSiteMembershipSite": ".types", + "WorkspaceAuditLogItemPayloadSiteMembershipTargetUser": ".types", + "WorkspaceAuditLogItemPayloadSiteMembershipUserType": ".types", + "WorkspaceAuditLogItemPayloadUserAccessMethod": ".types", + "WorkspaceAuditLogItemPayloadWorkspaceInvitationMethod": ".types", + "WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUser": ".types", + "WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUsersItem": ".types", + "WorkspaceAuditLogItemPayloadWorkspaceInvitationUserType": ".types", + "WorkspaceAuditLogItemPayloadWorkspaceMembershipMethod": ".types", + "WorkspaceAuditLogItemPayloadWorkspaceMembershipTargetUser": ".types", + "WorkspaceAuditLogItemPayloadWorkspaceMembershipUserType": ".types", + "WorkspaceAuditLogItemWorkspace": ".types", + "WorkspaceAuditLogItem_CustomRole": ".types", + "WorkspaceAuditLogItem_SiteMembership": ".types", + "WorkspaceAuditLogItem_UserAccess": ".types", + "WorkspaceAuditLogItem_WorkspaceInvitation": ".types", + "WorkspaceAuditLogItem_WorkspaceMembership": ".types", + "WorkspaceAuditLogItem_WorkspaceSetting": ".types", + "WorkspaceAuditLogResponse": ".types", + "WorkspaceInvitation": ".types", + "WorkspaceInvitationAuditLogItem": ".types", + "WorkspaceInvitationAuditLogItemEventSubType": ".types", + "WorkspaceMembership": ".types", + "WorkspaceMembershipAuditLogItem": ".types", + "WorkspaceMembershipAuditLogItemEventSubType": ".types", + "__version__": ".version", + "assets": ".resources", + "collections": ".resources", + "components": ".resources", + "ecommerce": ".resources", + "forms": ".resources", + "inventory": ".resources", + "orders": ".resources", + "pages": ".resources", + "products": ".resources", + "scripts": ".resources", + "sites": ".resources", + "token": ".resources", + "webhooks": ".resources", + "workspaces": ".resources", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + __all__ = [ - "AccessGroup", - "AccessGroupList", - "AccessGroupsListRequestSort", "Application", "Asset", "AssetFolder", @@ -230,6 +672,8 @@ "BulkCollectionItemFieldData", "Collection", "CollectionItem", + "CollectionItemChanged", + "CollectionItemCreated", "CollectionItemFieldData", "CollectionItemList", "CollectionItemListNoPagination", @@ -238,10 +682,31 @@ "CollectionItemPatchSingleFieldData", "CollectionItemPostSingle", "CollectionItemPostSingleFieldData", + "CollectionItemPublished", + "CollectionItemRemoved", + "CollectionItemRemovedPayload", + "CollectionItemRemovedPayloadFieldData", + "CollectionItemUnpublished", + "CollectionItemUnpublishedPayload", + "CollectionItemUnpublishedPayloadFieldData", "CollectionItemWithIdInput", "CollectionItemWithIdInputFieldData", "CollectionList", "CollectionListArrayItem", + "Comment", + "CommentPayload", + "CommentPayloadAuthor", + "CommentPayloadMentionedUsersItem", + "CommentReply", + "CommentReplyAuthor", + "CommentReplyList", + "CommentReplyListPagination", + "CommentReplyMentionedUsersItem", + "CommentThread", + "CommentThreadAuthor", + "CommentThreadList", + "CommentThreadListPagination", + "CommentThreadMentionedUsersItem", "Component", "ComponentDom", "ComponentDomWriteNodesItem", @@ -255,21 +720,28 @@ "ComponentPropertyType", "ComponentsUpdateContentResponse", "ComponentsUpdatePropertiesResponse", + "Conflict", "ConflictError", - "ConflictErrorBody", "CustomCodeBlock", "CustomCodeBlockType", "CustomCodeHostedResponse", "CustomCodeInlineResponse", + "CustomRole", + "CustomRoleAuditLogItem", + "CustomRoleAuditLogItemEventSubType", "Dom", "Domain", "Domains", - "DuplicateUserEmail", + "EcommInventoryChangedPayload", "EcommerceSettings", "Error", "ErrorCode", "Field", + "FieldCreate", "FieldType", + "FieldValidations", + "FieldValidationsAdditionalProperties", + "FieldValidationsAdditionalPropertiesAdditionalProperties", "ForbiddenError", "ForbiddenErrorBody", "Form", @@ -280,6 +752,10 @@ "FormResponseSettings", "FormSubmission", "FormSubmissionList", + "FormSubmissionTrigger", + "FormSubmissionTriggerPayload", + "FormSubmissionTriggerPayloadSchemaItem", + "FormSubmissionTriggerPayloadSchemaItemFieldType", "ImageNode", "ImageNodeImage", "InternalServerError", @@ -288,21 +764,34 @@ "InventoryItem", "InventoryItemInventoryType", "InventoryUpdateRequestInventoryType", + "ItemsListItemsLiveRequestLastPublished", + "ItemsListItemsRequestLastPublished", "ListCustomCodeBlocks", "Locale", "Locales", + "Metadata", + "MetadataOptionsItem", + "NewOrder", "NoDomains", "Node", "Node_ComponentInstance", "Node_Image", + "Node_SearchButton", + "Node_Select", + "Node_SubmitButton", "Node_Text", + "Node_TextInput", "NotEnterprisePlanSite", "NotEnterprisePlanWorkspace", "NotFoundError", + "OptionField", "Order", "OrderAddress", "OrderAddressJapanType", "OrderAddressType", + "OrderBillingAddress", + "OrderBillingAddressJapanType", + "OrderBillingAddressType", "OrderCustomerInfo", "OrderDisputeLastStatus", "OrderDownloadFilesItem", @@ -313,6 +802,9 @@ "OrderPurchasedItemVariantImage", "OrderPurchasedItemVariantImageFile", "OrderPurchasedItemVariantImageFileVariantsItem", + "OrderShippingAddress", + "OrderShippingAddressJapanType", + "OrderShippingAddressType", "OrderStatus", "OrderTotals", "OrderTotalsExtrasItem", @@ -320,11 +812,21 @@ "OrdersListRequestStatus", "OrdersRefundRequestReason", "Page", + "PageCreatedWebhook", + "PageCreatedWebhookPayload", + "PageDeletedWebhook", + "PageDeletedWebhookPayload", "PageDomWriteNodesItem", "PageList", + "PageMetadataUpdatedWebhook", + "PageMetadataUpdatedWebhookPayload", + "PageMetadataWriteOpenGraph", + "PageMetadataWriteSeo", "PageOpenGraph", "PageSeo", "Pagination", + "Payload", + "PayloadFieldData", "PaypalDetails", "Product", "ProductAndSkUs", @@ -332,15 +834,32 @@ "ProductFieldData", "ProductFieldDataEcProductType", "ProductFieldDataTaxCategory", + "ProductSkuCreateProduct", + "ProductSkuCreateSku", "ProductsCreateSkuResponse", "PublishStatus", "Redirect", "Redirects", + "ReferenceField", + "ReferenceFieldMetadata", + "ReferenceFieldType", "RegisteredScriptList", + "Robots", + "RobotsRulesItem", "ScriptApply", "ScriptApplyList", "ScriptApplyLocation", "Scripts", + "SearchButtonNode", + "SearchButtonNodeWrite", + "Select", + "SelectNode", + "SelectNodeChoicesItem", + "SelectNodeWriteChoicesItem", + "SettingChange", + "SettingChangeAuditLogItem", + "SingleLocaleCreatedPayload", + "SingleLocaleCreatedPayloadFieldData", "Site", "SiteActivityLogItem", "SiteActivityLogItemEvent", @@ -348,9 +867,14 @@ "SiteActivityLogItemUser", "SiteActivityLogResponse", "SiteDataCollectionType", + "SiteMembership", + "SiteMembershipAuditLogItem", + "SiteMembershipAuditLogItemEventSubType", "SitePlan", "SitePlanId", "SitePlanName", + "SitePublish", + "SitePublishPayload", "Sites", "SitesPublishResponse", "Sku", @@ -365,11 +889,17 @@ "SkuPropertyList", "SkuPropertyListEnumItem", "SkuValueList", + "StaticField", + "StaticFieldType", "StripeCard", "StripeCardBrand", "StripeCardExpires", "StripeDetails", + "SubmitButtonNode", + "SubmitButtonNodeWrite", "Text", + "TextInputNode", + "TextInputNodeWrite", "TextNode", "TextNodeText", "TextNodeWrite", @@ -377,24 +907,46 @@ "TriggerType", "UnauthorizedError", "UpdateStaticContentResponse", - "User", - "UserAccessGroupsItem", - "UserAccessGroupsItemType", - "UserData", - "UserDataData", - "UserLimitReached", - "UserList", - "UserStatus", - "UsersListRequestSort", - "UsersNotEnabled", - "UsersUpdateRequestData", + "UpdatedOrder", + "UserAccess", + "UserAccessAuditLogItem", + "UserAccessAuditLogItemEventSubType", "Webflow", "WebflowEnvironment", "Webhook", "WebhookFilter", "WebhookList", + "WorkspaceAuditLogItem", + "WorkspaceAuditLogItemActor", + "WorkspaceAuditLogItemPayloadSettingChangeMethod", + "WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess", + "WorkspaceAuditLogItemPayloadSiteMembershipMethod", + "WorkspaceAuditLogItemPayloadSiteMembershipSite", + "WorkspaceAuditLogItemPayloadSiteMembershipTargetUser", + "WorkspaceAuditLogItemPayloadSiteMembershipUserType", + "WorkspaceAuditLogItemPayloadUserAccessMethod", + "WorkspaceAuditLogItemPayloadWorkspaceInvitationMethod", + "WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUser", + "WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUsersItem", + "WorkspaceAuditLogItemPayloadWorkspaceInvitationUserType", + "WorkspaceAuditLogItemPayloadWorkspaceMembershipMethod", + "WorkspaceAuditLogItemPayloadWorkspaceMembershipTargetUser", + "WorkspaceAuditLogItemPayloadWorkspaceMembershipUserType", + "WorkspaceAuditLogItemWorkspace", + "WorkspaceAuditLogItem_CustomRole", + "WorkspaceAuditLogItem_SiteMembership", + "WorkspaceAuditLogItem_UserAccess", + "WorkspaceAuditLogItem_WorkspaceInvitation", + "WorkspaceAuditLogItem_WorkspaceMembership", + "WorkspaceAuditLogItem_WorkspaceSetting", + "WorkspaceAuditLogResponse", + "WorkspaceInvitation", + "WorkspaceInvitationAuditLogItem", + "WorkspaceInvitationAuditLogItemEventSubType", + "WorkspaceMembership", + "WorkspaceMembershipAuditLogItem", + "WorkspaceMembershipAuditLogItemEventSubType", "__version__", - "access_groups", "assets", "collections", "components", @@ -407,6 +959,6 @@ "scripts", "sites", "token", - "users", "webhooks", + "workspaces", ] diff --git a/src/webflow/client.py b/src/webflow/client.py index 90c233d..bc75156 100644 --- a/src/webflow/client.py +++ b/src/webflow/client.py @@ -1,40 +1,29 @@ # This file was auto-generated by Fern from our API Definition. +from __future__ import annotations + import typing -from .environment import WebflowEnvironment + import httpx -from .core.client_wrapper import SyncClientWrapper -from .resources.token.client import TokenClient -from .resources.sites.client import SitesClient -from .resources.collections.client import CollectionsClient -from .resources.pages.client import PagesClient -from .resources.components.client import ComponentsClient -from .resources.scripts.client import ScriptsClient -from .resources.assets.client import AssetsClient -from .resources.webhooks.client import WebhooksClient -from .resources.forms.client import FormsClient -from .resources.users.client import UsersClient -from .resources.access_groups.client import AccessGroupsClient -from .resources.products.client import ProductsClient -from .resources.orders.client import OrdersClient -from .resources.inventory.client import InventoryClient -from .resources.ecommerce.client import EcommerceClient -from .core.client_wrapper import AsyncClientWrapper -from .resources.token.client import AsyncTokenClient -from .resources.sites.client import AsyncSitesClient -from .resources.collections.client import AsyncCollectionsClient -from .resources.pages.client import AsyncPagesClient -from .resources.components.client import AsyncComponentsClient -from .resources.scripts.client import AsyncScriptsClient -from .resources.assets.client import AsyncAssetsClient -from .resources.webhooks.client import AsyncWebhooksClient -from .resources.forms.client import AsyncFormsClient -from .resources.users.client import AsyncUsersClient -from .resources.access_groups.client import AsyncAccessGroupsClient -from .resources.products.client import AsyncProductsClient -from .resources.orders.client import AsyncOrdersClient -from .resources.inventory.client import AsyncInventoryClient -from .resources.ecommerce.client import AsyncEcommerceClient +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: @@ -43,19 +32,19 @@ class Webflow: Parameters ---------- - base_url : typing.Optional[str] - The base url to use for requests from the client. - environment : WebflowEnvironment The environment to use for requests from the client. from .environment import WebflowEnvironment - Defaults to WebflowEnvironment.DEFAULT + 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. @@ -65,6 +54,9 @@ class Webflow: 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 @@ -77,39 +69,155 @@ class Webflow: def __init__( self, *, - base_url: typing.Optional[str] = None, - environment: WebflowEnvironment = WebflowEnvironment.DEFAULT, + 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 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( - base_url=_get_base_url(base_url=base_url, environment=environment), + 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 = TokenClient(client_wrapper=self._client_wrapper) - self.sites = SitesClient(client_wrapper=self._client_wrapper) - self.collections = CollectionsClient(client_wrapper=self._client_wrapper) - self.pages = PagesClient(client_wrapper=self._client_wrapper) - self.components = ComponentsClient(client_wrapper=self._client_wrapper) - self.scripts = ScriptsClient(client_wrapper=self._client_wrapper) - self.assets = AssetsClient(client_wrapper=self._client_wrapper) - self.webhooks = WebhooksClient(client_wrapper=self._client_wrapper) - self.forms = FormsClient(client_wrapper=self._client_wrapper) - self.users = UsersClient(client_wrapper=self._client_wrapper) - self.access_groups = AccessGroupsClient(client_wrapper=self._client_wrapper) - self.products = ProductsClient(client_wrapper=self._client_wrapper) - self.orders = OrdersClient(client_wrapper=self._client_wrapper) - self.inventory = InventoryClient(client_wrapper=self._client_wrapper) - self.ecommerce = EcommerceClient(client_wrapper=self._client_wrapper) + 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: @@ -118,19 +226,19 @@ class AsyncWebflow: Parameters ---------- - base_url : typing.Optional[str] - The base url to use for requests from the client. - environment : WebflowEnvironment The environment to use for requests from the client. from .environment import WebflowEnvironment - Defaults to WebflowEnvironment.DEFAULT + 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. @@ -140,6 +248,9 @@ class AsyncWebflow: 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 @@ -152,45 +263,152 @@ class AsyncWebflow: def __init__( self, *, - base_url: typing.Optional[str] = None, - environment: WebflowEnvironment = WebflowEnvironment.DEFAULT, + 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 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( - base_url=_get_base_url(base_url=base_url, environment=environment), + 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 = AsyncTokenClient(client_wrapper=self._client_wrapper) - self.sites = AsyncSitesClient(client_wrapper=self._client_wrapper) - self.collections = AsyncCollectionsClient(client_wrapper=self._client_wrapper) - self.pages = AsyncPagesClient(client_wrapper=self._client_wrapper) - self.components = AsyncComponentsClient(client_wrapper=self._client_wrapper) - self.scripts = AsyncScriptsClient(client_wrapper=self._client_wrapper) - self.assets = AsyncAssetsClient(client_wrapper=self._client_wrapper) - self.webhooks = AsyncWebhooksClient(client_wrapper=self._client_wrapper) - self.forms = AsyncFormsClient(client_wrapper=self._client_wrapper) - self.users = AsyncUsersClient(client_wrapper=self._client_wrapper) - self.access_groups = AsyncAccessGroupsClient(client_wrapper=self._client_wrapper) - self.products = AsyncProductsClient(client_wrapper=self._client_wrapper) - self.orders = AsyncOrdersClient(client_wrapper=self._client_wrapper) - self.inventory = AsyncInventoryClient(client_wrapper=self._client_wrapper) - self.ecommerce = AsyncEcommerceClient(client_wrapper=self._client_wrapper) - - -def _get_base_url(*, base_url: typing.Optional[str] = None, environment: WebflowEnvironment) -> str: - if base_url is not None: - return base_url - elif environment is not None: - return environment.value - else: - raise Exception("Please pass in either base_url or environment to construct the client") + 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 diff --git a/src/webflow/core/__init__.py b/src/webflow/core/__init__.py index f03aecb..4fb6e12 100644 --- a/src/webflow/core/__init__.py +++ b/src/webflow/core/__init__.py @@ -1,43 +1,121 @@ # This file was auto-generated by Fern from our API Definition. -from .api_error import ApiError -from .client_wrapper import AsyncClientWrapper, BaseClientWrapper, SyncClientWrapper -from .datetime_utils import serialize_datetime -from .file import File, convert_file_dict_to_httpx_tuples, with_content_type -from .http_client import AsyncHttpClient, HttpClient -from .jsonable_encoder import jsonable_encoder -from .pydantic_utilities import ( - IS_PYDANTIC_V2, - UniversalBaseModel, - UniversalRootModel, - parse_obj_as, - universal_field_validator, - universal_root_validator, - update_forward_refs, -) -from .query_encoder import encode_query -from .remove_none_from_dict import remove_none_from_dict -from .request_options import RequestOptions -from .serialization import FieldMetadata, convert_and_respect_annotation_metadata +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .api_error import ApiError + from .client_wrapper import AsyncClientWrapper, BaseClientWrapper, SyncClientWrapper + from .datetime_utils import Rfc2822DateTime, parse_rfc2822_datetime, serialize_datetime + from .file import File, convert_file_dict_to_httpx_tuples, with_content_type + from .http_client import AsyncHttpClient, HttpClient + from .http_response import AsyncHttpResponse, HttpResponse + from .jsonable_encoder import jsonable_encoder + from .logging import ConsoleLogger, ILogger, LogConfig, LogLevel, Logger, create_logger + from .parse_error import ParsingError + from .pydantic_utilities import ( + IS_PYDANTIC_V2, + UniversalBaseModel, + UniversalRootModel, + parse_obj_as, + universal_field_validator, + universal_root_validator, + update_forward_refs, + ) + from .query_encoder import encode_query + from .remove_none_from_dict import remove_none_from_dict + from .request_options import RequestOptions + from .serialization import FieldMetadata, convert_and_respect_annotation_metadata +_dynamic_imports: typing.Dict[str, str] = { + "ApiError": ".api_error", + "AsyncClientWrapper": ".client_wrapper", + "AsyncHttpClient": ".http_client", + "AsyncHttpResponse": ".http_response", + "BaseClientWrapper": ".client_wrapper", + "ConsoleLogger": ".logging", + "FieldMetadata": ".serialization", + "File": ".file", + "HttpClient": ".http_client", + "HttpResponse": ".http_response", + "ILogger": ".logging", + "IS_PYDANTIC_V2": ".pydantic_utilities", + "LogConfig": ".logging", + "LogLevel": ".logging", + "Logger": ".logging", + "ParsingError": ".parse_error", + "RequestOptions": ".request_options", + "Rfc2822DateTime": ".datetime_utils", + "SyncClientWrapper": ".client_wrapper", + "UniversalBaseModel": ".pydantic_utilities", + "UniversalRootModel": ".pydantic_utilities", + "convert_and_respect_annotation_metadata": ".serialization", + "convert_file_dict_to_httpx_tuples": ".file", + "create_logger": ".logging", + "encode_query": ".query_encoder", + "jsonable_encoder": ".jsonable_encoder", + "parse_obj_as": ".pydantic_utilities", + "parse_rfc2822_datetime": ".datetime_utils", + "remove_none_from_dict": ".remove_none_from_dict", + "serialize_datetime": ".datetime_utils", + "universal_field_validator": ".pydantic_utilities", + "universal_root_validator": ".pydantic_utilities", + "update_forward_refs": ".pydantic_utilities", + "with_content_type": ".file", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + __all__ = [ "ApiError", "AsyncClientWrapper", "AsyncHttpClient", + "AsyncHttpResponse", "BaseClientWrapper", + "ConsoleLogger", "FieldMetadata", "File", "HttpClient", + "HttpResponse", + "ILogger", "IS_PYDANTIC_V2", + "LogConfig", + "LogLevel", + "Logger", + "ParsingError", "RequestOptions", + "Rfc2822DateTime", "SyncClientWrapper", "UniversalBaseModel", "UniversalRootModel", "convert_and_respect_annotation_metadata", "convert_file_dict_to_httpx_tuples", + "create_logger", "encode_query", "jsonable_encoder", "parse_obj_as", + "parse_rfc2822_datetime", "remove_none_from_dict", "serialize_datetime", "universal_field_validator", diff --git a/src/webflow/core/api_error.py b/src/webflow/core/api_error.py index 2e9fc54..6f850a6 100644 --- a/src/webflow/core/api_error.py +++ b/src/webflow/core/api_error.py @@ -1,15 +1,23 @@ # This file was auto-generated by Fern from our API Definition. -import typing +from typing import Any, Dict, Optional class ApiError(Exception): - status_code: typing.Optional[int] - body: typing.Any + headers: Optional[Dict[str, str]] + status_code: Optional[int] + body: Any - def __init__(self, *, status_code: typing.Optional[int] = None, body: typing.Any = None): + def __init__( + self, + *, + headers: Optional[Dict[str, str]] = None, + status_code: Optional[int] = None, + body: Any = None, + ) -> None: + self.headers = headers self.status_code = status_code self.body = body def __str__(self) -> str: - return f"status_code: {self.status_code}, body: {self.body}" + return f"headers: {self.headers}, status_code: {self.status_code}, body: {self.body}" diff --git a/src/webflow/core/client_wrapper.py b/src/webflow/core/client_wrapper.py index 84ed6fb..7f6db17 100644 --- a/src/webflow/core/client_wrapper.py +++ b/src/webflow/core/client_wrapper.py @@ -1,9 +1,11 @@ # This file was auto-generated by Fern from our API Definition. import typing + import httpx -from .http_client import HttpClient -from .http_client import AsyncHttpClient +from ..environment import WebflowEnvironment +from .http_client import AsyncHttpClient, HttpClient +from .logging import LogConfig, Logger class BaseClientWrapper: @@ -11,18 +13,28 @@ def __init__( self, *, access_token: typing.Union[str, typing.Callable[[], str]], - base_url: str, + headers: typing.Optional[typing.Dict[str, str]] = None, + environment: WebflowEnvironment, timeout: typing.Optional[float] = None, + logging: typing.Optional[typing.Union[LogConfig, Logger]] = None, ): self._access_token = access_token - self._base_url = base_url + self._headers = headers + self._environment = environment self._timeout = timeout + self._logging = logging def get_headers(self) -> typing.Dict[str, str]: + import platform + headers: typing.Dict[str, str] = { + "User-Agent": "webflow/2.0.0", "X-Fern-Language": "Python", + "X-Fern-Runtime": f"python/{platform.python_version()}", + "X-Fern-Platform": f"{platform.system().lower()}/{platform.release()}", "X-Fern-SDK-Name": "webflow", - "X-Fern-SDK-Version": "2.0.0b1", + "X-Fern-SDK-Version": "2.0.0", + **(self.get_custom_headers() or {}), } headers["Authorization"] = f"Bearer {self._get_access_token()}" return headers @@ -33,8 +45,11 @@ def _get_access_token(self) -> str: else: return self._access_token() - def get_base_url(self) -> str: - return self._base_url + def get_custom_headers(self) -> typing.Optional[typing.Dict[str, str]]: + return self._headers + + def get_environment(self) -> WebflowEnvironment: + return self._environment def get_timeout(self) -> typing.Optional[float]: return self._timeout @@ -45,16 +60,20 @@ def __init__( self, *, access_token: typing.Union[str, typing.Callable[[], str]], - base_url: str, + headers: typing.Optional[typing.Dict[str, str]] = None, + environment: WebflowEnvironment, timeout: typing.Optional[float] = None, + logging: typing.Optional[typing.Union[LogConfig, Logger]] = None, httpx_client: httpx.Client, ): - super().__init__(access_token=access_token, base_url=base_url, timeout=timeout) + super().__init__( + access_token=access_token, headers=headers, environment=environment, timeout=timeout, logging=logging + ) self.httpx_client = HttpClient( httpx_client=httpx_client, base_headers=self.get_headers, base_timeout=self.get_timeout, - base_url=self.get_base_url, + logging_config=self._logging, ) @@ -63,14 +82,28 @@ def __init__( self, *, access_token: typing.Union[str, typing.Callable[[], str]], - base_url: str, + headers: typing.Optional[typing.Dict[str, str]] = None, + environment: WebflowEnvironment, timeout: typing.Optional[float] = None, + logging: typing.Optional[typing.Union[LogConfig, Logger]] = None, + async_token: typing.Optional[typing.Callable[[], typing.Awaitable[str]]] = None, httpx_client: httpx.AsyncClient, ): - super().__init__(access_token=access_token, base_url=base_url, timeout=timeout) + super().__init__( + access_token=access_token, headers=headers, environment=environment, timeout=timeout, logging=logging + ) + self._async_token = async_token self.httpx_client = AsyncHttpClient( httpx_client=httpx_client, base_headers=self.get_headers, base_timeout=self.get_timeout, - base_url=self.get_base_url, + async_base_headers=self.async_get_headers, + logging_config=self._logging, ) + + async def async_get_headers(self) -> typing.Dict[str, str]: + headers = self.get_headers() + if self._async_token is not None: + token = await self._async_token() + headers["Authorization"] = f"Bearer {token}" + return headers diff --git a/src/webflow/core/datetime_utils.py b/src/webflow/core/datetime_utils.py index 7c9864a..a12b2ad 100644 --- a/src/webflow/core/datetime_utils.py +++ b/src/webflow/core/datetime_utils.py @@ -1,6 +1,48 @@ # This file was auto-generated by Fern from our API Definition. import datetime as dt +from email.utils import parsedate_to_datetime +from typing import Any + +import pydantic + +IS_PYDANTIC_V2 = pydantic.VERSION.startswith("2.") + + +def parse_rfc2822_datetime(v: Any) -> dt.datetime: + """ + Parse an RFC 2822 datetime string (e.g., "Wed, 02 Oct 2002 13:00:00 GMT") + into a datetime object. If the value is already a datetime, return it as-is. + Falls back to ISO 8601 parsing if RFC 2822 parsing fails. + """ + if isinstance(v, dt.datetime): + return v + if isinstance(v, str): + try: + return parsedate_to_datetime(v) + except Exception: + pass + # Fallback to ISO 8601 parsing + return dt.datetime.fromisoformat(v.replace("Z", "+00:00")) + raise ValueError(f"Expected str or datetime, got {type(v)}") + + +class Rfc2822DateTime(dt.datetime): + """A datetime subclass that parses RFC 2822 date strings. + + On Pydantic V1, uses __get_validators__ for pre-validation. + On Pydantic V2, uses __get_pydantic_core_schema__ for BeforeValidator-style parsing. + """ + + @classmethod + def __get_validators__(cls): # type: ignore[no-untyped-def] + yield parse_rfc2822_datetime + + @classmethod + def __get_pydantic_core_schema__(cls, _source_type: Any, _handler: Any) -> Any: # type: ignore[override] + from pydantic_core import core_schema + + return core_schema.no_info_before_validator_function(parse_rfc2822_datetime, core_schema.datetime_schema()) def serialize_datetime(v: dt.datetime) -> str: diff --git a/src/webflow/core/force_multipart.py b/src/webflow/core/force_multipart.py new file mode 100644 index 0000000..5440913 --- /dev/null +++ b/src/webflow/core/force_multipart.py @@ -0,0 +1,18 @@ +# This file was auto-generated by Fern from our API Definition. + +from typing import Any, Dict + + +class ForceMultipartDict(Dict[str, Any]): + """ + A dictionary subclass that always evaluates to True in boolean contexts. + + This is used to force multipart/form-data encoding in HTTP requests even when + the dictionary is empty, which would normally evaluate to False. + """ + + def __bool__(self) -> bool: + return True + + +FORCE_MULTIPART = ForceMultipartDict() diff --git a/src/webflow/core/http_client.py b/src/webflow/core/http_client.py index 1a1a131..ee93758 100644 --- a/src/webflow/core/http_client.py +++ b/src/webflow/core/http_client.py @@ -2,25 +2,25 @@ import asyncio import email.utils -import json import re import time import typing -import urllib.parse from contextlib import asynccontextmanager, contextmanager from random import random import httpx - from .file import File, convert_file_dict_to_httpx_tuples +from .force_multipart import FORCE_MULTIPART from .jsonable_encoder import jsonable_encoder +from .logging import LogConfig, Logger, create_logger from .query_encoder import encode_query -from .remove_none_from_dict import remove_none_from_dict +from .remove_none_from_dict import remove_none_from_dict as remove_none_from_dict from .request_options import RequestOptions +from httpx._types import RequestFiles -INITIAL_RETRY_DELAY_SECONDS = 0.5 -MAX_RETRY_DELAY_SECONDS = 10 -MAX_RETRY_DELAY_SECONDS_FROM_HEADER = 30 +INITIAL_RETRY_DELAY_SECONDS = 1.0 +MAX_RETRY_DELAY_SECONDS = 60.0 +JITTER_FACTOR = 0.2 # 20% random jitter def _parse_retry_after(response_headers: httpx.Headers) -> typing.Optional[float]: @@ -64,6 +64,38 @@ def _parse_retry_after(response_headers: httpx.Headers) -> typing.Optional[float return seconds +def _add_positive_jitter(delay: float) -> float: + """Add positive jitter (0-20%) to prevent thundering herd.""" + jitter_multiplier = 1 + random() * JITTER_FACTOR + return delay * jitter_multiplier + + +def _add_symmetric_jitter(delay: float) -> float: + """Add symmetric jitter (±10%) for exponential backoff.""" + jitter_multiplier = 1 + (random() - 0.5) * JITTER_FACTOR + return delay * jitter_multiplier + + +def _parse_x_ratelimit_reset(response_headers: httpx.Headers) -> typing.Optional[float]: + """ + Parse the X-RateLimit-Reset header (Unix timestamp in seconds). + Returns seconds to wait, or None if header is missing/invalid. + """ + reset_time_str = response_headers.get("x-ratelimit-reset") + if reset_time_str is None: + return None + + try: + reset_time = int(reset_time_str) + delay = reset_time - time.time() + if delay > 0: + return delay + except (ValueError, TypeError): + pass + + return None + + def _retry_timeout(response: httpx.Response, retries: int) -> float: """ Determine the amount of time to wait before retrying a request. @@ -71,22 +103,89 @@ def _retry_timeout(response: httpx.Response, retries: int) -> float: with a jitter to determine the number of seconds to wait. """ - # If the API asks us to wait a certain amount of time (and it's a reasonable amount), just do what it says. + # 1. Check Retry-After header first retry_after = _parse_retry_after(response.headers) - if retry_after is not None and retry_after <= MAX_RETRY_DELAY_SECONDS_FROM_HEADER: - return retry_after + if retry_after is not None and retry_after > 0: + return min(retry_after, MAX_RETRY_DELAY_SECONDS) - # Apply exponential backoff, capped at MAX_RETRY_DELAY_SECONDS. - retry_delay = min(INITIAL_RETRY_DELAY_SECONDS * pow(2.0, retries), MAX_RETRY_DELAY_SECONDS) + # 2. Check X-RateLimit-Reset header (with positive jitter) + ratelimit_reset = _parse_x_ratelimit_reset(response.headers) + if ratelimit_reset is not None: + return _add_positive_jitter(min(ratelimit_reset, MAX_RETRY_DELAY_SECONDS)) - # Add a randomness / jitter to the retry delay to avoid overwhelming the server with retries. - timeout = retry_delay * (1 - 0.25 * random()) - return timeout if timeout >= 0 else 0 + # 3. Fall back to exponential backoff (with symmetric jitter) + backoff = min(INITIAL_RETRY_DELAY_SECONDS * pow(2.0, retries), MAX_RETRY_DELAY_SECONDS) + return _add_symmetric_jitter(backoff) def _should_retry(response: httpx.Response) -> bool: - retriable_400s = [429, 408, 409] - return response.status_code >= 500 or response.status_code in retriable_400s + retryable_400s = [429, 408, 409] + return response.status_code >= 500 or response.status_code in retryable_400s + + +_SENSITIVE_HEADERS = frozenset( + { + "authorization", + "www-authenticate", + "x-api-key", + "api-key", + "apikey", + "x-api-token", + "x-auth-token", + "auth-token", + "cookie", + "set-cookie", + "proxy-authorization", + "proxy-authenticate", + "x-csrf-token", + "x-xsrf-token", + "x-session-token", + "x-access-token", + } +) + + +def _redact_headers(headers: typing.Dict[str, str]) -> typing.Dict[str, str]: + return {k: ("[REDACTED]" if k.lower() in _SENSITIVE_HEADERS else v) for k, v in headers.items()} + + +def _build_url(base_url: str, path: typing.Optional[str]) -> str: + """ + Build a full URL by joining a base URL with a path. + + This function correctly handles base URLs that contain path prefixes (e.g., tenant-based URLs) + by using string concatenation instead of urllib.parse.urljoin(), which would incorrectly + strip path components when the path starts with '/'. + + Example: + >>> _build_url("https://cloud.example.com/org/tenant/api", "/users") + 'https://cloud.example.com/org/tenant/api/users' + + Args: + base_url: The base URL, which may contain path prefixes. + path: The path to append. Can be None or empty string. + + Returns: + The full URL with base_url and path properly joined. + """ + if not path: + return base_url + return f"{base_url.rstrip('/')}/{path.lstrip('/')}" + + +def _maybe_filter_none_from_multipart_data( + data: typing.Optional[typing.Any], + request_files: typing.Optional[RequestFiles], + force_multipart: typing.Optional[bool], +) -> typing.Optional[typing.Any]: + """ + Filter None values from data body for multipart/form requests. + This prevents httpx from converting None to empty strings in multipart encoding. + Only applies when files are present or force_multipart is True. + """ + if data is not None and isinstance(data, typing.Mapping) and (request_files or force_multipart): + return remove_none_from_dict(data) + return data def remove_omit_from_dict( @@ -143,8 +242,19 @@ def get_request_body( # If both data and json are None, we send json data in the event extra properties are specified json_body = maybe_filter_request_body(json, request_options, omit) - # If you have an empty JSON body, you should just send None - return (json_body if json_body != {} else None), data_body if data_body != {} else None + has_additional_body_parameters = bool( + request_options is not None and request_options.get("additional_body_parameters") + ) + + # Only collapse empty dict to None when the body was not explicitly provided + # and there are no additional body parameters. This preserves explicit empty + # bodies (e.g., when an endpoint has a request body type but all fields are optional). + if json_body == {} and json is None and not has_additional_body_parameters: + json_body = None + if data_body == {} and data is None and not has_additional_body_parameters: + data_body = None + + return json_body, data_body class HttpClient: @@ -155,11 +265,13 @@ def __init__( base_timeout: typing.Callable[[], typing.Optional[float]], base_headers: typing.Callable[[], typing.Dict[str, str]], base_url: typing.Optional[typing.Callable[[], str]] = None, + logging_config: typing.Optional[typing.Union[LogConfig, Logger]] = None, ): self.base_url = base_url self.base_timeout = base_timeout self.base_headers = base_headers self.httpx_client = httpx_client + self.logger = create_logger(logging_config) def get_base_url(self, maybe_base_url: typing.Optional[str]) -> str: base_url = maybe_base_url @@ -180,11 +292,17 @@ def request( json: typing.Optional[typing.Any] = None, data: typing.Optional[typing.Any] = None, content: typing.Optional[typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]] = None, - files: typing.Optional[typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]]] = None, + files: typing.Optional[ + typing.Union[ + typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]], + typing.List[typing.Tuple[str, File]], + ] + ] = None, headers: typing.Optional[typing.Dict[str, typing.Any]] = None, request_options: typing.Optional[RequestOptions] = None, retries: int = 0, omit: typing.Optional[typing.Any] = None, + force_multipart: typing.Optional[bool] = None, ) -> httpx.Response: base_url = self.get_base_url(base_url) timeout = ( @@ -195,49 +313,72 @@ def request( json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit) - response = self.httpx_client.request( - method=method, - url=urllib.parse.urljoin(f"{base_url}/", path), - headers=jsonable_encoder( + request_files: typing.Optional[RequestFiles] = ( + convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit)) + if (files is not None and files is not omit and isinstance(files, dict)) + else None + ) + + if (request_files is None or len(request_files) == 0) and force_multipart: + request_files = FORCE_MULTIPART + + data_body = _maybe_filter_none_from_multipart_data(data_body, request_files, force_multipart) + + # Compute encoded params separately to avoid passing empty list to httpx + # (httpx strips existing query params from URL when params=[] is passed) + _encoded_params = encode_query( + jsonable_encoder( remove_none_from_dict( - { - **self.base_headers(), - **(headers if headers is not None else {}), - **(request_options.get("additional_headers", {}) or {} if request_options is not None else {}), - } - ) - ), - params=encode_query( - jsonable_encoder( - remove_none_from_dict( - remove_omit_from_dict( - { - **(params if params is not None else {}), - **( - request_options.get("additional_query_parameters", {}) or {} - if request_options is not None - else {} - ), - }, - omit, - ) + remove_omit_from_dict( + { + **(params if params is not None else {}), + **( + request_options.get("additional_query_parameters", {}) or {} + if request_options is not None + else {} + ), + }, + omit, ) ) - ), + ) + ) + + _request_url = _build_url(base_url, path) + _request_headers = jsonable_encoder( + remove_none_from_dict( + { + **self.base_headers(), + **(headers if headers is not None else {}), + **(request_options.get("additional_headers", {}) or {} if request_options is not None else {}), + } + ) + ) + + if self.logger.is_debug(): + self.logger.debug( + "Making HTTP request", + method=method, + url=_request_url, + headers=_redact_headers(_request_headers), + has_body=json_body is not None or data_body is not None, + ) + + response = self.httpx_client.request( + method=method, + url=_request_url, + headers=_request_headers, + params=_encoded_params if _encoded_params else None, json=json_body, data=data_body, content=content, - files=( - convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit)) - if (files is not None and files is not omit) - else None - ), + files=request_files, timeout=timeout, ) - max_retries: int = request_options.get("max_retries", 0) if request_options is not None else 0 + max_retries: int = request_options.get("max_retries", 2) if request_options is not None else 2 if _should_retry(response=response): - if max_retries > retries: + if retries < max_retries: time.sleep(_retry_timeout(response=response, retries=retries)) return self.request( path=path, @@ -253,6 +394,24 @@ def request( omit=omit, ) + if self.logger.is_debug(): + if 200 <= response.status_code < 400: + self.logger.debug( + "HTTP request succeeded", + method=method, + url=_request_url, + status_code=response.status_code, + ) + + if self.logger.is_error(): + if response.status_code >= 400: + self.logger.error( + "HTTP request failed with error status", + method=method, + url=_request_url, + status_code=response.status_code, + ) + return response @contextmanager @@ -266,11 +425,17 @@ def stream( json: typing.Optional[typing.Any] = None, data: typing.Optional[typing.Any] = None, content: typing.Optional[typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]] = None, - files: typing.Optional[typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]]] = None, + files: typing.Optional[ + typing.Union[ + typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]], + typing.List[typing.Tuple[str, File]], + ] + ] = None, headers: typing.Optional[typing.Dict[str, typing.Any]] = None, request_options: typing.Optional[RequestOptions] = None, retries: int = 0, omit: typing.Optional[typing.Any] = None, + force_multipart: typing.Optional[bool] = None, ) -> typing.Iterator[httpx.Response]: base_url = self.get_base_url(base_url) timeout = ( @@ -279,45 +444,67 @@ def stream( else self.base_timeout() ) + request_files: typing.Optional[RequestFiles] = ( + convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit)) + if (files is not None and files is not omit and isinstance(files, dict)) + else None + ) + + if (request_files is None or len(request_files) == 0) and force_multipart: + request_files = FORCE_MULTIPART + json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit) - with self.httpx_client.stream( - method=method, - url=urllib.parse.urljoin(f"{base_url}/", path), - headers=jsonable_encoder( + data_body = _maybe_filter_none_from_multipart_data(data_body, request_files, force_multipart) + + # Compute encoded params separately to avoid passing empty list to httpx + # (httpx strips existing query params from URL when params=[] is passed) + _encoded_params = encode_query( + jsonable_encoder( remove_none_from_dict( - { - **self.base_headers(), - **(headers if headers is not None else {}), - **(request_options.get("additional_headers", {}) if request_options is not None else {}), - } - ) - ), - params=encode_query( - jsonable_encoder( - remove_none_from_dict( - remove_omit_from_dict( - { - **(params if params is not None else {}), - **( - request_options.get("additional_query_parameters", {}) - if request_options is not None - else {} - ), - }, - omit, - ) + remove_omit_from_dict( + { + **(params if params is not None else {}), + **( + request_options.get("additional_query_parameters", {}) + if request_options is not None + else {} + ), + }, + omit, ) ) - ), + ) + ) + + _request_url = _build_url(base_url, path) + _request_headers = jsonable_encoder( + remove_none_from_dict( + { + **self.base_headers(), + **(headers if headers is not None else {}), + **(request_options.get("additional_headers", {}) if request_options is not None else {}), + } + ) + ) + + if self.logger.is_debug(): + self.logger.debug( + "Making streaming HTTP request", + method=method, + url=_request_url, + headers=_redact_headers(_request_headers), + ) + + with self.httpx_client.stream( + method=method, + url=_request_url, + headers=_request_headers, + params=_encoded_params if _encoded_params else None, json=json_body, data=data_body, content=content, - files=( - convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit)) - if (files is not None and files is not omit) - else None - ), + files=request_files, timeout=timeout, ) as stream: yield stream @@ -331,11 +518,20 @@ def __init__( base_timeout: typing.Callable[[], typing.Optional[float]], base_headers: typing.Callable[[], typing.Dict[str, str]], base_url: typing.Optional[typing.Callable[[], str]] = None, + async_base_headers: typing.Optional[typing.Callable[[], typing.Awaitable[typing.Dict[str, str]]]] = None, + logging_config: typing.Optional[typing.Union[LogConfig, Logger]] = None, ): self.base_url = base_url self.base_timeout = base_timeout self.base_headers = base_headers + self.async_base_headers = async_base_headers self.httpx_client = httpx_client + self.logger = create_logger(logging_config) + + async def _get_headers(self) -> typing.Dict[str, str]: + if self.async_base_headers is not None: + return await self.async_base_headers() + return self.base_headers() def get_base_url(self, maybe_base_url: typing.Optional[str]) -> str: base_url = maybe_base_url @@ -356,11 +552,17 @@ async def request( json: typing.Optional[typing.Any] = None, data: typing.Optional[typing.Any] = None, content: typing.Optional[typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]] = None, - files: typing.Optional[typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]]] = None, + files: typing.Optional[ + typing.Union[ + typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]], + typing.List[typing.Tuple[str, File]], + ] + ] = None, headers: typing.Optional[typing.Dict[str, typing.Any]] = None, request_options: typing.Optional[RequestOptions] = None, retries: int = 0, omit: typing.Optional[typing.Any] = None, + force_multipart: typing.Optional[bool] = None, ) -> httpx.Response: base_url = self.get_base_url(base_url) timeout = ( @@ -369,52 +571,77 @@ async def request( else self.base_timeout() ) + request_files: typing.Optional[RequestFiles] = ( + convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit)) + if (files is not None and files is not omit and isinstance(files, dict)) + else None + ) + + if (request_files is None or len(request_files) == 0) and force_multipart: + request_files = FORCE_MULTIPART + json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit) - # Add the input to each of these and do None-safety checks - response = await self.httpx_client.request( - method=method, - url=urllib.parse.urljoin(f"{base_url}/", path), - headers=jsonable_encoder( + data_body = _maybe_filter_none_from_multipart_data(data_body, request_files, force_multipart) + + # Get headers (supports async token providers) + _headers = await self._get_headers() + + # Compute encoded params separately to avoid passing empty list to httpx + # (httpx strips existing query params from URL when params=[] is passed) + _encoded_params = encode_query( + jsonable_encoder( remove_none_from_dict( - { - **self.base_headers(), - **(headers if headers is not None else {}), - **(request_options.get("additional_headers", {}) or {} if request_options is not None else {}), - } - ) - ), - params=encode_query( - jsonable_encoder( - remove_none_from_dict( - remove_omit_from_dict( - { - **(params if params is not None else {}), - **( - request_options.get("additional_query_parameters", {}) or {} - if request_options is not None - else {} - ), - }, - omit, - ) + remove_omit_from_dict( + { + **(params if params is not None else {}), + **( + request_options.get("additional_query_parameters", {}) or {} + if request_options is not None + else {} + ), + }, + omit, ) ) - ), + ) + ) + + _request_url = _build_url(base_url, path) + _request_headers = jsonable_encoder( + remove_none_from_dict( + { + **_headers, + **(headers if headers is not None else {}), + **(request_options.get("additional_headers", {}) or {} if request_options is not None else {}), + } + ) + ) + + if self.logger.is_debug(): + self.logger.debug( + "Making HTTP request", + method=method, + url=_request_url, + headers=_redact_headers(_request_headers), + has_body=json_body is not None or data_body is not None, + ) + + response = await self.httpx_client.request( + method=method, + url=_request_url, + headers=_request_headers, + params=_encoded_params if _encoded_params else None, json=json_body, data=data_body, content=content, - files=( - convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit)) - if files is not None - else None - ), + files=request_files, timeout=timeout, ) - max_retries: int = request_options.get("max_retries", 0) if request_options is not None else 0 + max_retries: int = request_options.get("max_retries", 2) if request_options is not None else 2 if _should_retry(response=response): - if max_retries > retries: + if retries < max_retries: await asyncio.sleep(_retry_timeout(response=response, retries=retries)) return await self.request( path=path, @@ -429,6 +656,25 @@ async def request( retries=retries + 1, omit=omit, ) + + if self.logger.is_debug(): + if 200 <= response.status_code < 400: + self.logger.debug( + "HTTP request succeeded", + method=method, + url=_request_url, + status_code=response.status_code, + ) + + if self.logger.is_error(): + if response.status_code >= 400: + self.logger.error( + "HTTP request failed with error status", + method=method, + url=_request_url, + status_code=response.status_code, + ) + return response @asynccontextmanager @@ -442,11 +688,17 @@ async def stream( json: typing.Optional[typing.Any] = None, data: typing.Optional[typing.Any] = None, content: typing.Optional[typing.Union[bytes, typing.Iterator[bytes], typing.AsyncIterator[bytes]]] = None, - files: typing.Optional[typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]]] = None, + files: typing.Optional[ + typing.Union[ + typing.Dict[str, typing.Optional[typing.Union[File, typing.List[File]]]], + typing.List[typing.Tuple[str, File]], + ] + ] = None, headers: typing.Optional[typing.Dict[str, typing.Any]] = None, request_options: typing.Optional[RequestOptions] = None, retries: int = 0, omit: typing.Optional[typing.Any] = None, + force_multipart: typing.Optional[bool] = None, ) -> typing.AsyncIterator[httpx.Response]: base_url = self.get_base_url(base_url) timeout = ( @@ -455,45 +707,70 @@ async def stream( else self.base_timeout() ) + request_files: typing.Optional[RequestFiles] = ( + convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit)) + if (files is not None and files is not omit and isinstance(files, dict)) + else None + ) + + if (request_files is None or len(request_files) == 0) and force_multipart: + request_files = FORCE_MULTIPART + json_body, data_body = get_request_body(json=json, data=data, request_options=request_options, omit=omit) - async with self.httpx_client.stream( - method=method, - url=urllib.parse.urljoin(f"{base_url}/", path), - headers=jsonable_encoder( + data_body = _maybe_filter_none_from_multipart_data(data_body, request_files, force_multipart) + + # Get headers (supports async token providers) + _headers = await self._get_headers() + + # Compute encoded params separately to avoid passing empty list to httpx + # (httpx strips existing query params from URL when params=[] is passed) + _encoded_params = encode_query( + jsonable_encoder( remove_none_from_dict( - { - **self.base_headers(), - **(headers if headers is not None else {}), - **(request_options.get("additional_headers", {}) if request_options is not None else {}), - } - ) - ), - params=encode_query( - jsonable_encoder( - remove_none_from_dict( - remove_omit_from_dict( - { - **(params if params is not None else {}), - **( - request_options.get("additional_query_parameters", {}) - if request_options is not None - else {} - ), - }, - omit=omit, - ) + remove_omit_from_dict( + { + **(params if params is not None else {}), + **( + request_options.get("additional_query_parameters", {}) + if request_options is not None + else {} + ), + }, + omit=omit, ) ) - ), + ) + ) + + _request_url = _build_url(base_url, path) + _request_headers = jsonable_encoder( + remove_none_from_dict( + { + **_headers, + **(headers if headers is not None else {}), + **(request_options.get("additional_headers", {}) if request_options is not None else {}), + } + ) + ) + + if self.logger.is_debug(): + self.logger.debug( + "Making streaming HTTP request", + method=method, + url=_request_url, + headers=_redact_headers(_request_headers), + ) + + async with self.httpx_client.stream( + method=method, + url=_request_url, + headers=_request_headers, + params=_encoded_params if _encoded_params else None, json=json_body, data=data_body, content=content, - files=( - convert_file_dict_to_httpx_tuples(remove_omit_from_dict(remove_none_from_dict(files), omit)) - if files is not None - else None - ), + files=request_files, timeout=timeout, ) as stream: yield stream diff --git a/src/webflow/core/http_response.py b/src/webflow/core/http_response.py new file mode 100644 index 0000000..00bb109 --- /dev/null +++ b/src/webflow/core/http_response.py @@ -0,0 +1,59 @@ +# This file was auto-generated by Fern from our API Definition. + +from typing import Dict, Generic, TypeVar + +import httpx + +# Generic to represent the underlying type of the data wrapped by the HTTP response. +T = TypeVar("T") + + +class BaseHttpResponse: + """Minimalist HTTP response wrapper that exposes response headers and status code.""" + + _response: httpx.Response + + def __init__(self, response: httpx.Response): + self._response = response + + @property + def headers(self) -> Dict[str, str]: + return dict(self._response.headers) + + @property + def status_code(self) -> int: + return self._response.status_code + + +class HttpResponse(Generic[T], BaseHttpResponse): + """HTTP response wrapper that exposes response headers and data.""" + + _data: T + + def __init__(self, response: httpx.Response, data: T): + super().__init__(response) + self._data = data + + @property + def data(self) -> T: + return self._data + + def close(self) -> None: + self._response.close() + + +class AsyncHttpResponse(Generic[T], BaseHttpResponse): + """HTTP response wrapper that exposes response headers and data.""" + + _data: T + + def __init__(self, response: httpx.Response, data: T): + super().__init__(response) + self._data = data + + @property + def data(self) -> T: + return self._data + + async def close(self) -> None: + await self._response.aclose() diff --git a/src/webflow/core/http_sse/__init__.py b/src/webflow/core/http_sse/__init__.py new file mode 100644 index 0000000..730e5a3 --- /dev/null +++ b/src/webflow/core/http_sse/__init__.py @@ -0,0 +1,42 @@ +# This file was auto-generated by Fern from our API Definition. + +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from ._api import EventSource, aconnect_sse, connect_sse + from ._exceptions import SSEError + from ._models import ServerSentEvent +_dynamic_imports: typing.Dict[str, str] = { + "EventSource": "._api", + "SSEError": "._exceptions", + "ServerSentEvent": "._models", + "aconnect_sse": "._api", + "connect_sse": "._api", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + + +__all__ = ["EventSource", "SSEError", "ServerSentEvent", "aconnect_sse", "connect_sse"] diff --git a/src/webflow/core/http_sse/_api.py b/src/webflow/core/http_sse/_api.py new file mode 100644 index 0000000..f900b3b --- /dev/null +++ b/src/webflow/core/http_sse/_api.py @@ -0,0 +1,112 @@ +# This file was auto-generated by Fern from our API Definition. + +import re +from contextlib import asynccontextmanager, contextmanager +from typing import Any, AsyncGenerator, AsyncIterator, Iterator, cast + +import httpx +from ._decoders import SSEDecoder +from ._exceptions import SSEError +from ._models import ServerSentEvent + + +class EventSource: + def __init__(self, response: httpx.Response) -> None: + self._response = response + + def _check_content_type(self) -> None: + content_type = self._response.headers.get("content-type", "").partition(";")[0] + if "text/event-stream" not in content_type: + raise SSEError( + f"Expected response header Content-Type to contain 'text/event-stream', got {content_type!r}" + ) + + def _get_charset(self) -> str: + """Extract charset from Content-Type header, fallback to UTF-8.""" + content_type = self._response.headers.get("content-type", "") + + # Parse charset parameter using regex + charset_match = re.search(r"charset=([^;\s]+)", content_type, re.IGNORECASE) + if charset_match: + charset = charset_match.group(1).strip("\"'") + # Validate that it's a known encoding + try: + # Test if the charset is valid by trying to encode/decode + "test".encode(charset).decode(charset) + return charset + except (LookupError, UnicodeError): + # If charset is invalid, fall back to UTF-8 + pass + + # Default to UTF-8 if no charset specified or invalid charset + return "utf-8" + + @property + def response(self) -> httpx.Response: + return self._response + + def iter_sse(self) -> Iterator[ServerSentEvent]: + self._check_content_type() + decoder = SSEDecoder() + charset = self._get_charset() + + buffer = "" + for chunk in self._response.iter_bytes(): + # Decode chunk using detected charset + text_chunk = chunk.decode(charset, errors="replace") + buffer += text_chunk + + # Process complete lines + while "\n" in buffer: + line, buffer = buffer.split("\n", 1) + line = line.rstrip("\r") + sse = decoder.decode(line) + # when we reach a "\n\n" => line = '' + # => decoder will attempt to return an SSE Event + if sse is not None: + yield sse + + # Process any remaining data in buffer + if buffer.strip(): + line = buffer.rstrip("\r") + sse = decoder.decode(line) + if sse is not None: + yield sse + + async def aiter_sse(self) -> AsyncGenerator[ServerSentEvent, None]: + self._check_content_type() + decoder = SSEDecoder() + lines = cast(AsyncGenerator[str, None], self._response.aiter_lines()) + try: + async for line in lines: + line = line.rstrip("\n") + sse = decoder.decode(line) + if sse is not None: + yield sse + finally: + await lines.aclose() + + +@contextmanager +def connect_sse(client: httpx.Client, method: str, url: str, **kwargs: Any) -> Iterator[EventSource]: + headers = kwargs.pop("headers", {}) + headers["Accept"] = "text/event-stream" + headers["Cache-Control"] = "no-store" + + with client.stream(method, url, headers=headers, **kwargs) as response: + yield EventSource(response) + + +@asynccontextmanager +async def aconnect_sse( + client: httpx.AsyncClient, + method: str, + url: str, + **kwargs: Any, +) -> AsyncIterator[EventSource]: + headers = kwargs.pop("headers", {}) + headers["Accept"] = "text/event-stream" + headers["Cache-Control"] = "no-store" + + async with client.stream(method, url, headers=headers, **kwargs) as response: + yield EventSource(response) diff --git a/src/webflow/core/http_sse/_decoders.py b/src/webflow/core/http_sse/_decoders.py new file mode 100644 index 0000000..339b089 --- /dev/null +++ b/src/webflow/core/http_sse/_decoders.py @@ -0,0 +1,61 @@ +# This file was auto-generated by Fern from our API Definition. + +from typing import List, Optional + +from ._models import ServerSentEvent + + +class SSEDecoder: + def __init__(self) -> None: + self._event = "" + self._data: List[str] = [] + self._last_event_id = "" + self._retry: Optional[int] = None + + def decode(self, line: str) -> Optional[ServerSentEvent]: + # See: https://html.spec.whatwg.org/multipage/server-sent-events.html#event-stream-interpretation # noqa: E501 + + if not line: + if not self._event and not self._data and not self._last_event_id and self._retry is None: + return None + + sse = ServerSentEvent( + event=self._event, + data="\n".join(self._data), + id=self._last_event_id, + retry=self._retry, + ) + + # NOTE: as per the SSE spec, do not reset last_event_id. + self._event = "" + self._data = [] + self._retry = None + + return sse + + if line.startswith(":"): + return None + + fieldname, _, value = line.partition(":") + + if value.startswith(" "): + value = value[1:] + + if fieldname == "event": + self._event = value + elif fieldname == "data": + self._data.append(value) + elif fieldname == "id": + if "\0" in value: + pass + else: + self._last_event_id = value + elif fieldname == "retry": + try: + self._retry = int(value) + except (TypeError, ValueError): + pass + else: + pass # Field is ignored. + + return None diff --git a/src/webflow/types/users_not_enabled.py b/src/webflow/core/http_sse/_exceptions.py similarity index 51% rename from src/webflow/types/users_not_enabled.py rename to src/webflow/core/http_sse/_exceptions.py index 05df7dc..81605a8 100644 --- a/src/webflow/types/users_not_enabled.py +++ b/src/webflow/core/http_sse/_exceptions.py @@ -1,5 +1,7 @@ # This file was auto-generated by Fern from our API Definition. -import typing +import httpx -UsersNotEnabled = typing.Optional[typing.Any] + +class SSEError(httpx.TransportError): + pass diff --git a/src/webflow/core/http_sse/_models.py b/src/webflow/core/http_sse/_models.py new file mode 100644 index 0000000..1af57f8 --- /dev/null +++ b/src/webflow/core/http_sse/_models.py @@ -0,0 +1,17 @@ +# This file was auto-generated by Fern from our API Definition. + +import json +from dataclasses import dataclass +from typing import Any, Optional + + +@dataclass(frozen=True) +class ServerSentEvent: + event: str = "message" + data: str = "" + id: str = "" + retry: Optional[int] = None + + def json(self) -> Any: + """Parse the data field as JSON.""" + return json.loads(self.data) diff --git a/src/webflow/core/jsonable_encoder.py b/src/webflow/core/jsonable_encoder.py index 1b631e9..f8beaea 100644 --- a/src/webflow/core/jsonable_encoder.py +++ b/src/webflow/core/jsonable_encoder.py @@ -17,7 +17,6 @@ from typing import Any, Callable, Dict, List, Optional, Set, Union import pydantic - from .datetime_utils import serialize_datetime from .pydantic_utilities import ( IS_PYDANTIC_V2, @@ -31,6 +30,10 @@ def jsonable_encoder(obj: Any, custom_encoder: Optional[Dict[Any, Callable[[Any], Any]]] = None) -> Any: custom_encoder = custom_encoder or {} + # Generated SDKs use Ellipsis (`...`) as the sentinel value for "OMIT". + # OMIT values should be excluded from serialized payloads. + if obj is Ellipsis: + return None if custom_encoder: if type(obj) in custom_encoder: return custom_encoder[type(obj)](obj) @@ -71,6 +74,8 @@ def jsonable_encoder(obj: Any, custom_encoder: Optional[Dict[Any, Callable[[Any] allowed_keys = set(obj.keys()) for key, value in obj.items(): if key in allowed_keys: + if value is Ellipsis: + continue encoded_key = jsonable_encoder(key, custom_encoder=custom_encoder) encoded_value = jsonable_encoder(value, custom_encoder=custom_encoder) encoded_dict[encoded_key] = encoded_value @@ -78,6 +83,8 @@ def jsonable_encoder(obj: Any, custom_encoder: Optional[Dict[Any, Callable[[Any] if isinstance(obj, (list, set, frozenset, GeneratorType, tuple)): encoded_list = [] for item in obj: + if item is Ellipsis: + continue encoded_list.append(jsonable_encoder(item, custom_encoder=custom_encoder)) return encoded_list diff --git a/src/webflow/core/logging.py b/src/webflow/core/logging.py new file mode 100644 index 0000000..e5e5724 --- /dev/null +++ b/src/webflow/core/logging.py @@ -0,0 +1,107 @@ +# This file was auto-generated by Fern from our API Definition. + +import logging +import typing + +LogLevel = typing.Literal["debug", "info", "warn", "error"] + +_LOG_LEVEL_MAP: typing.Dict[LogLevel, int] = { + "debug": 1, + "info": 2, + "warn": 3, + "error": 4, +} + + +class ILogger(typing.Protocol): + def debug(self, message: str, **kwargs: typing.Any) -> None: ... + def info(self, message: str, **kwargs: typing.Any) -> None: ... + def warn(self, message: str, **kwargs: typing.Any) -> None: ... + def error(self, message: str, **kwargs: typing.Any) -> None: ... + + +class ConsoleLogger: + _logger: logging.Logger + + def __init__(self) -> None: + self._logger = logging.getLogger("fern") + if not self._logger.handlers: + handler = logging.StreamHandler() + handler.setFormatter(logging.Formatter("%(levelname)s - %(message)s")) + self._logger.addHandler(handler) + self._logger.setLevel(logging.DEBUG) + + def debug(self, message: str, **kwargs: typing.Any) -> None: + self._logger.debug(message, extra=kwargs) + + def info(self, message: str, **kwargs: typing.Any) -> None: + self._logger.info(message, extra=kwargs) + + def warn(self, message: str, **kwargs: typing.Any) -> None: + self._logger.warning(message, extra=kwargs) + + def error(self, message: str, **kwargs: typing.Any) -> None: + self._logger.error(message, extra=kwargs) + + +class LogConfig(typing.TypedDict, total=False): + level: LogLevel + logger: ILogger + silent: bool + + +class Logger: + _level: int + _logger: ILogger + _silent: bool + + def __init__(self, *, level: LogLevel, logger: ILogger, silent: bool) -> None: + self._level = _LOG_LEVEL_MAP[level] + self._logger = logger + self._silent = silent + + def _should_log(self, level: LogLevel) -> bool: + return not self._silent and self._level <= _LOG_LEVEL_MAP[level] + + def is_debug(self) -> bool: + return self._should_log("debug") + + def is_info(self) -> bool: + return self._should_log("info") + + def is_warn(self) -> bool: + return self._should_log("warn") + + def is_error(self) -> bool: + return self._should_log("error") + + def debug(self, message: str, **kwargs: typing.Any) -> None: + if self.is_debug(): + self._logger.debug(message, **kwargs) + + def info(self, message: str, **kwargs: typing.Any) -> None: + if self.is_info(): + self._logger.info(message, **kwargs) + + def warn(self, message: str, **kwargs: typing.Any) -> None: + if self.is_warn(): + self._logger.warn(message, **kwargs) + + def error(self, message: str, **kwargs: typing.Any) -> None: + if self.is_error(): + self._logger.error(message, **kwargs) + + +_default_logger: Logger = Logger(level="info", logger=ConsoleLogger(), silent=True) + + +def create_logger(config: typing.Optional[typing.Union[LogConfig, Logger]] = None) -> Logger: + if config is None: + return _default_logger + if isinstance(config, Logger): + return config + return Logger( + level=config.get("level", "info"), + logger=config.get("logger", ConsoleLogger()), + silent=config.get("silent", True), + ) diff --git a/src/webflow/core/parse_error.py b/src/webflow/core/parse_error.py new file mode 100644 index 0000000..4527c6a --- /dev/null +++ b/src/webflow/core/parse_error.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +from typing import Any, Dict, Optional + + +class ParsingError(Exception): + """ + Raised when the SDK fails to parse/validate a response from the server. + This typically indicates that the server returned a response whose shape + does not match the expected schema. + """ + + headers: Optional[Dict[str, str]] + status_code: Optional[int] + body: Any + cause: Optional[Exception] + + def __init__( + self, + *, + headers: Optional[Dict[str, str]] = None, + status_code: Optional[int] = None, + body: Any = None, + cause: Optional[Exception] = None, + ) -> None: + self.headers = headers + self.status_code = status_code + self.body = body + self.cause = cause + super().__init__() + if cause is not None: + self.__cause__ = cause + + def __str__(self) -> str: + cause_str = f", cause: {self.cause}" if self.cause is not None else "" + return f"headers: {self.headers}, status_code: {self.status_code}, body: {self.body}{cause_str}" diff --git a/src/webflow/core/pydantic_utilities.py b/src/webflow/core/pydantic_utilities.py index ee8f0e4..831aadc 100644 --- a/src/webflow/core/pydantic_utilities.py +++ b/src/webflow/core/pydantic_utilities.py @@ -2,90 +2,349 @@ # nopycln: file import datetime as dt -import typing +import inspect +import json +import logging from collections import defaultdict +from dataclasses import asdict +from typing import ( + TYPE_CHECKING, + Any, + Callable, + ClassVar, + Dict, + List, + Mapping, + Optional, + Set, + Tuple, + Type, + TypeVar, + Union, + cast, +) +import pydantic import typing_extensions -import pydantic +_logger = logging.getLogger(__name__) -from .datetime_utils import serialize_datetime -from .serialization import convert_and_respect_annotation_metadata +if TYPE_CHECKING: + from .http_sse._models import ServerSentEvent IS_PYDANTIC_V2 = pydantic.VERSION.startswith("2.") if IS_PYDANTIC_V2: - # isort will try to reformat the comments on these imports, which breaks mypy - # isort: off - from pydantic.v1.datetime_parse import ( # type: ignore # pyright: ignore[reportMissingImports] # Pydantic v2 - parse_date as parse_date, - ) - from pydantic.v1.datetime_parse import ( # pyright: ignore[reportMissingImports] # Pydantic v2 - parse_datetime as parse_datetime, - ) - from pydantic.v1.json import ( # type: ignore # pyright: ignore[reportMissingImports] # Pydantic v2 - ENCODERS_BY_TYPE as encoders_by_type, - ) - from pydantic.v1.typing import ( # type: ignore # pyright: ignore[reportMissingImports] # Pydantic v2 - get_args as get_args, - ) - from pydantic.v1.typing import ( # pyright: ignore[reportMissingImports] # Pydantic v2 - get_origin as get_origin, - ) - from pydantic.v1.typing import ( # pyright: ignore[reportMissingImports] # Pydantic v2 - is_literal_type as is_literal_type, - ) - from pydantic.v1.typing import ( # pyright: ignore[reportMissingImports] # Pydantic v2 - is_union as is_union, - ) - from pydantic.v1.fields import ModelField as ModelField # type: ignore # pyright: ignore[reportMissingImports] # Pydantic v2 + import warnings + + _datetime_adapter = pydantic.TypeAdapter(dt.datetime) # type: ignore[attr-defined] + _date_adapter = pydantic.TypeAdapter(dt.date) # type: ignore[attr-defined] + + def parse_datetime(value: Any) -> dt.datetime: # type: ignore[misc] + if isinstance(value, dt.datetime): + return value + return _datetime_adapter.validate_python(value) + + def parse_date(value: Any) -> dt.date: # type: ignore[misc] + if isinstance(value, dt.datetime): + return value.date() + if isinstance(value, dt.date): + return value + return _date_adapter.validate_python(value) + + with warnings.catch_warnings(): + warnings.simplefilter("ignore", UserWarning) + from pydantic.v1.fields import ModelField as ModelField + from pydantic.v1.json import ENCODERS_BY_TYPE as encoders_by_type # type: ignore[attr-defined] + from pydantic.v1.typing import get_args as get_args + from pydantic.v1.typing import get_origin as get_origin + from pydantic.v1.typing import is_literal_type as is_literal_type + from pydantic.v1.typing import is_union as is_union else: - from pydantic.datetime_parse import parse_date as parse_date # type: ignore # Pydantic v1 - from pydantic.datetime_parse import parse_datetime as parse_datetime # type: ignore # Pydantic v1 - from pydantic.fields import ModelField as ModelField # type: ignore # Pydantic v1 - from pydantic.json import ENCODERS_BY_TYPE as encoders_by_type # type: ignore # Pydantic v1 - from pydantic.typing import get_args as get_args # type: ignore # Pydantic v1 - from pydantic.typing import get_origin as get_origin # type: ignore # Pydantic v1 - from pydantic.typing import is_literal_type as is_literal_type # type: ignore # Pydantic v1 - from pydantic.typing import is_union as is_union # type: ignore # Pydantic v1 - - # isort: on - - -T = typing.TypeVar("T") -Model = typing.TypeVar("Model", bound=pydantic.BaseModel) + from pydantic.datetime_parse import parse_date as parse_date # type: ignore[no-redef] + from pydantic.datetime_parse import parse_datetime as parse_datetime # type: ignore[no-redef] + from pydantic.fields import ModelField as ModelField # type: ignore[attr-defined, no-redef] + from pydantic.json import ENCODERS_BY_TYPE as encoders_by_type # type: ignore[no-redef] + from pydantic.typing import get_args as get_args # type: ignore[no-redef] + from pydantic.typing import get_origin as get_origin # type: ignore[no-redef] + from pydantic.typing import is_literal_type as is_literal_type # type: ignore[no-redef] + from pydantic.typing import is_union as is_union # type: ignore[no-redef] +from .datetime_utils import serialize_datetime +from .serialization import convert_and_respect_annotation_metadata +from typing_extensions import TypeAlias + +T = TypeVar("T") +Model = TypeVar("Model", bound=pydantic.BaseModel) + + +def _get_discriminator_and_variants(type_: Type[Any]) -> Tuple[Optional[str], Optional[List[Type[Any]]]]: + """ + Extract the discriminator field name and union variants from a discriminated union type. + Supports Annotated[Union[...], Field(discriminator=...)] patterns. + Returns (discriminator, variants) or (None, None) if not a discriminated union. + """ + origin = typing_extensions.get_origin(type_) + + if origin is typing_extensions.Annotated: + args = typing_extensions.get_args(type_) + if len(args) >= 2: + inner_type = args[0] + # Check annotations for discriminator + discriminator = None + for annotation in args[1:]: + if hasattr(annotation, "discriminator"): + discriminator = getattr(annotation, "discriminator", None) + break + + if discriminator: + inner_origin = typing_extensions.get_origin(inner_type) + if inner_origin is Union: + variants = list(typing_extensions.get_args(inner_type)) + return discriminator, variants + return None, None + + +def _get_field_annotation(model: Type[Any], field_name: str) -> Optional[Type[Any]]: + """Get the type annotation of a field from a Pydantic model.""" + if IS_PYDANTIC_V2: + fields = getattr(model, "model_fields", {}) + field_info = fields.get(field_name) + if field_info: + return cast(Optional[Type[Any]], field_info.annotation) + else: + fields = getattr(model, "__fields__", {}) + field_info = fields.get(field_name) + if field_info: + return cast(Optional[Type[Any]], field_info.outer_type_) + return None + + +def _find_variant_by_discriminator( + variants: List[Type[Any]], + discriminator: str, + discriminator_value: Any, +) -> Optional[Type[Any]]: + """Find the union variant that matches the discriminator value.""" + for variant in variants: + if not (inspect.isclass(variant) and issubclass(variant, pydantic.BaseModel)): + continue + + disc_annotation = _get_field_annotation(variant, discriminator) + if disc_annotation and is_literal_type(disc_annotation): + literal_args = get_args(disc_annotation) + if literal_args and literal_args[0] == discriminator_value: + return variant + return None + + +def _is_string_type(type_: Type[Any]) -> bool: + """Check if a type is str or Optional[str].""" + if type_ is str: + return True + + origin = typing_extensions.get_origin(type_) + if origin is Union: + args = typing_extensions.get_args(type_) + # Optional[str] = Union[str, None] + non_none_args = [a for a in args if a is not type(None)] + if len(non_none_args) == 1 and non_none_args[0] is str: + return True + + return False + + +def parse_sse_obj(sse: "ServerSentEvent", type_: Type[T]) -> T: + """ + Parse a ServerSentEvent into the appropriate type. + + Handles two scenarios based on where the discriminator field is located: + + 1. Data-level discrimination: The discriminator (e.g., 'type') is inside the 'data' payload. + The union describes the data content, not the SSE envelope. + -> Returns: json.loads(data) parsed into the type + + Example: ChatStreamResponse with discriminator='type' + Input: ServerSentEvent(event="message", data='{"type": "content-delta", ...}', id="") + Output: ContentDeltaEvent (parsed from data, SSE envelope stripped) + + 2. Event-level discrimination: The discriminator (e.g., 'event') is at the SSE event level. + The union describes the full SSE event structure. + -> Returns: SSE envelope with 'data' field JSON-parsed only if the variant expects non-string + + Example: JobStreamResponse with discriminator='event' + Input: ServerSentEvent(event="ERROR", data='{"code": "FAILED", ...}', id="123") + Output: JobStreamResponse_Error with data as ErrorData object + + But for variants where data is str (like STATUS_UPDATE): + Input: ServerSentEvent(event="STATUS_UPDATE", data='{"status": "processing"}', id="1") + Output: JobStreamResponse_StatusUpdate with data as string (not parsed) + + Args: + sse: The ServerSentEvent object to parse + type_: The target discriminated union type + + Returns: + The parsed object of type T + + Note: + This function is only available in SDK contexts where http_sse module exists. + """ + sse_event = asdict(sse) + discriminator, variants = _get_discriminator_and_variants(type_) + + if discriminator is None or variants is None: + # Not a discriminated union - parse the data field as JSON + data_value = sse_event.get("data") + if isinstance(data_value, str) and data_value: + try: + parsed_data = json.loads(data_value) + return parse_obj_as(type_, parsed_data) + except json.JSONDecodeError as e: + _logger.warning( + "Failed to parse SSE data field as JSON: %s, data: %s", + e, + data_value[:100] if len(data_value) > 100 else data_value, + ) + return parse_obj_as(type_, sse_event) + + data_value = sse_event.get("data") + + # Check if discriminator is at the top level (event-level discrimination) + if discriminator in sse_event: + # Case 2: Event-level discrimination + # Find the matching variant to check if 'data' field needs JSON parsing + disc_value = sse_event.get(discriminator) + matching_variant = _find_variant_by_discriminator(variants, discriminator, disc_value) + + if matching_variant is not None: + # Check what type the variant expects for 'data' + data_type = _get_field_annotation(matching_variant, "data") + if data_type is not None and not _is_string_type(data_type): + # Variant expects non-string data - parse JSON + if isinstance(data_value, str) and data_value: + try: + parsed_data = json.loads(data_value) + new_object = dict(sse_event) + new_object["data"] = parsed_data + return parse_obj_as(type_, new_object) + except json.JSONDecodeError as e: + _logger.warning( + "Failed to parse SSE data field as JSON for event-level discrimination: %s, data: %s", + e, + data_value[:100] if len(data_value) > 100 else data_value, + ) + # Either no matching variant, data is string type, or JSON parse failed + return parse_obj_as(type_, sse_event) -def parse_obj_as(type_: typing.Type[T], object_: typing.Any) -> T: - dealiased_object = convert_and_respect_annotation_metadata(object_=object_, annotation=type_, direction="read") + else: + # Case 1: Data-level discrimination + # The discriminator is inside the data payload - extract and parse data only + if isinstance(data_value, str) and data_value: + try: + parsed_data = json.loads(data_value) + return parse_obj_as(type_, parsed_data) + except json.JSONDecodeError as e: + _logger.warning( + "Failed to parse SSE data field as JSON for data-level discrimination: %s, data: %s", + e, + data_value[:100] if len(data_value) > 100 else data_value, + ) + return parse_obj_as(type_, sse_event) + + +def parse_obj_as(type_: Type[T], object_: Any) -> T: + # convert_and_respect_annotation_metadata is required for TypedDict aliasing. + # + # For Pydantic models, whether we should pre-dealias depends on how the model encodes aliasing: + # - If the model uses real Pydantic aliases (pydantic.Field(alias=...)), then we must pass wire keys through + # unchanged so Pydantic can validate them. + # - If the model encodes aliasing only via FieldMetadata annotations, then we MUST pre-dealias because Pydantic + # will not recognize those aliases during validation. + if inspect.isclass(type_) and issubclass(type_, pydantic.BaseModel): + has_pydantic_aliases = False + if IS_PYDANTIC_V2: + for field_name, field_info in getattr(type_, "model_fields", {}).items(): # type: ignore[attr-defined] + alias = getattr(field_info, "alias", None) + if alias is not None and alias != field_name: + has_pydantic_aliases = True + break + else: + for field in getattr(type_, "__fields__", {}).values(): + alias = getattr(field, "alias", None) + name = getattr(field, "name", None) + if alias is not None and name is not None and alias != name: + has_pydantic_aliases = True + break + + dealiased_object = ( + object_ + if has_pydantic_aliases + else convert_and_respect_annotation_metadata(object_=object_, annotation=type_, direction="read") + ) + else: + dealiased_object = convert_and_respect_annotation_metadata(object_=object_, annotation=type_, direction="read") if IS_PYDANTIC_V2: - adapter = pydantic.TypeAdapter(type_) # type: ignore # Pydantic v2 + adapter = pydantic.TypeAdapter(type_) # type: ignore[attr-defined] return adapter.validate_python(dealiased_object) - else: - return pydantic.parse_obj_as(type_, dealiased_object) + return pydantic.parse_obj_as(type_, dealiased_object) -def to_jsonable_with_fallback( - obj: typing.Any, fallback_serializer: typing.Callable[[typing.Any], typing.Any] -) -> typing.Any: +def to_jsonable_with_fallback(obj: Any, fallback_serializer: Callable[[Any], Any]) -> Any: if IS_PYDANTIC_V2: from pydantic_core import to_jsonable_python return to_jsonable_python(obj, fallback=fallback_serializer) - else: - return fallback_serializer(obj) + return fallback_serializer(obj) class UniversalBaseModel(pydantic.BaseModel): if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict( - # Allow fields begining with `model_` to be used in the model + model_config: ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict( # type: ignore[typeddict-unknown-key] + # Allow fields beginning with `model_` to be used in the model protected_namespaces=(), - ) # type: ignore # Pydantic v2 - - @pydantic.model_serializer(mode="wrap", when_used="json") # type: ignore # Pydantic v2 - def serialize_model(self, handler: pydantic.SerializerFunctionWrapHandler) -> typing.Any: # type: ignore # Pydantic v2 - serialized = handler(self) + ) + + @pydantic.model_validator(mode="before") # type: ignore[attr-defined] + @classmethod + def _coerce_field_names_to_aliases(cls, data: Any) -> Any: + """ + Accept Python field names in input by rewriting them to their Pydantic aliases, + while avoiding silent collisions when a key could refer to multiple fields. + """ + if not isinstance(data, Mapping): + return data + + fields = getattr(cls, "model_fields", {}) # type: ignore[attr-defined] + name_to_alias: Dict[str, str] = {} + alias_to_name: Dict[str, str] = {} + + for name, field_info in fields.items(): + alias = getattr(field_info, "alias", None) or name + name_to_alias[name] = alias + if alias != name: + alias_to_name[alias] = name + + # Detect ambiguous keys: a key that is an alias for one field and a name for another. + ambiguous_keys = set(alias_to_name.keys()).intersection(set(name_to_alias.keys())) + for key in ambiguous_keys: + if key in data and name_to_alias[key] not in data: + raise ValueError( + f"Ambiguous input key '{key}': it is both a field name and an alias. " + "Provide the explicit alias key to disambiguate." + ) + + original_keys = set(data.keys()) + rewritten: Dict[str, Any] = dict(data) + for name, alias in name_to_alias.items(): + if alias != name and name in original_keys and alias not in rewritten: + rewritten[alias] = rewritten.pop(name) + + return rewritten + + @pydantic.model_serializer(mode="plain", when_used="json") # type: ignore[attr-defined] + def serialize_model(self) -> Any: # type: ignore[name-defined] + serialized = self.dict() # type: ignore[attr-defined] data = {k: serialize_datetime(v) if isinstance(v, dt.datetime) else v for k, v in serialized.items()} return data @@ -95,60 +354,88 @@ class Config: smart_union = True json_encoders = {dt.datetime: serialize_datetime} + @pydantic.root_validator(pre=True) + def _coerce_field_names_to_aliases(cls, values: Any) -> Any: + """ + Pydantic v1 equivalent of _coerce_field_names_to_aliases. + """ + if not isinstance(values, Mapping): + return values + + fields = getattr(cls, "__fields__", {}) + name_to_alias: Dict[str, str] = {} + alias_to_name: Dict[str, str] = {} + + for name, field in fields.items(): + alias = getattr(field, "alias", None) or name + name_to_alias[name] = alias + if alias != name: + alias_to_name[alias] = name + + ambiguous_keys = set(alias_to_name.keys()).intersection(set(name_to_alias.keys())) + for key in ambiguous_keys: + if key in values and name_to_alias[key] not in values: + raise ValueError( + f"Ambiguous input key '{key}': it is both a field name and an alias. " + "Provide the explicit alias key to disambiguate." + ) + + original_keys = set(values.keys()) + rewritten: Dict[str, Any] = dict(values) + for name, alias in name_to_alias.items(): + if alias != name and name in original_keys and alias not in rewritten: + rewritten[alias] = rewritten.pop(name) + + return rewritten + @classmethod - def model_construct( - cls: typing.Type["Model"], _fields_set: typing.Optional[typing.Set[str]] = None, **values: typing.Any - ) -> "Model": + def model_construct(cls: Type["Model"], _fields_set: Optional[Set[str]] = None, **values: Any) -> "Model": dealiased_object = convert_and_respect_annotation_metadata(object_=values, annotation=cls, direction="read") return cls.construct(_fields_set, **dealiased_object) @classmethod - def construct( - cls: typing.Type["Model"], _fields_set: typing.Optional[typing.Set[str]] = None, **values: typing.Any - ) -> "Model": + def construct(cls: Type["Model"], _fields_set: Optional[Set[str]] = None, **values: Any) -> "Model": dealiased_object = convert_and_respect_annotation_metadata(object_=values, annotation=cls, direction="read") if IS_PYDANTIC_V2: - return super().model_construct(_fields_set, **dealiased_object) # type: ignore # Pydantic v2 - else: - return super().construct(_fields_set, **dealiased_object) + return super().model_construct(_fields_set, **dealiased_object) # type: ignore[misc] + return super().construct(_fields_set, **dealiased_object) - def json(self, **kwargs: typing.Any) -> str: - kwargs_with_defaults: typing.Any = { + def json(self, **kwargs: Any) -> str: + kwargs_with_defaults = { "by_alias": True, "exclude_unset": True, **kwargs, } if IS_PYDANTIC_V2: - return super().model_dump_json(**kwargs_with_defaults) # type: ignore # Pydantic v2 - else: - return super().json(**kwargs_with_defaults) + return super().model_dump_json(**kwargs_with_defaults) # type: ignore[misc] + return super().json(**kwargs_with_defaults) - def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]: + def dict(self, **kwargs: Any) -> Dict[str, Any]: """ Override the default dict method to `exclude_unset` by default. This function patches `exclude_unset` to work include fields within non-None default values. """ - # Note: the logic here is multi-plexed given the levers exposed in Pydantic V1 vs V2 + # Note: the logic here is multiplexed given the levers exposed in Pydantic V1 vs V2 # Pydantic V1's .dict can be extremely slow, so we do not want to call it twice. # # We'd ideally do the same for Pydantic V2, but it shells out to a library to serialize models # that we have less control over, and this is less intrusive than custom serializers for now. if IS_PYDANTIC_V2: - kwargs_with_defaults_exclude_unset: typing.Any = { + kwargs_with_defaults_exclude_unset = { **kwargs, "by_alias": True, "exclude_unset": True, "exclude_none": False, } - kwargs_with_defaults_exclude_none: typing.Any = { + kwargs_with_defaults_exclude_none = { **kwargs, "by_alias": True, "exclude_none": True, "exclude_unset": False, } dict_dump = deep_union_pydantic_dicts( - super().model_dump(**kwargs_with_defaults_exclude_unset), # type: ignore # Pydantic v2 - super().model_dump(**kwargs_with_defaults_exclude_none), # type: ignore # Pydantic v2 + super().model_dump(**kwargs_with_defaults_exclude_unset), # type: ignore[misc] + super().model_dump(**kwargs_with_defaults_exclude_none), # type: ignore[misc] ) else: @@ -168,7 +455,7 @@ def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]: if default is not None: self.__fields_set__.add(name) - kwargs_with_defaults_exclude_unset_include_fields: typing.Any = { + kwargs_with_defaults_exclude_unset_include_fields = { "by_alias": True, "exclude_unset": True, "include": _fields_set, @@ -177,15 +464,16 @@ def dict(self, **kwargs: typing.Any) -> typing.Dict[str, typing.Any]: dict_dump = super().dict(**kwargs_with_defaults_exclude_unset_include_fields) - return convert_and_respect_annotation_metadata(object_=dict_dump, annotation=self.__class__, direction="write") + return cast( + Dict[str, Any], + convert_and_respect_annotation_metadata(object_=dict_dump, annotation=self.__class__, direction="write"), + ) -def _union_list_of_pydantic_dicts( - source: typing.List[typing.Any], destination: typing.List[typing.Any] -) -> typing.List[typing.Any]: - converted_list: typing.List[typing.Any] = [] +def _union_list_of_pydantic_dicts(source: List[Any], destination: List[Any]) -> List[Any]: + converted_list: List[Any] = [] for i, item in enumerate(source): - destination_value = destination[i] # type: ignore + destination_value = destination[i] if isinstance(item, dict): converted_list.append(deep_union_pydantic_dicts(item, destination_value)) elif isinstance(item, list): @@ -195,9 +483,7 @@ def _union_list_of_pydantic_dicts( return converted_list -def deep_union_pydantic_dicts( - source: typing.Dict[str, typing.Any], destination: typing.Dict[str, typing.Any] -) -> typing.Dict[str, typing.Any]: +def deep_union_pydantic_dicts(source: Dict[str, Any], destination: Dict[str, Any]) -> Dict[str, Any]: for key, value in source.items(): node = destination.setdefault(key, {}) if isinstance(value, dict): @@ -215,18 +501,16 @@ def deep_union_pydantic_dicts( if IS_PYDANTIC_V2: - class V2RootModel(UniversalBaseModel, pydantic.RootModel): # type: ignore # Pydantic v2 + class V2RootModel(UniversalBaseModel, pydantic.RootModel): # type: ignore[misc, name-defined, type-arg] pass - UniversalRootModel: typing_extensions.TypeAlias = V2RootModel # type: ignore + UniversalRootModel: TypeAlias = V2RootModel # type: ignore[misc] else: - UniversalRootModel: typing_extensions.TypeAlias = UniversalBaseModel # type: ignore + UniversalRootModel: TypeAlias = UniversalBaseModel # type: ignore[misc, no-redef] -def encode_by_type(o: typing.Any) -> typing.Any: - encoders_by_class_tuples: typing.Dict[typing.Callable[[typing.Any], typing.Any], typing.Tuple[typing.Any, ...]] = ( - defaultdict(tuple) - ) +def encode_by_type(o: Any) -> Any: + encoders_by_class_tuples: Dict[Callable[[Any], Any], Tuple[Any, ...]] = defaultdict(tuple) for type_, encoder in encoders_by_type.items(): encoders_by_class_tuples[encoder] += (type_,) @@ -237,54 +521,51 @@ def encode_by_type(o: typing.Any) -> typing.Any: return encoder(o) -def update_forward_refs(model: typing.Type["Model"], **localns: typing.Any) -> None: +def update_forward_refs(model: Type["Model"], **localns: Any) -> None: if IS_PYDANTIC_V2: - model.model_rebuild(raise_errors=False) # type: ignore # Pydantic v2 + model.model_rebuild(raise_errors=False) # type: ignore[attr-defined] else: model.update_forward_refs(**localns) # Mirrors Pydantic's internal typing -AnyCallable = typing.Callable[..., typing.Any] +AnyCallable = Callable[..., Any] def universal_root_validator( pre: bool = False, -) -> typing.Callable[[AnyCallable], AnyCallable]: +) -> Callable[[AnyCallable], AnyCallable]: def decorator(func: AnyCallable) -> AnyCallable: if IS_PYDANTIC_V2: - return pydantic.model_validator(mode="before" if pre else "after")(func) # type: ignore # Pydantic v2 - else: - return pydantic.root_validator(pre=pre)(func) # type: ignore # Pydantic v1 + # In Pydantic v2, for RootModel we always use "before" mode + # The custom validators transform the input value before the model is created + return cast(AnyCallable, pydantic.model_validator(mode="before")(func)) # type: ignore[attr-defined] + return cast(AnyCallable, pydantic.root_validator(pre=pre)(func)) # type: ignore[call-overload] return decorator -def universal_field_validator(field_name: str, pre: bool = False) -> typing.Callable[[AnyCallable], AnyCallable]: +def universal_field_validator(field_name: str, pre: bool = False) -> Callable[[AnyCallable], AnyCallable]: def decorator(func: AnyCallable) -> AnyCallable: if IS_PYDANTIC_V2: - return pydantic.field_validator(field_name, mode="before" if pre else "after")(func) # type: ignore # Pydantic v2 - else: - return pydantic.validator(field_name, pre=pre)(func) # type: ignore # Pydantic v1 + return cast(AnyCallable, pydantic.field_validator(field_name, mode="before" if pre else "after")(func)) # type: ignore[attr-defined] + return cast(AnyCallable, pydantic.validator(field_name, pre=pre)(func)) return decorator -PydanticField = typing.Union[ModelField, pydantic.fields.FieldInfo] +PydanticField = Union[ModelField, pydantic.fields.FieldInfo] -def _get_model_fields( - model: typing.Type["Model"], -) -> typing.Mapping[str, PydanticField]: +def _get_model_fields(model: Type["Model"]) -> Mapping[str, PydanticField]: if IS_PYDANTIC_V2: - return model.model_fields # type: ignore # Pydantic v2 - else: - return model.__fields__ # type: ignore # Pydantic v1 + return cast(Mapping[str, PydanticField], model.model_fields) # type: ignore[attr-defined] + return cast(Mapping[str, PydanticField], model.__fields__) -def _get_field_default(field: PydanticField) -> typing.Any: +def _get_field_default(field: PydanticField) -> Any: try: - value = field.get_default() # type: ignore # Pydantic < v1.10.15 + value = field.get_default() # type: ignore[union-attr] except: value = field.default if IS_PYDANTIC_V2: diff --git a/src/webflow/core/serialization.py b/src/webflow/core/serialization.py index cb5dcbf..c36e865 100644 --- a/src/webflow/core/serialization.py +++ b/src/webflow/core/serialization.py @@ -4,9 +4,8 @@ import inspect import typing -import typing_extensions - import pydantic +import typing_extensions class FieldMetadata: @@ -161,7 +160,12 @@ def _convert_mapping( direction: typing.Literal["read", "write"], ) -> typing.Mapping[str, object]: converted_object: typing.Dict[str, object] = {} - annotations = typing_extensions.get_type_hints(expected_type, include_extras=True) + try: + annotations = typing_extensions.get_type_hints(expected_type, include_extras=True) + except NameError: + # The TypedDict contains a circular reference, so + # we use the __annotations__ attribute directly. + annotations = getattr(expected_type, "__annotations__", {}) aliases_to_field_names = _get_alias_to_field_name(annotations) for key, value in object_.items(): if direction == "read" and key in aliases_to_field_names: diff --git a/src/webflow/environment.py b/src/webflow/environment.py index ed0e03d..07a5c81 100644 --- a/src/webflow/environment.py +++ b/src/webflow/environment.py @@ -1,7 +1,19 @@ # This file was auto-generated by Fern from our API Definition. -import enum +from __future__ import annotations -class WebflowEnvironment(enum.Enum): - DEFAULT = "https://api.webflow.com/v2" +class WebflowEnvironment: + DATA_API: WebflowEnvironment + + def __init__(self, *, base: str, data_api: str, content_delivery_api: str): + self.base = base + self.data_api = data_api + self.content_delivery_api = content_delivery_api + + +WebflowEnvironment.DATA_API = WebflowEnvironment( + base="https://api.webflow.com/v2", + data_api="https://api.webflow.com/v2", + content_delivery_api="https://api-cdn.webflow.com/v2", +) diff --git a/src/webflow/errors/__init__.py b/src/webflow/errors/__init__.py index 3b6de05..bd5f618 100644 --- a/src/webflow/errors/__init__.py +++ b/src/webflow/errors/__init__.py @@ -1,12 +1,49 @@ # This file was auto-generated by Fern from our API Definition. -from .bad_request_error import BadRequestError -from .conflict_error import ConflictError -from .forbidden_error import ForbiddenError -from .internal_server_error import InternalServerError -from .not_found_error import NotFoundError -from .too_many_requests_error import TooManyRequestsError -from .unauthorized_error import UnauthorizedError +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .bad_request_error import BadRequestError + from .conflict_error import ConflictError + from .forbidden_error import ForbiddenError + from .internal_server_error import InternalServerError + from .not_found_error import NotFoundError + from .too_many_requests_error import TooManyRequestsError + from .unauthorized_error import UnauthorizedError +_dynamic_imports: typing.Dict[str, str] = { + "BadRequestError": ".bad_request_error", + "ConflictError": ".conflict_error", + "ForbiddenError": ".forbidden_error", + "InternalServerError": ".internal_server_error", + "NotFoundError": ".not_found_error", + "TooManyRequestsError": ".too_many_requests_error", + "UnauthorizedError": ".unauthorized_error", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + __all__ = [ "BadRequestError", diff --git a/src/webflow/errors/bad_request_error.py b/src/webflow/errors/bad_request_error.py index 9c13c61..ec78e26 100644 --- a/src/webflow/errors/bad_request_error.py +++ b/src/webflow/errors/bad_request_error.py @@ -1,9 +1,10 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.api_error import ApiError import typing +from ..core.api_error import ApiError + class BadRequestError(ApiError): - def __init__(self, body: typing.Optional[typing.Any]): - super().__init__(status_code=400, body=body) + def __init__(self, body: typing.Any, headers: typing.Optional[typing.Dict[str, str]] = None): + super().__init__(status_code=400, headers=headers, body=body) diff --git a/src/webflow/errors/conflict_error.py b/src/webflow/errors/conflict_error.py index 666bd2b..be04e01 100644 --- a/src/webflow/errors/conflict_error.py +++ b/src/webflow/errors/conflict_error.py @@ -1,9 +1,10 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.api_error import ApiError import typing +from ..core.api_error import ApiError + class ConflictError(ApiError): - def __init__(self, body: typing.Optional[typing.Any]): - super().__init__(status_code=409, body=body) + def __init__(self, body: typing.Any, headers: typing.Optional[typing.Dict[str, str]] = None): + super().__init__(status_code=409, headers=headers, body=body) diff --git a/src/webflow/errors/forbidden_error.py b/src/webflow/errors/forbidden_error.py index d17eb4b..07d7e45 100644 --- a/src/webflow/errors/forbidden_error.py +++ b/src/webflow/errors/forbidden_error.py @@ -1,9 +1,10 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.api_error import ApiError import typing +from ..core.api_error import ApiError + class ForbiddenError(ApiError): - def __init__(self, body: typing.Optional[typing.Any]): - super().__init__(status_code=403, body=body) + def __init__(self, body: typing.Any, headers: typing.Optional[typing.Dict[str, str]] = None): + super().__init__(status_code=403, headers=headers, body=body) diff --git a/src/webflow/errors/internal_server_error.py b/src/webflow/errors/internal_server_error.py index c5dcb4a..2c41ca5 100644 --- a/src/webflow/errors/internal_server_error.py +++ b/src/webflow/errors/internal_server_error.py @@ -1,9 +1,11 @@ # This file was auto-generated by Fern from our API Definition. +import typing + from ..core.api_error import ApiError from ..types.error import Error class InternalServerError(ApiError): - def __init__(self, body: Error): - super().__init__(status_code=500, body=body) + def __init__(self, body: Error, headers: typing.Optional[typing.Dict[str, str]] = None): + super().__init__(status_code=500, headers=headers, body=body) diff --git a/src/webflow/errors/not_found_error.py b/src/webflow/errors/not_found_error.py index 307aa67..e7ed720 100644 --- a/src/webflow/errors/not_found_error.py +++ b/src/webflow/errors/not_found_error.py @@ -1,9 +1,11 @@ # This file was auto-generated by Fern from our API Definition. +import typing + from ..core.api_error import ApiError from ..types.error import Error class NotFoundError(ApiError): - def __init__(self, body: Error): - super().__init__(status_code=404, body=body) + def __init__(self, body: Error, headers: typing.Optional[typing.Dict[str, str]] = None): + super().__init__(status_code=404, headers=headers, body=body) diff --git a/src/webflow/errors/too_many_requests_error.py b/src/webflow/errors/too_many_requests_error.py index c2b3b10..a0743ee 100644 --- a/src/webflow/errors/too_many_requests_error.py +++ b/src/webflow/errors/too_many_requests_error.py @@ -1,9 +1,11 @@ # This file was auto-generated by Fern from our API Definition. +import typing + from ..core.api_error import ApiError from ..types.error import Error class TooManyRequestsError(ApiError): - def __init__(self, body: Error): - super().__init__(status_code=429, body=body) + def __init__(self, body: Error, headers: typing.Optional[typing.Dict[str, str]] = None): + super().__init__(status_code=429, headers=headers, body=body) diff --git a/src/webflow/errors/unauthorized_error.py b/src/webflow/errors/unauthorized_error.py index bba82e4..2345489 100644 --- a/src/webflow/errors/unauthorized_error.py +++ b/src/webflow/errors/unauthorized_error.py @@ -1,9 +1,11 @@ # This file was auto-generated by Fern from our API Definition. +import typing + from ..core.api_error import ApiError from ..types.error import Error class UnauthorizedError(ApiError): - def __init__(self, body: Error): - super().__init__(status_code=401, body=body) + def __init__(self, body: Error, headers: typing.Optional[typing.Dict[str, str]] = None): + super().__init__(status_code=401, headers=headers, body=body) diff --git a/src/webflow/resources/__init__.py b/src/webflow/resources/__init__.py index 9122eee..7eea249 100644 --- a/src/webflow/resources/__init__.py +++ b/src/webflow/resources/__init__.py @@ -1,52 +1,115 @@ # This file was auto-generated by Fern from our API Definition. -from . import ( - access_groups, - assets, - collections, - components, - ecommerce, - forms, - inventory, - orders, - pages, - products, - scripts, - sites, - token, - users, - webhooks, -) -from .access_groups import AccessGroupsListRequestSort -from .components import ( - ComponentDomWriteNodesItem, - ComponentPropertiesWritePropertiesItem, - ComponentsUpdateContentResponse, - ComponentsUpdatePropertiesResponse, -) -from .inventory import InventoryUpdateRequestInventoryType -from .orders import OrdersListRequestStatus, OrdersRefundRequestReason -from .pages import PageDomWriteNodesItem, UpdateStaticContentResponse -from .products import ProductsCreateSkuResponse -from .sites import SitesPublishResponse -from .users import UsersListRequestSort, UsersUpdateRequestData +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from . import ( + assets, + collections, + components, + ecommerce, + forms, + inventory, + orders, + pages, + products, + scripts, + sites, + token, + webhooks, + workspaces, + ) + from .components import ( + ComponentDomWriteNodesItem, + ComponentPropertiesWritePropertiesItem, + ComponentsUpdateContentResponse, + ComponentsUpdatePropertiesResponse, + ) + from .inventory import EcommInventoryChangedPayload, InventoryUpdateRequestInventoryType + from .orders import OrdersListRequestStatus, OrdersRefundRequestReason + from .pages import ( + PageDomWriteNodesItem, + PageMetadataWriteOpenGraph, + PageMetadataWriteSeo, + UpdateStaticContentResponse, + ) + from .products import ProductSkuCreateProduct, ProductSkuCreateSku, ProductsCreateSkuResponse + from .sites import SitesPublishResponse +_dynamic_imports: typing.Dict[str, str] = { + "ComponentDomWriteNodesItem": ".components", + "ComponentPropertiesWritePropertiesItem": ".components", + "ComponentsUpdateContentResponse": ".components", + "ComponentsUpdatePropertiesResponse": ".components", + "EcommInventoryChangedPayload": ".inventory", + "InventoryUpdateRequestInventoryType": ".inventory", + "OrdersListRequestStatus": ".orders", + "OrdersRefundRequestReason": ".orders", + "PageDomWriteNodesItem": ".pages", + "PageMetadataWriteOpenGraph": ".pages", + "PageMetadataWriteSeo": ".pages", + "ProductSkuCreateProduct": ".products", + "ProductSkuCreateSku": ".products", + "ProductsCreateSkuResponse": ".products", + "SitesPublishResponse": ".sites", + "UpdateStaticContentResponse": ".pages", + "assets": ".assets", + "collections": ".collections", + "components": ".components", + "ecommerce": ".ecommerce", + "forms": ".forms", + "inventory": ".inventory", + "orders": ".orders", + "pages": ".pages", + "products": ".products", + "scripts": ".scripts", + "sites": ".sites", + "token": ".token", + "webhooks": ".webhooks", + "workspaces": ".workspaces", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + __all__ = [ - "AccessGroupsListRequestSort", "ComponentDomWriteNodesItem", "ComponentPropertiesWritePropertiesItem", "ComponentsUpdateContentResponse", "ComponentsUpdatePropertiesResponse", + "EcommInventoryChangedPayload", "InventoryUpdateRequestInventoryType", "OrdersListRequestStatus", "OrdersRefundRequestReason", "PageDomWriteNodesItem", + "PageMetadataWriteOpenGraph", + "PageMetadataWriteSeo", + "ProductSkuCreateProduct", + "ProductSkuCreateSku", "ProductsCreateSkuResponse", "SitesPublishResponse", "UpdateStaticContentResponse", - "UsersListRequestSort", - "UsersUpdateRequestData", - "access_groups", "assets", "collections", "components", @@ -59,6 +122,6 @@ "scripts", "sites", "token", - "users", "webhooks", + "workspaces", ] diff --git a/src/webflow/resources/access_groups/__init__.py b/src/webflow/resources/access_groups/__init__.py deleted file mode 100644 index b46e2ae..0000000 --- a/src/webflow/resources/access_groups/__init__.py +++ /dev/null @@ -1,5 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from .types import AccessGroupsListRequestSort - -__all__ = ["AccessGroupsListRequestSort"] diff --git a/src/webflow/resources/access_groups/types/__init__.py b/src/webflow/resources/access_groups/types/__init__.py deleted file mode 100644 index e721e22..0000000 --- a/src/webflow/resources/access_groups/types/__init__.py +++ /dev/null @@ -1,5 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from .access_groups_list_request_sort import AccessGroupsListRequestSort - -__all__ = ["AccessGroupsListRequestSort"] diff --git a/src/webflow/resources/access_groups/types/access_groups_list_request_sort.py b/src/webflow/resources/access_groups/types/access_groups_list_request_sort.py deleted file mode 100644 index 074583a..0000000 --- a/src/webflow/resources/access_groups/types/access_groups_list_request_sort.py +++ /dev/null @@ -1,5 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -AccessGroupsListRequestSort = typing.Union[typing.Literal["CreatedOn", "-CreatedOn"], typing.Any] diff --git a/src/webflow/resources/assets/__init__.py b/src/webflow/resources/assets/__init__.py index f3ea265..5cde020 100644 --- a/src/webflow/resources/assets/__init__.py +++ b/src/webflow/resources/assets/__init__.py @@ -1,2 +1,4 @@ # This file was auto-generated by Fern from our API Definition. +# isort: skip_file + diff --git a/src/webflow/resources/assets/client.py b/src/webflow/resources/assets/client.py index 61e141a..ae22ab4 100644 --- a/src/webflow/resources/assets/client.py +++ b/src/webflow/resources/assets/client.py @@ -1,24 +1,15 @@ # This file was auto-generated by Fern from our API Definition. import typing -from ...core.client_wrapper import SyncClientWrapper + +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ...core.request_options import RequestOptions -from ...types.assets import Assets -from ...core.jsonable_encoder import jsonable_encoder -from ...core.pydantic_utilities import parse_obj_as -from ...errors.bad_request_error import BadRequestError -from ...errors.unauthorized_error import UnauthorizedError -from ...types.error import Error -from ...errors.not_found_error import NotFoundError -from ...errors.too_many_requests_error import TooManyRequestsError -from ...errors.internal_server_error import InternalServerError -from json.decoder import JSONDecodeError -from ...core.api_error import ApiError -from ...types.asset_upload import AssetUpload from ...types.asset import Asset -from ...types.asset_folder_list import AssetFolderList from ...types.asset_folder import AssetFolder -from ...core.client_wrapper import AsyncClientWrapper +from ...types.asset_folder_list import AssetFolderList +from ...types.asset_upload import AssetUpload +from ...types.assets import Assets +from .raw_client import AsyncRawAssetsClient, RawAssetsClient # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) @@ -26,11 +17,29 @@ class AssetsClient: def __init__(self, *, client_wrapper: SyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = RawAssetsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawAssetsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawAssetsClient + """ + return self._raw_client - def list(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Assets: + def list( + self, + site_id: str, + *, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> Assets: """ - List assets for a given site + List of assets uploaded to a site Required scope | `assets:read` @@ -39,6 +48,12 @@ def list(self, site_id: str, *, request_options: typing.Optional[RequestOptions] site_id : str Unique identifier for a Site + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -56,76 +71,12 @@ def list(self, site_id: str, *, request_options: typing.Optional[RequestOptions] ) client.assets.list( site_id="580e63e98c9a982ac9b8b741", + offset=1, + limit=1, ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/assets", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Assets, - parse_obj_as( - type_=Assets, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.list(site_id, offset=offset, limit=limit, request_options=request_options) + return _response.data def create( self, @@ -137,15 +88,18 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> AssetUpload: """ - Create a new asset entry. + The first step in uploading an asset to a site. This endpoint generates a response with the following information: `uploadUrl` and `uploadDetails`. - You can use these two properties to [upload the file to Amazon s3 by making a POST](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html) - request to the `uploadUrl` with the `uploadDetails` object as your header information in the request. - Required scope | `assets:write` + Use these properties in the header of a [POST request to Amazson s3](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html) to complete the upload. + + + To learn more about how to upload assets to Webflow, see our [assets guide](/data/docs/working-with-assets). + + Required scope | `assets:write` Parameters ---------- @@ -182,87 +136,18 @@ def create( file_hash="3c7d87c9575702bc3b1e991f4d3c638e", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/assets", - method="POST", - json={ - "fileName": file_name, - "fileHash": file_hash, - "parentFolder": parent_folder, - }, - headers={ - "content-type": "application/json", - }, + _response = self._raw_client.create( + site_id, + file_name=file_name, + file_hash=file_hash, + parent_folder=parent_folder, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - AssetUpload, - parse_obj_as( - type_=AssetUpload, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def get(self, asset_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Asset: """ - Get an Asset + Get details about an asset Required scope | `assets:read` @@ -290,74 +175,8 @@ def get(self, asset_id: str, *, request_options: typing.Optional[RequestOptions] asset_id="580e63fc8c9a982ac9b8b745", ) """ - _response = self._client_wrapper.httpx_client.request( - f"assets/{jsonable_encoder(asset_id)}", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Asset, - parse_obj_as( - type_=Asset, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.get(asset_id, request_options=request_options) + return _response.data def delete(self, asset_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ @@ -388,68 +207,8 @@ def delete(self, asset_id: str, *, request_options: typing.Optional[RequestOptio asset_id="580e63fc8c9a982ac9b8b745", ) """ - _response = self._client_wrapper.httpx_client.request( - f"assets/{jsonable_encoder(asset_id)}", - method="DELETE", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.delete(asset_id, request_options=request_options) + return _response.data def update( self, @@ -460,7 +219,7 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> Asset: """ - Update an Asset + Update details of an Asset. Required scope | `assets:write` @@ -494,82 +253,10 @@ def update( asset_id="580e63fc8c9a982ac9b8b745", ) """ - _response = self._client_wrapper.httpx_client.request( - f"assets/{jsonable_encoder(asset_id)}", - method="PATCH", - json={ - "localeId": locale_id, - "displayName": display_name, - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, + _response = self._raw_client.update( + asset_id, locale_id=locale_id, display_name=display_name, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Asset, - parse_obj_as( - type_=Asset, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def list_folders(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> AssetFolderList: """ @@ -601,74 +288,8 @@ def list_folders(self, site_id: str, *, request_options: typing.Optional[Request site_id="580e63e98c9a982ac9b8b741", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/asset_folders", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - AssetFolderList, - parse_obj_as( - type_=AssetFolderList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.list_folders(site_id, request_options=request_options) + return _response.data def create_folder( self, @@ -714,82 +335,10 @@ def create_folder( display_name="my asset folder", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/asset_folders", - method="POST", - json={ - "displayName": display_name, - "parentFolder": parent_folder, - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, + _response = self._raw_client.create_folder( + site_id, display_name=display_name, parent_folder=parent_folder, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - AssetFolder, - parse_obj_as( - type_=AssetFolder, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def get_folder( self, asset_folder_id: str, *, request_options: typing.Optional[RequestOptions] = None @@ -823,83 +372,35 @@ def get_folder( asset_folder_id="6390c49774a71f0e3c1a08ee", ) """ - _response = self._client_wrapper.httpx_client.request( - f"asset_folders/{jsonable_encoder(asset_folder_id)}", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - AssetFolder, - parse_obj_as( - type_=AssetFolder, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.get_folder(asset_folder_id, request_options=request_options) + return _response.data class AsyncAssetsClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = AsyncRawAssetsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawAssetsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawAssetsClient + """ + return self._raw_client - async def list(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Assets: + async def list( + self, + site_id: str, + *, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> Assets: """ - List assets for a given site + List of assets uploaded to a site Required scope | `assets:read` @@ -908,6 +409,12 @@ async def list(self, site_id: str, *, request_options: typing.Optional[RequestOp site_id : str Unique identifier for a Site + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -930,79 +437,15 @@ async def list(self, site_id: str, *, request_options: typing.Optional[RequestOp async def main() -> None: await client.assets.list( site_id="580e63e98c9a982ac9b8b741", + offset=1, + limit=1, ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/assets", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Assets, - parse_obj_as( - type_=Assets, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.list(site_id, offset=offset, limit=limit, request_options=request_options) + return _response.data async def create( self, @@ -1014,15 +457,18 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> AssetUpload: """ - Create a new asset entry. + The first step in uploading an asset to a site. This endpoint generates a response with the following information: `uploadUrl` and `uploadDetails`. - You can use these two properties to [upload the file to Amazon s3 by making a POST](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html) - request to the `uploadUrl` with the `uploadDetails` object as your header information in the request. - Required scope | `assets:write` + Use these properties in the header of a [POST request to Amazson s3](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html) to complete the upload. + + + To learn more about how to upload assets to Webflow, see our [assets guide](/data/docs/working-with-assets). + + Required scope | `assets:write` Parameters ---------- @@ -1067,87 +513,18 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/assets", - method="POST", - json={ - "fileName": file_name, - "fileHash": file_hash, - "parentFolder": parent_folder, - }, - headers={ - "content-type": "application/json", - }, + _response = await self._raw_client.create( + site_id, + file_name=file_name, + file_hash=file_hash, + parent_folder=parent_folder, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - AssetUpload, - parse_obj_as( - type_=AssetUpload, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def get(self, asset_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Asset: """ - Get an Asset + Get details about an asset Required scope | `assets:read` @@ -1183,74 +560,8 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"assets/{jsonable_encoder(asset_id)}", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Asset, - parse_obj_as( - type_=Asset, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.get(asset_id, request_options=request_options) + return _response.data async def delete(self, asset_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ @@ -1289,68 +600,8 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"assets/{jsonable_encoder(asset_id)}", - method="DELETE", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.delete(asset_id, request_options=request_options) + return _response.data async def update( self, @@ -1361,7 +612,7 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> Asset: """ - Update an Asset + Update details of an Asset. Required scope | `assets:write` @@ -1403,82 +654,10 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"assets/{jsonable_encoder(asset_id)}", - method="PATCH", - json={ - "localeId": locale_id, - "displayName": display_name, - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, + _response = await self._raw_client.update( + asset_id, locale_id=locale_id, display_name=display_name, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Asset, - parse_obj_as( - type_=Asset, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def list_folders( self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None @@ -1520,74 +699,8 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/asset_folders", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - AssetFolderList, - parse_obj_as( - type_=AssetFolderList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.list_folders(site_id, request_options=request_options) + return _response.data async def create_folder( self, @@ -1641,82 +754,10 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/asset_folders", - method="POST", - json={ - "displayName": display_name, - "parentFolder": parent_folder, - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, + _response = await self._raw_client.create_folder( + site_id, display_name=display_name, parent_folder=parent_folder, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - AssetFolder, - parse_obj_as( - type_=AssetFolder, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def get_folder( self, asset_folder_id: str, *, request_options: typing.Optional[RequestOptions] = None @@ -1758,71 +799,5 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"asset_folders/{jsonable_encoder(asset_folder_id)}", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - AssetFolder, - parse_obj_as( - type_=AssetFolder, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.get_folder(asset_folder_id, request_options=request_options) + return _response.data diff --git a/src/webflow/resources/assets/raw_client.py b/src/webflow/resources/assets/raw_client.py new file mode 100644 index 0000000..5c99d98 --- /dev/null +++ b/src/webflow/resources/assets/raw_client.py @@ -0,0 +1,1805 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from ...core.api_error import ApiError +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from ...core.http_response import AsyncHttpResponse, HttpResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.parse_error import ParsingError +from ...core.pydantic_utilities import parse_obj_as +from ...core.request_options import RequestOptions +from ...errors.bad_request_error import BadRequestError +from ...errors.internal_server_error import InternalServerError +from ...errors.not_found_error import NotFoundError +from ...errors.too_many_requests_error import TooManyRequestsError +from ...errors.unauthorized_error import UnauthorizedError +from ...types.asset import Asset +from ...types.asset_folder import AssetFolder +from ...types.asset_folder_list import AssetFolderList +from ...types.asset_upload import AssetUpload +from ...types.assets import Assets +from ...types.error import Error +from pydantic import ValidationError + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawAssetsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def list( + self, + site_id: str, + *, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[Assets]: + """ + List of assets uploaded to a site + + Required scope | `assets:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Assets] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/assets", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "offset": offset, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Assets, + parse_obj_as( + type_=Assets, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def create( + self, + site_id: str, + *, + file_name: str, + file_hash: str, + parent_folder: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[AssetUpload]: + """ + The first step in uploading an asset to a site. + + + This endpoint generates a response with the following information: `uploadUrl` and `uploadDetails`. + + + Use these properties in the header of a [POST request to Amazson s3](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html) to complete the upload. + + + To learn more about how to upload assets to Webflow, see our [assets guide](/data/docs/working-with-assets). + + Required scope | `assets:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + file_name : str + File name including file extension. File names must be less than 100 characters. + + file_hash : str + MD5 hash of the file + + parent_folder : typing.Optional[str] + ID of the Asset folder (optional) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[AssetUpload] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/assets", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "fileName": file_name, + "fileHash": file_hash, + "parentFolder": parent_folder, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + AssetUpload, + parse_obj_as( + type_=AssetUpload, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def get(self, asset_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[Asset]: + """ + Get details about an asset + + Required scope | `assets:read` + + Parameters + ---------- + asset_id : str + Unique identifier for an Asset on a site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Asset] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"assets/{jsonable_encoder(asset_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Asset, + parse_obj_as( + type_=Asset, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def delete(self, asset_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[None]: + """ + Delete an Asset + + Required Scope: `assets: write` + + Parameters + ---------- + asset_id : str + Unique identifier for an Asset on a site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[None] + """ + _response = self._client_wrapper.httpx_client.request( + f"assets/{jsonable_encoder(asset_id)}", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return HttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def update( + self, + asset_id: str, + *, + locale_id: typing.Optional[str] = OMIT, + display_name: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[Asset]: + """ + Update details of an Asset. + + Required scope | `assets:write` + + Parameters + ---------- + asset_id : str + Unique identifier for an Asset on a site + + locale_id : typing.Optional[str] + Unique identifier for a specific locale. Applicable, when using localization. + + display_name : typing.Optional[str] + A human readable name for the asset + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Asset] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"assets/{jsonable_encoder(asset_id)}", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + json={ + "localeId": locale_id, + "displayName": display_name, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Asset, + parse_obj_as( + type_=Asset, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def list_folders( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[AssetFolderList]: + """ + List Asset Folders within a given site + + Required scope | `assets:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[AssetFolderList] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/asset_folders", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + AssetFolderList, + parse_obj_as( + type_=AssetFolderList, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def create_folder( + self, + site_id: str, + *, + display_name: str, + parent_folder: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[AssetFolder]: + """ + Create an Asset Folder within a given site + + Required scope | `assets:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + display_name : str + A human readable name for the Asset Folder + + parent_folder : typing.Optional[str] + An (optional) pointer to a parent Asset Folder (or null for root) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[AssetFolder] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/asset_folders", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "displayName": display_name, + "parentFolder": parent_folder, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + AssetFolder, + parse_obj_as( + type_=AssetFolder, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def get_folder( + self, asset_folder_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[AssetFolder]: + """ + Get details about a specific Asset Folder + + Required scope | `assets:read` + + Parameters + ---------- + asset_folder_id : str + Unique identifier for an Asset Folder + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[AssetFolder] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"asset_folders/{jsonable_encoder(asset_folder_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + AssetFolder, + parse_obj_as( + type_=AssetFolder, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawAssetsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def list( + self, + site_id: str, + *, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[Assets]: + """ + List of assets uploaded to a site + + Required scope | `assets:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Assets] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/assets", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "offset": offset, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Assets, + parse_obj_as( + type_=Assets, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def create( + self, + site_id: str, + *, + file_name: str, + file_hash: str, + parent_folder: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[AssetUpload]: + """ + The first step in uploading an asset to a site. + + + This endpoint generates a response with the following information: `uploadUrl` and `uploadDetails`. + + + Use these properties in the header of a [POST request to Amazson s3](https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html) to complete the upload. + + + To learn more about how to upload assets to Webflow, see our [assets guide](/data/docs/working-with-assets). + + Required scope | `assets:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + file_name : str + File name including file extension. File names must be less than 100 characters. + + file_hash : str + MD5 hash of the file + + parent_folder : typing.Optional[str] + ID of the Asset folder (optional) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[AssetUpload] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/assets", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "fileName": file_name, + "fileHash": file_hash, + "parentFolder": parent_folder, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + AssetUpload, + parse_obj_as( + type_=AssetUpload, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def get( + self, asset_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[Asset]: + """ + Get details about an asset + + Required scope | `assets:read` + + Parameters + ---------- + asset_id : str + Unique identifier for an Asset on a site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Asset] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"assets/{jsonable_encoder(asset_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Asset, + parse_obj_as( + type_=Asset, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def delete( + self, asset_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[None]: + """ + Delete an Asset + + Required Scope: `assets: write` + + Parameters + ---------- + asset_id : str + Unique identifier for an Asset on a site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[None] + """ + _response = await self._client_wrapper.httpx_client.request( + f"assets/{jsonable_encoder(asset_id)}", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return AsyncHttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def update( + self, + asset_id: str, + *, + locale_id: typing.Optional[str] = OMIT, + display_name: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[Asset]: + """ + Update details of an Asset. + + Required scope | `assets:write` + + Parameters + ---------- + asset_id : str + Unique identifier for an Asset on a site + + locale_id : typing.Optional[str] + Unique identifier for a specific locale. Applicable, when using localization. + + display_name : typing.Optional[str] + A human readable name for the asset + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Asset] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"assets/{jsonable_encoder(asset_id)}", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + json={ + "localeId": locale_id, + "displayName": display_name, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Asset, + parse_obj_as( + type_=Asset, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def list_folders( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[AssetFolderList]: + """ + List Asset Folders within a given site + + Required scope | `assets:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[AssetFolderList] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/asset_folders", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + AssetFolderList, + parse_obj_as( + type_=AssetFolderList, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def create_folder( + self, + site_id: str, + *, + display_name: str, + parent_folder: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[AssetFolder]: + """ + Create an Asset Folder within a given site + + Required scope | `assets:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + display_name : str + A human readable name for the Asset Folder + + parent_folder : typing.Optional[str] + An (optional) pointer to a parent Asset Folder (or null for root) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[AssetFolder] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/asset_folders", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "displayName": display_name, + "parentFolder": parent_folder, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + AssetFolder, + parse_obj_as( + type_=AssetFolder, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def get_folder( + self, asset_folder_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[AssetFolder]: + """ + Get details about a specific Asset Folder + + Required scope | `assets:read` + + Parameters + ---------- + asset_folder_id : str + Unique identifier for an Asset Folder + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[AssetFolder] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"asset_folders/{jsonable_encoder(asset_folder_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + AssetFolder, + parse_obj_as( + type_=AssetFolder, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/collections/__init__.py b/src/webflow/resources/collections/__init__.py index cb6aaf8..07eb5d1 100644 --- a/src/webflow/resources/collections/__init__.py +++ b/src/webflow/resources/collections/__init__.py @@ -1,38 +1,97 @@ # This file was auto-generated by Fern from our API Definition. -from .resources import ( - CreateBulkCollectionItemRequestBodyFieldData, - CreateBulkCollectionItemRequestBodyFieldDataItem, - FieldCreateType, - ItemsCreateItemLiveRequest, - ItemsCreateItemRequest, - ItemsDeleteItemsLiveRequestItemsItem, - ItemsDeleteItemsRequestItemsItem, - ItemsListItemsLiveRequestSortBy, - ItemsListItemsLiveRequestSortOrder, - ItemsListItemsRequestSortBy, - ItemsListItemsRequestSortOrder, - ItemsPublishItemResponse, - MultipleItems, - MultipleLiveItems, - SingleCmsItem, - fields, - items, -) +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .resources import ( + CreateBulkCollectionItemRequestBodyFieldData, + CreateBulkCollectionItemRequestBodyFieldDataOneItem, + ItemIDs, + ItemIDsWithLocales, + ItemsCreateItemLiveRequestBody, + ItemsCreateItemRequestBody, + ItemsDeleteItemsLiveRequestItemsItem, + ItemsDeleteItemsRequestItemsItem, + ItemsListItemsLiveRequestSortBy, + ItemsListItemsLiveRequestSortOrder, + ItemsListItemsRequestSortBy, + ItemsListItemsRequestSortOrder, + ItemsPublishItemRequest, + ItemsPublishItemRequestItemsItemsItem, + ItemsPublishItemResponse, + ItemsUpdateItemsResponse, + MultipleItems, + MultipleLiveItems, + SingleCmsItem, + fields, + items, + ) +_dynamic_imports: typing.Dict[str, str] = { + "CreateBulkCollectionItemRequestBodyFieldData": ".resources", + "CreateBulkCollectionItemRequestBodyFieldDataOneItem": ".resources", + "ItemIDs": ".resources", + "ItemIDsWithLocales": ".resources", + "ItemsCreateItemLiveRequestBody": ".resources", + "ItemsCreateItemRequestBody": ".resources", + "ItemsDeleteItemsLiveRequestItemsItem": ".resources", + "ItemsDeleteItemsRequestItemsItem": ".resources", + "ItemsListItemsLiveRequestSortBy": ".resources", + "ItemsListItemsLiveRequestSortOrder": ".resources", + "ItemsListItemsRequestSortBy": ".resources", + "ItemsListItemsRequestSortOrder": ".resources", + "ItemsPublishItemRequest": ".resources", + "ItemsPublishItemRequestItemsItemsItem": ".resources", + "ItemsPublishItemResponse": ".resources", + "ItemsUpdateItemsResponse": ".resources", + "MultipleItems": ".resources", + "MultipleLiveItems": ".resources", + "SingleCmsItem": ".resources", + "fields": ".resources", + "items": ".resources", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + __all__ = [ "CreateBulkCollectionItemRequestBodyFieldData", - "CreateBulkCollectionItemRequestBodyFieldDataItem", - "FieldCreateType", - "ItemsCreateItemLiveRequest", - "ItemsCreateItemRequest", + "CreateBulkCollectionItemRequestBodyFieldDataOneItem", + "ItemIDs", + "ItemIDsWithLocales", + "ItemsCreateItemLiveRequestBody", + "ItemsCreateItemRequestBody", "ItemsDeleteItemsLiveRequestItemsItem", "ItemsDeleteItemsRequestItemsItem", "ItemsListItemsLiveRequestSortBy", "ItemsListItemsLiveRequestSortOrder", "ItemsListItemsRequestSortBy", "ItemsListItemsRequestSortOrder", + "ItemsPublishItemRequest", + "ItemsPublishItemRequestItemsItemsItem", "ItemsPublishItemResponse", + "ItemsUpdateItemsResponse", "MultipleItems", "MultipleLiveItems", "SingleCmsItem", diff --git a/src/webflow/resources/collections/client.py b/src/webflow/resources/collections/client.py index 1e44aae..bd4adca 100644 --- a/src/webflow/resources/collections/client.py +++ b/src/webflow/resources/collections/client.py @@ -1,35 +1,40 @@ # This file was auto-generated by Fern from our API Definition. +from __future__ import annotations + import typing -from ...core.client_wrapper import SyncClientWrapper -from .resources.fields.client import FieldsClient -from .resources.items.client import ItemsClient + +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ...core.request_options import RequestOptions -from ...types.collection_list import CollectionList -from ...core.jsonable_encoder import jsonable_encoder -from ...core.pydantic_utilities import parse_obj_as -from ...errors.bad_request_error import BadRequestError -from ...errors.unauthorized_error import UnauthorizedError -from ...types.error import Error -from ...errors.not_found_error import NotFoundError -from ...errors.too_many_requests_error import TooManyRequestsError -from ...errors.internal_server_error import InternalServerError -from json.decoder import JSONDecodeError -from ...core.api_error import ApiError from ...types.collection import Collection -from ...core.client_wrapper import AsyncClientWrapper -from .resources.fields.client import AsyncFieldsClient -from .resources.items.client import AsyncItemsClient +from ...types.collection_list import CollectionList +from ...types.field_create import FieldCreate +from .raw_client import AsyncRawCollectionsClient, RawCollectionsClient +if typing.TYPE_CHECKING: + from .resources.fields.client import AsyncFieldsClient, FieldsClient + from .resources.items.client import AsyncItemsClient, ItemsClient # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) class CollectionsClient: def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawCollectionsClient(client_wrapper=client_wrapper) self._client_wrapper = client_wrapper - self.fields = FieldsClient(client_wrapper=self._client_wrapper) - self.items = ItemsClient(client_wrapper=self._client_wrapper) + self._fields: typing.Optional[FieldsClient] = None + self._items: typing.Optional[ItemsClient] = None + + @property + def with_raw_response(self) -> RawCollectionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawCollectionsClient + """ + return self._raw_client def list(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> CollectionList: """ @@ -61,74 +66,8 @@ def list(self, site_id: str, *, request_options: typing.Optional[RequestOptions] site_id="580e63e98c9a982ac9b8b741", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/collections", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CollectionList, - parse_obj_as( - type_=CollectionList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.list(site_id, request_options=request_options) + return _response.data def create( self, @@ -137,10 +76,13 @@ def create( display_name: str, singular_name: str, slug: typing.Optional[str] = OMIT, + fields: typing.Optional[typing.Sequence[FieldCreate]] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> Collection: """ - Create a Collection for a site. + Create a Collection for a site with collection fields. + + Each collection includes the required _name_ and _slug_ fields, which are generated automatically. You can update the `displayName` of these fields, but the slug for them cannot be changed. Fields slugs are automatically converted to lowercase. Spaces in slugs are replaced with hyphens. Required scope | `cms:write` @@ -158,6 +100,9 @@ def create( slug : typing.Optional[str] Part of a URL that identifier + fields : typing.Optional[typing.Sequence[FieldCreate]] + An array of custom fields to add to the collection + request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -168,7 +113,7 @@ def create( Examples -------- - from webflow import Webflow + from webflow import ReferenceField, ReferenceFieldMetadata, StaticField, Webflow client = Webflow( access_token="YOUR_ACCESS_TOKEN", @@ -178,85 +123,40 @@ def create( display_name="Blog Posts", singular_name="Blog Post", slug="posts", + fields=[ + StaticField( + is_required=True, + type="PlainText", + display_name="Title", + help_text="The title of the blog post", + ), + StaticField( + is_required=True, + type="RichText", + display_name="Content", + help_text="The content of the blog post", + ), + ReferenceField( + is_required=True, + type="Reference", + display_name="Author", + help_text="The author of the blog post", + metadata=ReferenceFieldMetadata( + collection_id="23cc2d952d4e4631ffd4345d2743db4e", + ), + ), + ], ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/collections", - method="POST", - json={ - "displayName": display_name, - "singularName": singular_name, - "slug": slug, - }, - headers={ - "content-type": "application/json", - }, + _response = self._raw_client.create( + site_id, + display_name=display_name, + singular_name=singular_name, + slug=slug, + fields=fields, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Collection, - parse_obj_as( - type_=Collection, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def get(self, collection_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Collection: """ @@ -288,74 +188,8 @@ def get(self, collection_id: str, *, request_options: typing.Optional[RequestOpt collection_id="580e63fc8c9a982ac9b8b745", ) """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Collection, - parse_obj_as( - type_=Collection, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.get(collection_id, request_options=request_options) + return _response.data def delete(self, collection_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ @@ -386,75 +220,43 @@ def delete(self, collection_id: str, *, request_options: typing.Optional[Request collection_id="580e63fc8c9a982ac9b8b745", ) """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}", - method="DELETE", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.delete(collection_id, request_options=request_options) + return _response.data + + @property + def fields(self): + if self._fields is None: + from .resources.fields.client import FieldsClient # noqa: E402 + + self._fields = FieldsClient(client_wrapper=self._client_wrapper) + return self._fields + + @property + def items(self): + if self._items is None: + from .resources.items.client import ItemsClient # noqa: E402 + + self._items = ItemsClient(client_wrapper=self._client_wrapper) + return self._items class AsyncCollectionsClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawCollectionsClient(client_wrapper=client_wrapper) self._client_wrapper = client_wrapper - self.fields = AsyncFieldsClient(client_wrapper=self._client_wrapper) - self.items = AsyncItemsClient(client_wrapper=self._client_wrapper) + self._fields: typing.Optional[AsyncFieldsClient] = None + self._items: typing.Optional[AsyncItemsClient] = None + + @property + def with_raw_response(self) -> AsyncRawCollectionsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawCollectionsClient + """ + return self._raw_client async def list(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> CollectionList: """ @@ -494,74 +296,8 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/collections", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CollectionList, - parse_obj_as( - type_=CollectionList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.list(site_id, request_options=request_options) + return _response.data async def create( self, @@ -570,10 +306,13 @@ async def create( display_name: str, singular_name: str, slug: typing.Optional[str] = OMIT, + fields: typing.Optional[typing.Sequence[FieldCreate]] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> Collection: """ - Create a Collection for a site. + Create a Collection for a site with collection fields. + + Each collection includes the required _name_ and _slug_ fields, which are generated automatically. You can update the `displayName` of these fields, but the slug for them cannot be changed. Fields slugs are automatically converted to lowercase. Spaces in slugs are replaced with hyphens. Required scope | `cms:write` @@ -591,6 +330,9 @@ async def create( slug : typing.Optional[str] Part of a URL that identifier + fields : typing.Optional[typing.Sequence[FieldCreate]] + An array of custom fields to add to the collection + request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -603,7 +345,12 @@ async def create( -------- import asyncio - from webflow import AsyncWebflow + from webflow import ( + AsyncWebflow, + ReferenceField, + ReferenceFieldMetadata, + StaticField, + ) client = AsyncWebflow( access_token="YOUR_ACCESS_TOKEN", @@ -616,88 +363,43 @@ async def main() -> None: display_name="Blog Posts", singular_name="Blog Post", slug="posts", + fields=[ + StaticField( + is_required=True, + type="PlainText", + display_name="Title", + help_text="The title of the blog post", + ), + StaticField( + is_required=True, + type="RichText", + display_name="Content", + help_text="The content of the blog post", + ), + ReferenceField( + is_required=True, + type="Reference", + display_name="Author", + help_text="The author of the blog post", + metadata=ReferenceFieldMetadata( + collection_id="23cc2d952d4e4631ffd4345d2743db4e", + ), + ), + ], ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/collections", - method="POST", - json={ - "displayName": display_name, - "singularName": singular_name, - "slug": slug, - }, - headers={ - "content-type": "application/json", - }, + _response = await self._raw_client.create( + site_id, + display_name=display_name, + singular_name=singular_name, + slug=slug, + fields=fields, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Collection, - parse_obj_as( - type_=Collection, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def get(self, collection_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Collection: """ @@ -737,74 +439,8 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Collection, - parse_obj_as( - type_=Collection, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.get(collection_id, request_options=request_options) + return _response.data async def delete(self, collection_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ @@ -843,65 +479,21 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}", - method="DELETE", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.delete(collection_id, request_options=request_options) + return _response.data + + @property + def fields(self): + if self._fields is None: + from .resources.fields.client import AsyncFieldsClient # noqa: E402 + + self._fields = AsyncFieldsClient(client_wrapper=self._client_wrapper) + return self._fields + + @property + def items(self): + if self._items is None: + from .resources.items.client import AsyncItemsClient # noqa: E402 + + self._items = AsyncItemsClient(client_wrapper=self._client_wrapper) + return self._items diff --git a/src/webflow/resources/collections/raw_client.py b/src/webflow/resources/collections/raw_client.py new file mode 100644 index 0000000..ffc8451 --- /dev/null +++ b/src/webflow/resources/collections/raw_client.py @@ -0,0 +1,917 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from ...core.api_error import ApiError +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from ...core.http_response import AsyncHttpResponse, HttpResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.parse_error import ParsingError +from ...core.pydantic_utilities import parse_obj_as +from ...core.request_options import RequestOptions +from ...core.serialization import convert_and_respect_annotation_metadata +from ...errors.bad_request_error import BadRequestError +from ...errors.conflict_error import ConflictError +from ...errors.internal_server_error import InternalServerError +from ...errors.not_found_error import NotFoundError +from ...errors.too_many_requests_error import TooManyRequestsError +from ...errors.unauthorized_error import UnauthorizedError +from ...types.collection import Collection +from ...types.collection_list import CollectionList +from ...types.error import Error +from ...types.field_create import FieldCreate +from pydantic import ValidationError + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawCollectionsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def list( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[CollectionList]: + """ + List of all Collections within a Site. + + Required scope | `cms:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CollectionList] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/collections", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CollectionList, + parse_obj_as( + type_=CollectionList, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def create( + self, + site_id: str, + *, + display_name: str, + singular_name: str, + slug: typing.Optional[str] = OMIT, + fields: typing.Optional[typing.Sequence[FieldCreate]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[Collection]: + """ + Create a Collection for a site with collection fields. + + Each collection includes the required _name_ and _slug_ fields, which are generated automatically. You can update the `displayName` of these fields, but the slug for them cannot be changed. Fields slugs are automatically converted to lowercase. Spaces in slugs are replaced with hyphens. + + Required scope | `cms:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + display_name : str + Name of the collection. Each collection name must be distinct. + + singular_name : str + Singular name of each item. + + slug : typing.Optional[str] + Part of a URL that identifier + + fields : typing.Optional[typing.Sequence[FieldCreate]] + An array of custom fields to add to the collection + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Collection] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/collections", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "displayName": display_name, + "singularName": singular_name, + "slug": slug, + "fields": convert_and_respect_annotation_metadata( + object_=fields, annotation=typing.Sequence[FieldCreate], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Collection, + parse_obj_as( + type_=Collection, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def get( + self, collection_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[Collection]: + """ + Get the full details of a collection from its ID. + + Required scope | `cms:read` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Collection] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Collection, + parse_obj_as( + type_=Collection, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def delete( + self, collection_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[None]: + """ + Delete a collection using its ID. + + Required scope | `cms:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[None] + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return HttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawCollectionsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def list( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[CollectionList]: + """ + List of all Collections within a Site. + + Required scope | `cms:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CollectionList] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/collections", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CollectionList, + parse_obj_as( + type_=CollectionList, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def create( + self, + site_id: str, + *, + display_name: str, + singular_name: str, + slug: typing.Optional[str] = OMIT, + fields: typing.Optional[typing.Sequence[FieldCreate]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[Collection]: + """ + Create a Collection for a site with collection fields. + + Each collection includes the required _name_ and _slug_ fields, which are generated automatically. You can update the `displayName` of these fields, but the slug for them cannot be changed. Fields slugs are automatically converted to lowercase. Spaces in slugs are replaced with hyphens. + + Required scope | `cms:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + display_name : str + Name of the collection. Each collection name must be distinct. + + singular_name : str + Singular name of each item. + + slug : typing.Optional[str] + Part of a URL that identifier + + fields : typing.Optional[typing.Sequence[FieldCreate]] + An array of custom fields to add to the collection + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Collection] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/collections", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "displayName": display_name, + "singularName": singular_name, + "slug": slug, + "fields": convert_and_respect_annotation_metadata( + object_=fields, annotation=typing.Sequence[FieldCreate], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Collection, + parse_obj_as( + type_=Collection, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def get( + self, collection_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[Collection]: + """ + Get the full details of a collection from its ID. + + Required scope | `cms:read` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Collection] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Collection, + parse_obj_as( + type_=Collection, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def delete( + self, collection_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[None]: + """ + Delete a collection using its ID. + + Required scope | `cms:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[None] + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return AsyncHttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/collections/resources/__init__.py b/src/webflow/resources/collections/resources/__init__.py index f9325ee..7123bf3 100644 --- a/src/webflow/resources/collections/resources/__init__.py +++ b/src/webflow/resources/collections/resources/__init__.py @@ -1,37 +1,96 @@ # This file was auto-generated by Fern from our API Definition. -from . import fields, items -from .fields import FieldCreateType -from .items import ( - CreateBulkCollectionItemRequestBodyFieldData, - CreateBulkCollectionItemRequestBodyFieldDataItem, - ItemsCreateItemLiveRequest, - ItemsCreateItemRequest, - ItemsDeleteItemsLiveRequestItemsItem, - ItemsDeleteItemsRequestItemsItem, - ItemsListItemsLiveRequestSortBy, - ItemsListItemsLiveRequestSortOrder, - ItemsListItemsRequestSortBy, - ItemsListItemsRequestSortOrder, - ItemsPublishItemResponse, - MultipleItems, - MultipleLiveItems, - SingleCmsItem, -) +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from . import fields, items + from .items import ( + CreateBulkCollectionItemRequestBodyFieldData, + CreateBulkCollectionItemRequestBodyFieldDataOneItem, + ItemIDs, + ItemIDsWithLocales, + ItemsCreateItemLiveRequestBody, + ItemsCreateItemRequestBody, + ItemsDeleteItemsLiveRequestItemsItem, + ItemsDeleteItemsRequestItemsItem, + ItemsListItemsLiveRequestSortBy, + ItemsListItemsLiveRequestSortOrder, + ItemsListItemsRequestSortBy, + ItemsListItemsRequestSortOrder, + ItemsPublishItemRequest, + ItemsPublishItemRequestItemsItemsItem, + ItemsPublishItemResponse, + ItemsUpdateItemsResponse, + MultipleItems, + MultipleLiveItems, + SingleCmsItem, + ) +_dynamic_imports: typing.Dict[str, str] = { + "CreateBulkCollectionItemRequestBodyFieldData": ".items", + "CreateBulkCollectionItemRequestBodyFieldDataOneItem": ".items", + "ItemIDs": ".items", + "ItemIDsWithLocales": ".items", + "ItemsCreateItemLiveRequestBody": ".items", + "ItemsCreateItemRequestBody": ".items", + "ItemsDeleteItemsLiveRequestItemsItem": ".items", + "ItemsDeleteItemsRequestItemsItem": ".items", + "ItemsListItemsLiveRequestSortBy": ".items", + "ItemsListItemsLiveRequestSortOrder": ".items", + "ItemsListItemsRequestSortBy": ".items", + "ItemsListItemsRequestSortOrder": ".items", + "ItemsPublishItemRequest": ".items", + "ItemsPublishItemRequestItemsItemsItem": ".items", + "ItemsPublishItemResponse": ".items", + "ItemsUpdateItemsResponse": ".items", + "MultipleItems": ".items", + "MultipleLiveItems": ".items", + "SingleCmsItem": ".items", + "fields": ".fields", + "items": ".items", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + __all__ = [ "CreateBulkCollectionItemRequestBodyFieldData", - "CreateBulkCollectionItemRequestBodyFieldDataItem", - "FieldCreateType", - "ItemsCreateItemLiveRequest", - "ItemsCreateItemRequest", + "CreateBulkCollectionItemRequestBodyFieldDataOneItem", + "ItemIDs", + "ItemIDsWithLocales", + "ItemsCreateItemLiveRequestBody", + "ItemsCreateItemRequestBody", "ItemsDeleteItemsLiveRequestItemsItem", "ItemsDeleteItemsRequestItemsItem", "ItemsListItemsLiveRequestSortBy", "ItemsListItemsLiveRequestSortOrder", "ItemsListItemsRequestSortBy", "ItemsListItemsRequestSortOrder", + "ItemsPublishItemRequest", + "ItemsPublishItemRequestItemsItemsItem", "ItemsPublishItemResponse", + "ItemsUpdateItemsResponse", "MultipleItems", "MultipleLiveItems", "SingleCmsItem", diff --git a/src/webflow/resources/collections/resources/fields/__init__.py b/src/webflow/resources/collections/resources/fields/__init__.py index 5a5b167..5cde020 100644 --- a/src/webflow/resources/collections/resources/fields/__init__.py +++ b/src/webflow/resources/collections/resources/fields/__init__.py @@ -1,5 +1,4 @@ # This file was auto-generated by Fern from our API Definition. -from .types import FieldCreateType +# isort: skip_file -__all__ = ["FieldCreateType"] diff --git a/src/webflow/resources/collections/resources/fields/client.py b/src/webflow/resources/collections/resources/fields/client.py index 40b66cf..b4f337b 100644 --- a/src/webflow/resources/collections/resources/fields/client.py +++ b/src/webflow/resources/collections/resources/fields/client.py @@ -1,21 +1,12 @@ # This file was auto-generated by Fern from our API Definition. import typing -from .....core.client_wrapper import SyncClientWrapper -from .types.field_create_type import FieldCreateType + +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from .....core.request_options import RequestOptions from .....types.field import Field -from .....core.jsonable_encoder import jsonable_encoder -from .....core.pydantic_utilities import parse_obj_as -from .....errors.bad_request_error import BadRequestError -from .....errors.unauthorized_error import UnauthorizedError -from .....types.error import Error -from .....errors.not_found_error import NotFoundError -from .....errors.too_many_requests_error import TooManyRequestsError -from .....errors.internal_server_error import InternalServerError -from json.decoder import JSONDecodeError -from .....core.api_error import ApiError -from .....core.client_wrapper import AsyncClientWrapper +from .....types.field_create import FieldCreate +from .raw_client import AsyncRawFieldsClient, RawFieldsClient # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) @@ -23,27 +14,28 @@ class FieldsClient: def __init__(self, *, client_wrapper: SyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = RawFieldsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawFieldsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawFieldsClient + """ + return self._raw_client def create( - self, - collection_id: str, - *, - type: FieldCreateType, - display_name: str, - is_required: typing.Optional[bool] = OMIT, - help_text: typing.Optional[str] = OMIT, - request_options: typing.Optional[RequestOptions] = None, - ) -> Field: + self, collection_id: str, *, request: FieldCreate, request_options: typing.Optional[RequestOptions] = None + ) -> FieldCreate: """ Create a custom field in a collection. - Slugs must be all lowercase letters without spaces. - If you pass a string with uppercase letters and/or spaces to the "Slug" property, Webflow will - convert the slug to lowercase and replace spaces with "-." + Field validation is currently not available through the API. - Only some field types can be created through the API. - This endpoint does not currently support bulk creation. + Bulk creation of fields is not supported with this endpoint. To add multiple fields at once, include them when you [create the collection.](/data/v2.0.0/reference/cms/collections/create) Required scope | `cms:write` @@ -52,119 +44,37 @@ def create( collection_id : str Unique identifier for a Collection - type : FieldCreateType - Choose these appropriate field type for your collection data - - display_name : str - The name of a field - - is_required : typing.Optional[bool] - define whether a field is required in a collection - - help_text : typing.Optional[str] - Additional text to help anyone filling out this field + request : FieldCreate request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- - Field + FieldCreate Request was successful Examples -------- - from webflow import Webflow + from webflow import StaticField, Webflow client = Webflow( access_token="YOUR_ACCESS_TOKEN", ) client.collections.fields.create( collection_id="580e63fc8c9a982ac9b8b745", - is_required=False, - type="RichText", - display_name="Post Body", - help_text="Add the body of your post here", + request=StaticField( + id="562ac0395358780a1f5e6fbc", + is_editable=True, + is_required=False, + type="RichText", + display_name="Post Body", + help_text="Add the body of your post here", + ), ) """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/fields", - method="POST", - json={ - "isRequired": is_required, - "type": type, - "displayName": display_name, - "helpText": help_text, - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Field, - parse_obj_as( - type_=Field, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.create(collection_id, request=request, request_options=request_options) + return _response.data def delete( self, collection_id: str, field_id: str, *, request_options: typing.Optional[RequestOptions] = None @@ -201,68 +111,8 @@ def delete( field_id="580e63fc8c9a982ac9b8b745", ) """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/fields/{jsonable_encoder(field_id)}", - method="DELETE", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.delete(collection_id, field_id, request_options=request_options) + return _response.data def update( self, @@ -319,108 +169,41 @@ def update( help_text="Add the body of your post here", ) """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/fields/{jsonable_encoder(field_id)}", - method="PATCH", - json={ - "isRequired": is_required, - "displayName": display_name, - "helpText": help_text, - }, - headers={ - "content-type": "application/json", - }, + _response = self._raw_client.update( + collection_id, + field_id, + is_required=is_required, + display_name=display_name, + help_text=help_text, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Field, - parse_obj_as( - type_=Field, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data class AsyncFieldsClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = AsyncRawFieldsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawFieldsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawFieldsClient + """ + return self._raw_client async def create( - self, - collection_id: str, - *, - type: FieldCreateType, - display_name: str, - is_required: typing.Optional[bool] = OMIT, - help_text: typing.Optional[str] = OMIT, - request_options: typing.Optional[RequestOptions] = None, - ) -> Field: + self, collection_id: str, *, request: FieldCreate, request_options: typing.Optional[RequestOptions] = None + ) -> FieldCreate: """ Create a custom field in a collection. - Slugs must be all lowercase letters without spaces. - If you pass a string with uppercase letters and/or spaces to the "Slug" property, Webflow will - convert the slug to lowercase and replace spaces with "-." + Field validation is currently not available through the API. - Only some field types can be created through the API. - This endpoint does not currently support bulk creation. + Bulk creation of fields is not supported with this endpoint. To add multiple fields at once, include them when you [create the collection.](/data/v2.0.0/reference/cms/collections/create) Required scope | `cms:write` @@ -429,31 +212,21 @@ async def create( collection_id : str Unique identifier for a Collection - type : FieldCreateType - Choose these appropriate field type for your collection data - - display_name : str - The name of a field - - is_required : typing.Optional[bool] - define whether a field is required in a collection - - help_text : typing.Optional[str] - Additional text to help anyone filling out this field + request : FieldCreate request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- - Field + FieldCreate Request was successful Examples -------- import asyncio - from webflow import AsyncWebflow + from webflow import AsyncWebflow, StaticField client = AsyncWebflow( access_token="YOUR_ACCESS_TOKEN", @@ -463,93 +236,21 @@ async def create( async def main() -> None: await client.collections.fields.create( collection_id="580e63fc8c9a982ac9b8b745", - is_required=False, - type="RichText", - display_name="Post Body", - help_text="Add the body of your post here", + request=StaticField( + id="562ac0395358780a1f5e6fbc", + is_editable=True, + is_required=False, + type="RichText", + display_name="Post Body", + help_text="Add the body of your post here", + ), ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/fields", - method="POST", - json={ - "isRequired": is_required, - "type": type, - "displayName": display_name, - "helpText": help_text, - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Field, - parse_obj_as( - type_=Field, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.create(collection_id, request=request, request_options=request_options) + return _response.data async def delete( self, collection_id: str, field_id: str, *, request_options: typing.Optional[RequestOptions] = None @@ -594,68 +295,8 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/fields/{jsonable_encoder(field_id)}", - method="DELETE", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.delete(collection_id, field_id, request_options=request_options) + return _response.data async def update( self, @@ -720,80 +361,12 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/fields/{jsonable_encoder(field_id)}", - method="PATCH", - json={ - "isRequired": is_required, - "displayName": display_name, - "helpText": help_text, - }, - headers={ - "content-type": "application/json", - }, + _response = await self._raw_client.update( + collection_id, + field_id, + is_required=is_required, + display_name=display_name, + help_text=help_text, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Field, - parse_obj_as( - type_=Field, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data diff --git a/src/webflow/resources/collections/resources/fields/raw_client.py b/src/webflow/resources/collections/resources/fields/raw_client.py new file mode 100644 index 0000000..31f26be --- /dev/null +++ b/src/webflow/resources/collections/resources/fields/raw_client.py @@ -0,0 +1,732 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from .....core.api_error import ApiError +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from .....core.http_response import AsyncHttpResponse, HttpResponse +from .....core.jsonable_encoder import jsonable_encoder +from .....core.parse_error import ParsingError +from .....core.pydantic_utilities import parse_obj_as +from .....core.request_options import RequestOptions +from .....core.serialization import convert_and_respect_annotation_metadata +from .....errors.bad_request_error import BadRequestError +from .....errors.conflict_error import ConflictError +from .....errors.internal_server_error import InternalServerError +from .....errors.not_found_error import NotFoundError +from .....errors.too_many_requests_error import TooManyRequestsError +from .....errors.unauthorized_error import UnauthorizedError +from .....types.error import Error +from .....types.field import Field +from .....types.field_create import FieldCreate +from pydantic import ValidationError + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawFieldsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, collection_id: str, *, request: FieldCreate, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[FieldCreate]: + """ + Create a custom field in a collection. + + Field validation is currently not available through the API. + + Bulk creation of fields is not supported with this endpoint. To add multiple fields at once, include them when you [create the collection.](/data/v2.0.0/reference/cms/collections/create) + + Required scope | `cms:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + request : FieldCreate + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[FieldCreate] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/fields", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json=convert_and_respect_annotation_metadata(object_=request, annotation=FieldCreate, direction="write"), + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + FieldCreate, + parse_obj_as( + type_=FieldCreate, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def delete( + self, collection_id: str, field_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[None]: + """ + Delete a custom field in a collection. This endpoint does not currently support bulk deletion. + + Required scope | `cms:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + field_id : str + Unique identifier for a Field in a collection + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[None] + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/fields/{jsonable_encoder(field_id)}", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return HttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def update( + self, + collection_id: str, + field_id: str, + *, + is_required: typing.Optional[bool] = OMIT, + display_name: typing.Optional[str] = OMIT, + help_text: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[Field]: + """ + Update a custom field in a collection. + + Required scope | `cms:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + field_id : str + Unique identifier for a Field in a collection + + is_required : typing.Optional[bool] + Define whether a field is required in a collection + + display_name : typing.Optional[str] + The name of a field + + help_text : typing.Optional[str] + Additional text to help anyone filling out this field + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Field] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/fields/{jsonable_encoder(field_id)}", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + json={ + "isRequired": is_required, + "displayName": display_name, + "helpText": help_text, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Field, + parse_obj_as( + type_=Field, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawFieldsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, collection_id: str, *, request: FieldCreate, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[FieldCreate]: + """ + Create a custom field in a collection. + + Field validation is currently not available through the API. + + Bulk creation of fields is not supported with this endpoint. To add multiple fields at once, include them when you [create the collection.](/data/v2.0.0/reference/cms/collections/create) + + Required scope | `cms:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + request : FieldCreate + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[FieldCreate] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/fields", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json=convert_and_respect_annotation_metadata(object_=request, annotation=FieldCreate, direction="write"), + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + FieldCreate, + parse_obj_as( + type_=FieldCreate, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def delete( + self, collection_id: str, field_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[None]: + """ + Delete a custom field in a collection. This endpoint does not currently support bulk deletion. + + Required scope | `cms:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + field_id : str + Unique identifier for a Field in a collection + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[None] + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/fields/{jsonable_encoder(field_id)}", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return AsyncHttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def update( + self, + collection_id: str, + field_id: str, + *, + is_required: typing.Optional[bool] = OMIT, + display_name: typing.Optional[str] = OMIT, + help_text: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[Field]: + """ + Update a custom field in a collection. + + Required scope | `cms:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + field_id : str + Unique identifier for a Field in a collection + + is_required : typing.Optional[bool] + Define whether a field is required in a collection + + display_name : typing.Optional[str] + The name of a field + + help_text : typing.Optional[str] + Additional text to help anyone filling out this field + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Field] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/fields/{jsonable_encoder(field_id)}", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + json={ + "isRequired": is_required, + "displayName": display_name, + "helpText": help_text, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Field, + parse_obj_as( + type_=Field, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/collections/resources/fields/types/__init__.py b/src/webflow/resources/collections/resources/fields/types/__init__.py deleted file mode 100644 index c17230e..0000000 --- a/src/webflow/resources/collections/resources/fields/types/__init__.py +++ /dev/null @@ -1,5 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from .field_create_type import FieldCreateType - -__all__ = ["FieldCreateType"] diff --git a/src/webflow/resources/collections/resources/items/__init__.py b/src/webflow/resources/collections/resources/items/__init__.py index fbccd1b..ae89439 100644 --- a/src/webflow/resources/collections/resources/items/__init__.py +++ b/src/webflow/resources/collections/resources/items/__init__.py @@ -1,34 +1,93 @@ # This file was auto-generated by Fern from our API Definition. -from .types import ( - CreateBulkCollectionItemRequestBodyFieldData, - CreateBulkCollectionItemRequestBodyFieldDataItem, - ItemsCreateItemLiveRequest, - ItemsCreateItemRequest, - ItemsDeleteItemsLiveRequestItemsItem, - ItemsDeleteItemsRequestItemsItem, - ItemsListItemsLiveRequestSortBy, - ItemsListItemsLiveRequestSortOrder, - ItemsListItemsRequestSortBy, - ItemsListItemsRequestSortOrder, - ItemsPublishItemResponse, - MultipleItems, - MultipleLiveItems, - SingleCmsItem, -) +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .types import ( + CreateBulkCollectionItemRequestBodyFieldData, + CreateBulkCollectionItemRequestBodyFieldDataOneItem, + ItemIDs, + ItemIDsWithLocales, + ItemsCreateItemLiveRequestBody, + ItemsCreateItemRequestBody, + ItemsDeleteItemsLiveRequestItemsItem, + ItemsDeleteItemsRequestItemsItem, + ItemsListItemsLiveRequestSortBy, + ItemsListItemsLiveRequestSortOrder, + ItemsListItemsRequestSortBy, + ItemsListItemsRequestSortOrder, + ItemsPublishItemRequest, + ItemsPublishItemRequestItemsItemsItem, + ItemsPublishItemResponse, + ItemsUpdateItemsResponse, + MultipleItems, + MultipleLiveItems, + SingleCmsItem, + ) +_dynamic_imports: typing.Dict[str, str] = { + "CreateBulkCollectionItemRequestBodyFieldData": ".types", + "CreateBulkCollectionItemRequestBodyFieldDataOneItem": ".types", + "ItemIDs": ".types", + "ItemIDsWithLocales": ".types", + "ItemsCreateItemLiveRequestBody": ".types", + "ItemsCreateItemRequestBody": ".types", + "ItemsDeleteItemsLiveRequestItemsItem": ".types", + "ItemsDeleteItemsRequestItemsItem": ".types", + "ItemsListItemsLiveRequestSortBy": ".types", + "ItemsListItemsLiveRequestSortOrder": ".types", + "ItemsListItemsRequestSortBy": ".types", + "ItemsListItemsRequestSortOrder": ".types", + "ItemsPublishItemRequest": ".types", + "ItemsPublishItemRequestItemsItemsItem": ".types", + "ItemsPublishItemResponse": ".types", + "ItemsUpdateItemsResponse": ".types", + "MultipleItems": ".types", + "MultipleLiveItems": ".types", + "SingleCmsItem": ".types", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + __all__ = [ "CreateBulkCollectionItemRequestBodyFieldData", - "CreateBulkCollectionItemRequestBodyFieldDataItem", - "ItemsCreateItemLiveRequest", - "ItemsCreateItemRequest", + "CreateBulkCollectionItemRequestBodyFieldDataOneItem", + "ItemIDs", + "ItemIDsWithLocales", + "ItemsCreateItemLiveRequestBody", + "ItemsCreateItemRequestBody", "ItemsDeleteItemsLiveRequestItemsItem", "ItemsDeleteItemsRequestItemsItem", "ItemsListItemsLiveRequestSortBy", "ItemsListItemsLiveRequestSortOrder", "ItemsListItemsRequestSortBy", "ItemsListItemsRequestSortOrder", + "ItemsPublishItemRequest", + "ItemsPublishItemRequestItemsItemsItem", "ItemsPublishItemResponse", + "ItemsUpdateItemsResponse", "MultipleItems", "MultipleLiveItems", "SingleCmsItem", diff --git a/src/webflow/resources/collections/resources/items/client.py b/src/webflow/resources/collections/resources/items/client.py index 47f8f90..16f1d5c 100644 --- a/src/webflow/resources/collections/resources/items/client.py +++ b/src/webflow/resources/collections/resources/items/client.py @@ -1,37 +1,30 @@ # This file was auto-generated by Fern from our API Definition. import typing -from .....core.client_wrapper import SyncClientWrapper -from .types.items_list_items_request_sort_by import ItemsListItemsRequestSortBy -from .types.items_list_items_request_sort_order import ItemsListItemsRequestSortOrder + +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from .....core.request_options import RequestOptions -from .....types.collection_item_list import CollectionItemList -from .....core.jsonable_encoder import jsonable_encoder -from .....core.pydantic_utilities import parse_obj_as -from .....errors.bad_request_error import BadRequestError -from .....errors.unauthorized_error import UnauthorizedError -from .....types.error import Error -from .....errors.not_found_error import NotFoundError -from .....errors.too_many_requests_error import TooManyRequestsError -from .....errors.internal_server_error import InternalServerError -from json.decoder import JSONDecodeError -from .....core.api_error import ApiError -from .types.items_create_item_request import ItemsCreateItemRequest +from .....types.bulk_collection_item import BulkCollectionItem from .....types.collection_item import CollectionItem -from .....core.serialization import convert_and_respect_annotation_metadata -from .types.items_delete_items_request_items_item import ItemsDeleteItemsRequestItemsItem -from .....errors.conflict_error import ConflictError +from .....types.collection_item_list import CollectionItemList +from .....types.collection_item_list_no_pagination import CollectionItemListNoPagination +from .....types.collection_item_patch_single_field_data import CollectionItemPatchSingleFieldData from .....types.collection_item_with_id_input import CollectionItemWithIdInput +from .....types.items_list_items_live_request_last_published import ItemsListItemsLiveRequestLastPublished +from .....types.items_list_items_request_last_published import ItemsListItemsRequestLastPublished +from .raw_client import AsyncRawItemsClient, RawItemsClient +from .types.create_bulk_collection_item_request_body_field_data import CreateBulkCollectionItemRequestBodyFieldData +from .types.items_create_item_live_request_body import ItemsCreateItemLiveRequestBody +from .types.items_create_item_request_body import ItemsCreateItemRequestBody +from .types.items_delete_items_live_request_items_item import ItemsDeleteItemsLiveRequestItemsItem +from .types.items_delete_items_request_items_item import ItemsDeleteItemsRequestItemsItem from .types.items_list_items_live_request_sort_by import ItemsListItemsLiveRequestSortBy from .types.items_list_items_live_request_sort_order import ItemsListItemsLiveRequestSortOrder -from .types.items_create_item_live_request import ItemsCreateItemLiveRequest -from .types.items_delete_items_live_request_items_item import ItemsDeleteItemsLiveRequestItemsItem -from .....types.collection_item_list_no_pagination import CollectionItemListNoPagination -from .types.create_bulk_collection_item_request_body_field_data import CreateBulkCollectionItemRequestBodyFieldData -from .....types.bulk_collection_item import BulkCollectionItem -from .....types.collection_item_patch_single_field_data import CollectionItemPatchSingleFieldData +from .types.items_list_items_request_sort_by import ItemsListItemsRequestSortBy +from .types.items_list_items_request_sort_order import ItemsListItemsRequestSortOrder +from .types.items_publish_item_request import ItemsPublishItemRequest from .types.items_publish_item_response import ItemsPublishItemResponse -from .....core.client_wrapper import AsyncClientWrapper +from .types.items_update_items_response import ItemsUpdateItemsResponse # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) @@ -39,17 +32,29 @@ class ItemsClient: def __init__(self, *, client_wrapper: SyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = RawItemsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawItemsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawItemsClient + """ + return self._raw_client def list_items( self, collection_id: str, *, cms_locale_id: typing.Optional[str] = None, - offset: typing.Optional[float] = None, - limit: typing.Optional[float] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, name: typing.Optional[str] = None, slug: typing.Optional[str] = None, + last_published: typing.Optional[ItemsListItemsRequestLastPublished] = None, sort_by: typing.Optional[ItemsListItemsRequestSortBy] = None, sort_order: typing.Optional[ItemsListItemsRequestSortOrder] = None, request_options: typing.Optional[RequestOptions] = None, @@ -67,17 +72,20 @@ def list_items( cms_locale_id : typing.Optional[str] Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string. - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records - limit : typing.Optional[float] + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) name : typing.Optional[str] - The name of the item(s) + Filter by the exact name of the item(s) slug : typing.Optional[str] - The slug of the item + Filter by the exact slug of the item + + last_published : typing.Optional[ItemsListItemsRequestLastPublished] + Filter by the last published date of the item(s) sort_by : typing.Optional[ItemsListItemsRequestSortBy] Sort results by the provided value @@ -102,98 +110,42 @@ def list_items( ) client.collections.items.list_items( collection_id="580e63fc8c9a982ac9b8b745", - ) - """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items", - method="GET", - params={ - "cmsLocaleId": cms_locale_id, - "offset": offset, - "limit": limit, - "name": name, - "slug": slug, - "sortBy": sort_by, - "sortOrder": sort_order, - }, + cms_locale_id="cmsLocaleId", + offset=1, + limit=1, + name="name", + slug="slug", + sort_by="lastPublished", + sort_order="asc", + ) + """ + _response = self._raw_client.list_items( + collection_id, + cms_locale_id=cms_locale_id, + offset=offset, + limit=limit, + name=name, + slug=slug, + last_published=last_published, + sort_by=sort_by, + sort_order=sort_order, request_options=request_options, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CollectionItemList, - parse_obj_as( - type_=CollectionItemList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def create_item( self, collection_id: str, *, - request: ItemsCreateItemRequest, + request: ItemsCreateItemRequestBody, + skip_invalid_files: typing.Optional[bool] = None, request_options: typing.Optional[RequestOptions] = None, ) -> CollectionItem: """ Create Item(s) in a Collection. - To create items across multiple locales, please use [this endpoint.](/v2.0.0/data/reference/cms/collection-items/staged-items/create-items) + To create items across multiple locales, please use [this endpoint.](/data/reference/cms/collection-items/staged-items/create-items) Required scope | `CMS:write` @@ -202,7 +154,10 @@ def create_item( collection_id : str Unique identifier for a Collection - request : ItemsCreateItemRequest + request : ItemsCreateItemRequestBody + + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -225,100 +180,33 @@ def create_item( ) client.collections.items.create_item( collection_id="580e63fc8c9a982ac9b8b745", + skip_invalid_files=True, request=CollectionItemPostSingle( is_archived=False, is_draft=False, field_data=CollectionItemPostSingleFieldData( - name="Pan Galactic Gargle Blaster Recipe", - slug="pan-galactic-gargle-blaster", + name="The Hitchhiker's Guide to the Galaxy", + slug="hitchhikers-guide-to-the-galaxy", ), ), ) """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items", - method="POST", - json=convert_and_respect_annotation_metadata( - object_=request, annotation=ItemsCreateItemRequest, direction="write" - ), - request_options=request_options, - omit=OMIT, + _response = self._raw_client.create_item( + collection_id, request=request, skip_invalid_files=skip_invalid_files, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CollectionItem, - parse_obj_as( - type_=CollectionItem, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def delete_items( self, collection_id: str, *, - items: typing.Optional[typing.Sequence[ItemsDeleteItemsRequestItemsItem]] = OMIT, + items: typing.Sequence[ItemsDeleteItemsRequestItemsItem], request_options: typing.Optional[RequestOptions] = None, ) -> None: """ Delete Items from a Collection. - **Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be deleted only in the primary locale. + Items will only be deleted in the primary locale unless a `cmsLocaleId` is included in the request. Required scope | `CMS:write` @@ -327,7 +215,7 @@ def delete_items( collection_id : str Unique identifier for a Collection - items : typing.Optional[typing.Sequence[ItemsDeleteItemsRequestItemsItem]] + items : typing.Sequence[ItemsDeleteItemsRequestItemsItem] request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -339,107 +227,39 @@ def delete_items( Examples -------- from webflow import Webflow + from webflow.resources.collections.resources.items import ( + ItemsDeleteItemsRequestItemsItem, + ) client = Webflow( access_token="YOUR_ACCESS_TOKEN", ) client.collections.items.delete_items( collection_id="580e63fc8c9a982ac9b8b745", + items=[ + ItemsDeleteItemsRequestItemsItem( + id="580e64008c9a982ac9b8b754", + ) + ], ) """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items", - method="DELETE", - json={ - "items": convert_and_respect_annotation_metadata( - object_=items, annotation=typing.Sequence[ItemsDeleteItemsRequestItemsItem], direction="write" - ), - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, - ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.delete_items(collection_id, items=items, request_options=request_options) + return _response.data def update_items( self, collection_id: str, *, + skip_invalid_files: typing.Optional[bool] = None, items: typing.Optional[typing.Sequence[CollectionItemWithIdInput]] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> CollectionItem: + ) -> ItemsUpdateItemsResponse: """ - Update a single item or multiple items (up to 100) in a Collection. + Update a single item or multiple items in a Collection. + + The limit for this endpoint is 100 items. - **Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be updated only in the primary locale. + Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request. Required scope | `CMS:write` @@ -448,6 +268,9 @@ def update_items( collection_id : str Unique identifier for a Collection + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + items : typing.Optional[typing.Sequence[CollectionItemWithIdInput]] request_options : typing.Optional[RequestOptions] @@ -455,7 +278,7 @@ def update_items( Returns ------- - CollectionItem + ItemsUpdateItemsResponse Request was successful Examples @@ -471,6 +294,7 @@ def update_items( ) client.collections.items.update_items( collection_id="580e63fc8c9a982ac9b8b745", + skip_invalid_files=True, items=[ CollectionItemWithIdInput( id="66f6ed9576ddacf3149d5ea6", @@ -507,99 +331,31 @@ def update_items( ], ) """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items", - method="PATCH", - json={ - "items": convert_and_respect_annotation_metadata( - object_=items, annotation=typing.Sequence[CollectionItemWithIdInput], direction="write" - ), - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, + _response = self._raw_client.update_items( + collection_id, skip_invalid_files=skip_invalid_files, items=items, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CollectionItem, - parse_obj_as( - type_=CollectionItem, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def list_items_live( self, collection_id: str, *, cms_locale_id: typing.Optional[str] = None, - offset: typing.Optional[float] = None, - limit: typing.Optional[float] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, name: typing.Optional[str] = None, slug: typing.Optional[str] = None, + last_published: typing.Optional[ItemsListItemsLiveRequestLastPublished] = None, sort_by: typing.Optional[ItemsListItemsLiveRequestSortBy] = None, sort_order: typing.Optional[ItemsListItemsLiveRequestSortOrder] = None, request_options: typing.Optional[RequestOptions] = None, ) -> CollectionItemList: """ - List of all live Items within a Collection. + List all published items in a collection. + + + Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations. + Required scope | `CMS:read` @@ -611,17 +367,20 @@ def list_items_live( cms_locale_id : typing.Optional[str] Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string. - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records - limit : typing.Optional[float] + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) name : typing.Optional[str] - The name of the item(s) + Filter by the exact name of the item(s) slug : typing.Optional[str] - The slug of the item + Filter by the exact slug of the item + + last_published : typing.Optional[ItemsListItemsLiveRequestLastPublished] + Filter by the last published date of the item(s) sort_by : typing.Optional[ItemsListItemsLiveRequestSortBy] Sort results by the provided value @@ -646,98 +405,42 @@ def list_items_live( ) client.collections.items.list_items_live( collection_id="580e63fc8c9a982ac9b8b745", - ) - """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/live", - method="GET", - params={ - "cmsLocaleId": cms_locale_id, - "offset": offset, - "limit": limit, - "name": name, - "slug": slug, - "sortBy": sort_by, - "sortOrder": sort_order, - }, + cms_locale_id="cmsLocaleId", + offset=1, + limit=1, + name="name", + slug="slug", + sort_by="lastPublished", + sort_order="asc", + ) + """ + _response = self._raw_client.list_items_live( + collection_id, + cms_locale_id=cms_locale_id, + offset=offset, + limit=limit, + name=name, + slug=slug, + last_published=last_published, + sort_by=sort_by, + sort_order=sort_order, request_options=request_options, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CollectionItemList, - parse_obj_as( - type_=CollectionItemList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def create_item_live( self, collection_id: str, *, - request: ItemsCreateItemLiveRequest, + request: ItemsCreateItemLiveRequestBody, + skip_invalid_files: typing.Optional[bool] = None, request_options: typing.Optional[RequestOptions] = None, ) -> CollectionItem: """ - Create live Item(s) in a Collection. The Item(s) will be published to the live site. + Create item(s) in a collection that will be immediately published to the live site. - To create items across multiple locales, [please use this endpoint.](/v2.0.0/data/reference/cms/collection-items/staged-items/create-items) + To create items across multiple locales, [please use this endpoint.](/data/reference/cms/collection-items/staged-items/create-items) Required scope | `CMS:write` @@ -747,7 +450,10 @@ def create_item_live( collection_id : str Unique identifier for a Collection - request : ItemsCreateItemLiveRequest + request : ItemsCreateItemLiveRequestBody + + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -766,100 +472,33 @@ def create_item_live( ) client.collections.items.create_item_live( collection_id="580e63fc8c9a982ac9b8b745", + skip_invalid_files=True, request=CollectionItem( is_archived=False, is_draft=False, field_data=CollectionItemFieldData( - name="Pan Galactic Gargle Blaster Recipe", - slug="pan-galactic-gargle-blaster", + name="The Hitchhiker's Guide to the Galaxy", + slug="hitchhikers-guide-to-the-galaxy", ), ), ) """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/live", - method="POST", - json=convert_and_respect_annotation_metadata( - object_=request, annotation=ItemsCreateItemLiveRequest, direction="write" - ), - request_options=request_options, - omit=OMIT, + _response = self._raw_client.create_item_live( + collection_id, request=request, skip_invalid_files=skip_invalid_files, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CollectionItem, - parse_obj_as( - type_=CollectionItem, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def delete_items_live( self, collection_id: str, *, - items: typing.Optional[typing.Sequence[ItemsDeleteItemsLiveRequestItemsItem]] = OMIT, + items: typing.Sequence[ItemsDeleteItemsLiveRequestItemsItem], request_options: typing.Optional[RequestOptions] = None, ) -> None: """ - Remove an item or multiple items (up to 100 items) from the live site. Deleting published items will unpublish the items from the live site and set them to draft. + Unpublish up to 100 items from the live site and set the `isDraft` property to `true`. - **Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be unpublished only in the primary locale. + Items will only be unpublished in the primary locale unless a `cmsLocaleId` is included in the request. Required scope | `CMS:write` @@ -868,7 +507,7 @@ def delete_items_live( collection_id : str Unique identifier for a Collection - items : typing.Optional[typing.Sequence[ItemsDeleteItemsLiveRequestItemsItem]] + items : typing.Sequence[ItemsDeleteItemsLiveRequestItemsItem] request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -880,97 +519,37 @@ def delete_items_live( Examples -------- from webflow import Webflow + from webflow.resources.collections.resources.items import ( + ItemsDeleteItemsLiveRequestItemsItem, + ) client = Webflow( access_token="YOUR_ACCESS_TOKEN", ) client.collections.items.delete_items_live( collection_id="580e63fc8c9a982ac9b8b745", + items=[ + ItemsDeleteItemsLiveRequestItemsItem( + id="580e64008c9a982ac9b8b754", + ) + ], ) """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/live", - method="DELETE", - json={ - "items": convert_and_respect_annotation_metadata( - object_=items, annotation=typing.Sequence[ItemsDeleteItemsLiveRequestItemsItem], direction="write" - ), - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, - ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.delete_items_live(collection_id, items=items, request_options=request_options) + return _response.data def update_items_live( self, collection_id: str, *, + skip_invalid_files: typing.Optional[bool] = None, items: typing.Optional[typing.Sequence[CollectionItemWithIdInput]] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> CollectionItemListNoPagination: """ - Update a single live item or multiple live items (up to 100) in a Collection + Update a single published item or multiple published items (up to 100) in a Collection - **Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be updated only in the primary locale. + Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request. Required scope | `CMS:write` @@ -979,6 +558,9 @@ def update_items_live( collection_id : str Unique identifier for a Collection + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + items : typing.Optional[typing.Sequence[CollectionItemWithIdInput]] request_options : typing.Optional[RequestOptions] @@ -1002,6 +584,7 @@ def update_items_live( ) client.collections.items.update_items_live( collection_id="580e63fc8c9a982ac9b8b745", + skip_invalid_files=True, items=[ CollectionItemWithIdInput( id="66f6ed9576ddacf3149d5ea6", @@ -1038,89 +621,17 @@ def update_items_live( ], ) """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/live", - method="PATCH", - json={ - "items": convert_and_respect_annotation_metadata( - object_=items, annotation=typing.Sequence[CollectionItemWithIdInput], direction="write" - ), - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, + _response = self._raw_client.update_items_live( + collection_id, skip_invalid_files=skip_invalid_files, items=items, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CollectionItemListNoPagination, - parse_obj_as( - type_=CollectionItemListNoPagination, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def create_items( self, collection_id: str, *, field_data: CreateBulkCollectionItemRequestBodyFieldData, + skip_invalid_files: typing.Optional[bool] = None, cms_locale_ids: typing.Optional[typing.Sequence[str]] = OMIT, is_archived: typing.Optional[bool] = OMIT, is_draft: typing.Optional[bool] = OMIT, @@ -1129,9 +640,10 @@ def create_items( """ Create an item or multiple items in a CMS Collection across multiple corresponding locales. - **Notes:** + - This endpoint can create up to 100 items in a request. - - If the `cmsLocaleIds` parameter is undefined or empty and localization is enabled, items will only be created in the primary locale. + - If the `cmsLocaleIds` parameter is not included in the request, an item will only be created in the primary locale. + Required scope | `CMS:write` @@ -1142,6 +654,9 @@ def create_items( field_data : CreateBulkCollectionItemRequestBodyFieldData + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + cms_locale_ids : typing.Optional[typing.Sequence[str]] Array of identifiers for the locales where the item will be created @@ -1169,6 +684,7 @@ def create_items( ) client.collections.items.create_items( collection_id="580e63fc8c9a982ac9b8b745", + skip_invalid_files=True, cms_locale_ids=[ "66f6e966c9e1dc700a857ca3", "66f6e966c9e1dc700a857ca4", @@ -1182,86 +698,16 @@ def create_items( ), ) """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/bulk", - method="POST", - json={ - "cmsLocaleIds": cms_locale_ids, - "isArchived": is_archived, - "isDraft": is_draft, - "fieldData": convert_and_respect_annotation_metadata( - object_=field_data, annotation=CreateBulkCollectionItemRequestBodyFieldData, direction="write" - ), - }, - headers={ - "content-type": "application/json", - }, + _response = self._raw_client.create_items( + collection_id, + field_data=field_data, + skip_invalid_files=skip_invalid_files, + cms_locale_ids=cms_locale_ids, + is_archived=is_archived, + is_draft=is_draft, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - BulkCollectionItem, - parse_obj_as( - type_=BulkCollectionItem, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def get_item( self, @@ -1305,79 +751,13 @@ def get_item( client.collections.items.get_item( collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754", + cms_locale_id="cmsLocaleId", ) """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}", - method="GET", - params={ - "cmsLocaleId": cms_locale_id, - }, - request_options=request_options, + _response = self._raw_client.get_item( + collection_id, item_id, cms_locale_id=cms_locale_id, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CollectionItem, - parse_obj_as( - type_=CollectionItem, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def delete_item( self, @@ -1388,7 +768,7 @@ def delete_item( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ - Delete an Item from a Collection. This endpoint does not currently support bulk deletion. + Delete an item from a collection. Required scope | `CMS:write` @@ -1420,79 +800,20 @@ def delete_item( client.collections.items.delete_item( collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754", + cms_locale_id="cmsLocaleId", ) """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}", - method="DELETE", - params={ - "cmsLocaleId": cms_locale_id, - }, - request_options=request_options, + _response = self._raw_client.delete_item( + collection_id, item_id, cms_locale_id=cms_locale_id, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def update_item( self, collection_id: str, item_id: str, *, + skip_invalid_files: typing.Optional[bool] = None, id: typing.Optional[str] = OMIT, cms_locale_id: typing.Optional[str] = OMIT, last_published: typing.Optional[str] = OMIT, @@ -1516,6 +837,9 @@ def update_item( item_id : str Unique identifier for an Item + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + id : typing.Optional[str] Unique identifier for the Item @@ -1557,95 +881,30 @@ def update_item( client.collections.items.update_item( collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754", + skip_invalid_files=True, is_archived=False, is_draft=False, field_data=CollectionItemPatchSingleFieldData( - name="Pan Galactic Gargle Blaster Recipe", - slug="pan-galactic-gargle-blaster", + name="The Hitchhiker's Guide to the Galaxy", + slug="hitchhikers-guide-to-the-galaxy", ), ) """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}", - method="PATCH", - json={ - "id": id, - "cmsLocaleId": cms_locale_id, - "lastPublished": last_published, - "lastUpdated": last_updated, - "createdOn": created_on, - "isArchived": is_archived, - "isDraft": is_draft, - "fieldData": convert_and_respect_annotation_metadata( - object_=field_data, annotation=CollectionItemPatchSingleFieldData, direction="write" - ), - }, + _response = self._raw_client.update_item( + collection_id, + item_id, + skip_invalid_files=skip_invalid_files, + id=id, + cms_locale_id=cms_locale_id, + last_published=last_published, + last_updated=last_updated, + created_on=created_on, + is_archived=is_archived, + is_draft=is_draft, + field_data=field_data, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CollectionItem, - parse_obj_as( - type_=CollectionItem, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def get_item_live( self, @@ -1658,6 +917,10 @@ def get_item_live( """ Get details of a selected Collection live Item. + + Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations. + + Required scope | `CMS:read` Parameters @@ -1689,79 +952,13 @@ def get_item_live( client.collections.items.get_item_live( collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754", + cms_locale_id="cmsLocaleId", ) """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}/live", - method="GET", - params={ - "cmsLocaleId": cms_locale_id, - }, - request_options=request_options, + _response = self._raw_client.get_item_live( + collection_id, item_id, cms_locale_id=cms_locale_id, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CollectionItem, - parse_obj_as( - type_=CollectionItem, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def delete_item_live( self, @@ -1772,9 +969,9 @@ def delete_item_live( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ - Remove a live item from the site. Removing a published item will unpublish the item from the live site and set it to draft. + Unpublish a live item from the site and set the `isDraft` property to `true`. - This endpoint does not currently support bulk deletion. + For bulk unpublishing, please use [this endpoint.](/data/v2.0.0/reference/cms/collection-items/live-items/delete-items-live) Required scope | `CMS:write` @@ -1806,79 +1003,20 @@ def delete_item_live( client.collections.items.delete_item_live( collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754", + cms_locale_id="cmsLocaleId", ) """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}/live", - method="DELETE", - params={ - "cmsLocaleId": cms_locale_id, - }, - request_options=request_options, + _response = self._raw_client.delete_item_live( + collection_id, item_id, cms_locale_id=cms_locale_id, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def update_item_live( self, collection_id: str, item_id: str, *, + skip_invalid_files: typing.Optional[bool] = None, id: typing.Optional[str] = OMIT, cms_locale_id: typing.Optional[str] = OMIT, last_published: typing.Optional[str] = OMIT, @@ -1902,6 +1040,9 @@ def update_item_live( item_id : str Unique identifier for an Item + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + id : typing.Optional[str] Unique identifier for the Item @@ -1943,101 +1084,36 @@ def update_item_live( client.collections.items.update_item_live( collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754", + skip_invalid_files=True, is_archived=False, is_draft=False, field_data=CollectionItemPatchSingleFieldData( - name="Pan Galactic Gargle Blaster Recipe", - slug="pan-galactic-gargle-blaster", + name="The Hitchhiker's Guide to the Galaxy", + slug="hitchhikers-guide-to-the-galaxy", ), ) """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}/live", - method="PATCH", - json={ - "id": id, - "cmsLocaleId": cms_locale_id, - "lastPublished": last_published, - "lastUpdated": last_updated, - "createdOn": created_on, - "isArchived": is_archived, - "isDraft": is_draft, - "fieldData": convert_and_respect_annotation_metadata( - object_=field_data, annotation=CollectionItemPatchSingleFieldData, direction="write" - ), - }, + _response = self._raw_client.update_item_live( + collection_id, + item_id, + skip_invalid_files=skip_invalid_files, + id=id, + cms_locale_id=cms_locale_id, + last_published=last_published, + last_updated=last_updated, + created_on=created_on, + is_archived=is_archived, + is_draft=is_draft, + field_data=field_data, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CollectionItem, - parse_obj_as( - type_=CollectionItem, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def publish_item( self, collection_id: str, *, - item_ids: typing.Sequence[str], + request: ItemsPublishItemRequest, request_options: typing.Optional[RequestOptions] = None, ) -> ItemsPublishItemResponse: """ @@ -2050,7 +1126,7 @@ def publish_item( collection_id : str Unique identifier for a Collection - item_ids : typing.Sequence[str] + request : ItemsPublishItemRequest request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -2063,115 +1139,51 @@ def publish_item( Examples -------- from webflow import Webflow + from webflow.resources.collections.resources.items import ItemIDs client = Webflow( access_token="YOUR_ACCESS_TOKEN", ) client.collections.items.publish_item( collection_id="580e63fc8c9a982ac9b8b745", - item_ids=["itemIds"], + request=ItemIDs( + item_ids=[ + "643fd856d66b6528195ee2ca", + "643fd856d66b6528195ee2cb", + "643fd856d66b6528195ee2cc", + ], + ), ) """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/publish", - method="POST", - json={ - "itemIds": item_ids, - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ItemsPublishItemResponse, - parse_obj_as( - type_=ItemsPublishItemResponse, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.publish_item(collection_id, request=request, request_options=request_options) + return _response.data class AsyncItemsClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = AsyncRawItemsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawItemsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawItemsClient + """ + return self._raw_client async def list_items( self, collection_id: str, *, cms_locale_id: typing.Optional[str] = None, - offset: typing.Optional[float] = None, - limit: typing.Optional[float] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, name: typing.Optional[str] = None, slug: typing.Optional[str] = None, + last_published: typing.Optional[ItemsListItemsRequestLastPublished] = None, sort_by: typing.Optional[ItemsListItemsRequestSortBy] = None, sort_order: typing.Optional[ItemsListItemsRequestSortOrder] = None, request_options: typing.Optional[RequestOptions] = None, @@ -2189,17 +1201,20 @@ async def list_items( cms_locale_id : typing.Optional[str] Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string. - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records - limit : typing.Optional[float] + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) name : typing.Optional[str] - The name of the item(s) + Filter by the exact name of the item(s) slug : typing.Optional[str] - The slug of the item + Filter by the exact slug of the item + + last_published : typing.Optional[ItemsListItemsRequestLastPublished] + Filter by the last published date of the item(s) sort_by : typing.Optional[ItemsListItemsRequestSortBy] Sort results by the provided value @@ -2229,101 +1244,45 @@ async def list_items( async def main() -> None: await client.collections.items.list_items( collection_id="580e63fc8c9a982ac9b8b745", + cms_locale_id="cmsLocaleId", + offset=1, + limit=1, + name="name", + slug="slug", + sort_by="lastPublished", + sort_order="asc", ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items", - method="GET", - params={ - "cmsLocaleId": cms_locale_id, - "offset": offset, - "limit": limit, - "name": name, - "slug": slug, - "sortBy": sort_by, - "sortOrder": sort_order, - }, + _response = await self._raw_client.list_items( + collection_id, + cms_locale_id=cms_locale_id, + offset=offset, + limit=limit, + name=name, + slug=slug, + last_published=last_published, + sort_by=sort_by, + sort_order=sort_order, request_options=request_options, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CollectionItemList, - parse_obj_as( - type_=CollectionItemList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def create_item( self, collection_id: str, *, - request: ItemsCreateItemRequest, + request: ItemsCreateItemRequestBody, + skip_invalid_files: typing.Optional[bool] = None, request_options: typing.Optional[RequestOptions] = None, ) -> CollectionItem: """ Create Item(s) in a Collection. - To create items across multiple locales, please use [this endpoint.](/v2.0.0/data/reference/cms/collection-items/staged-items/create-items) + To create items across multiple locales, please use [this endpoint.](/data/reference/cms/collection-items/staged-items/create-items) Required scope | `CMS:write` @@ -2332,7 +1291,10 @@ async def create_item( collection_id : str Unique identifier for a Collection - request : ItemsCreateItemRequest + request : ItemsCreateItemRequestBody + + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -2360,12 +1322,13 @@ async def create_item( async def main() -> None: await client.collections.items.create_item( collection_id="580e63fc8c9a982ac9b8b745", + skip_invalid_files=True, request=CollectionItemPostSingle( is_archived=False, is_draft=False, field_data=CollectionItemPostSingleFieldData( - name="Pan Galactic Gargle Blaster Recipe", - slug="pan-galactic-gargle-blaster", + name="The Hitchhiker's Guide to the Galaxy", + slug="hitchhikers-guide-to-the-galaxy", ), ), ) @@ -2373,90 +1336,22 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items", - method="POST", - json=convert_and_respect_annotation_metadata( - object_=request, annotation=ItemsCreateItemRequest, direction="write" - ), - request_options=request_options, - omit=OMIT, + _response = await self._raw_client.create_item( + collection_id, request=request, skip_invalid_files=skip_invalid_files, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CollectionItem, - parse_obj_as( - type_=CollectionItem, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def delete_items( self, collection_id: str, *, - items: typing.Optional[typing.Sequence[ItemsDeleteItemsRequestItemsItem]] = OMIT, + items: typing.Sequence[ItemsDeleteItemsRequestItemsItem], request_options: typing.Optional[RequestOptions] = None, ) -> None: """ Delete Items from a Collection. - **Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be deleted only in the primary locale. + Items will only be deleted in the primary locale unless a `cmsLocaleId` is included in the request. Required scope | `CMS:write` @@ -2465,7 +1360,7 @@ async def delete_items( collection_id : str Unique identifier for a Collection - items : typing.Optional[typing.Sequence[ItemsDeleteItemsRequestItemsItem]] + items : typing.Sequence[ItemsDeleteItemsRequestItemsItem] request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -2479,6 +1374,9 @@ async def delete_items( import asyncio from webflow import AsyncWebflow + from webflow.resources.collections.resources.items import ( + ItemsDeleteItemsRequestItemsItem, + ) client = AsyncWebflow( access_token="YOUR_ACCESS_TOKEN", @@ -2488,104 +1386,33 @@ async def delete_items( async def main() -> None: await client.collections.items.delete_items( collection_id="580e63fc8c9a982ac9b8b745", - ) - - - asyncio.run(main()) - """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items", - method="DELETE", - json={ - "items": convert_and_respect_annotation_metadata( - object_=items, annotation=typing.Sequence[ItemsDeleteItemsRequestItemsItem], direction="write" - ), - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, - ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), + items=[ + ItemsDeleteItemsRequestItemsItem( + id="580e64008c9a982ac9b8b754", ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + ], + ) + + + asyncio.run(main()) + """ + _response = await self._raw_client.delete_items(collection_id, items=items, request_options=request_options) + return _response.data async def update_items( self, collection_id: str, *, + skip_invalid_files: typing.Optional[bool] = None, items: typing.Optional[typing.Sequence[CollectionItemWithIdInput]] = OMIT, request_options: typing.Optional[RequestOptions] = None, - ) -> CollectionItem: + ) -> ItemsUpdateItemsResponse: """ - Update a single item or multiple items (up to 100) in a Collection. + Update a single item or multiple items in a Collection. + + The limit for this endpoint is 100 items. - **Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be updated only in the primary locale. + Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request. Required scope | `CMS:write` @@ -2594,6 +1421,9 @@ async def update_items( collection_id : str Unique identifier for a Collection + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + items : typing.Optional[typing.Sequence[CollectionItemWithIdInput]] request_options : typing.Optional[RequestOptions] @@ -2601,7 +1431,7 @@ async def update_items( Returns ------- - CollectionItem + ItemsUpdateItemsResponse Request was successful Examples @@ -2622,6 +1452,7 @@ async def update_items( async def main() -> None: await client.collections.items.update_items( collection_id="580e63fc8c9a982ac9b8b745", + skip_invalid_files=True, items=[ CollectionItemWithIdInput( id="66f6ed9576ddacf3149d5ea6", @@ -2661,99 +1492,31 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items", - method="PATCH", - json={ - "items": convert_and_respect_annotation_metadata( - object_=items, annotation=typing.Sequence[CollectionItemWithIdInput], direction="write" - ), - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, + _response = await self._raw_client.update_items( + collection_id, skip_invalid_files=skip_invalid_files, items=items, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CollectionItem, - parse_obj_as( - type_=CollectionItem, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def list_items_live( self, collection_id: str, *, cms_locale_id: typing.Optional[str] = None, - offset: typing.Optional[float] = None, - limit: typing.Optional[float] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, name: typing.Optional[str] = None, slug: typing.Optional[str] = None, + last_published: typing.Optional[ItemsListItemsLiveRequestLastPublished] = None, sort_by: typing.Optional[ItemsListItemsLiveRequestSortBy] = None, sort_order: typing.Optional[ItemsListItemsLiveRequestSortOrder] = None, request_options: typing.Optional[RequestOptions] = None, ) -> CollectionItemList: """ - List of all live Items within a Collection. + List all published items in a collection. + + + Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations. + Required scope | `CMS:read` @@ -2765,17 +1528,20 @@ async def list_items_live( cms_locale_id : typing.Optional[str] Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string. - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records - limit : typing.Optional[float] + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) name : typing.Optional[str] - The name of the item(s) + Filter by the exact name of the item(s) slug : typing.Optional[str] - The slug of the item + Filter by the exact slug of the item + + last_published : typing.Optional[ItemsListItemsLiveRequestLastPublished] + Filter by the last published date of the item(s) sort_by : typing.Optional[ItemsListItemsLiveRequestSortBy] Sort results by the provided value @@ -2805,101 +1571,45 @@ async def list_items_live( async def main() -> None: await client.collections.items.list_items_live( collection_id="580e63fc8c9a982ac9b8b745", + cms_locale_id="cmsLocaleId", + offset=1, + limit=1, + name="name", + slug="slug", + sort_by="lastPublished", + sort_order="asc", ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/live", - method="GET", - params={ - "cmsLocaleId": cms_locale_id, - "offset": offset, - "limit": limit, - "name": name, - "slug": slug, - "sortBy": sort_by, - "sortOrder": sort_order, - }, + _response = await self._raw_client.list_items_live( + collection_id, + cms_locale_id=cms_locale_id, + offset=offset, + limit=limit, + name=name, + slug=slug, + last_published=last_published, + sort_by=sort_by, + sort_order=sort_order, request_options=request_options, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CollectionItemList, - parse_obj_as( - type_=CollectionItemList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def create_item_live( self, collection_id: str, *, - request: ItemsCreateItemLiveRequest, + request: ItemsCreateItemLiveRequestBody, + skip_invalid_files: typing.Optional[bool] = None, request_options: typing.Optional[RequestOptions] = None, ) -> CollectionItem: """ - Create live Item(s) in a Collection. The Item(s) will be published to the live site. + Create item(s) in a collection that will be immediately published to the live site. - To create items across multiple locales, [please use this endpoint.](/v2.0.0/data/reference/cms/collection-items/staged-items/create-items) + To create items across multiple locales, [please use this endpoint.](/data/reference/cms/collection-items/staged-items/create-items) Required scope | `CMS:write` @@ -2909,7 +1619,10 @@ async def create_item_live( collection_id : str Unique identifier for a Collection - request : ItemsCreateItemLiveRequest + request : ItemsCreateItemLiveRequestBody + + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -2933,12 +1646,13 @@ async def create_item_live( async def main() -> None: await client.collections.items.create_item_live( collection_id="580e63fc8c9a982ac9b8b745", + skip_invalid_files=True, request=CollectionItem( is_archived=False, is_draft=False, field_data=CollectionItemFieldData( - name="Pan Galactic Gargle Blaster Recipe", - slug="pan-galactic-gargle-blaster", + name="The Hitchhiker's Guide to the Galaxy", + slug="hitchhikers-guide-to-the-galaxy", ), ), ) @@ -2946,90 +1660,22 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/live", - method="POST", - json=convert_and_respect_annotation_metadata( - object_=request, annotation=ItemsCreateItemLiveRequest, direction="write" - ), - request_options=request_options, - omit=OMIT, + _response = await self._raw_client.create_item_live( + collection_id, request=request, skip_invalid_files=skip_invalid_files, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CollectionItem, - parse_obj_as( - type_=CollectionItem, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def delete_items_live( self, collection_id: str, *, - items: typing.Optional[typing.Sequence[ItemsDeleteItemsLiveRequestItemsItem]] = OMIT, + items: typing.Sequence[ItemsDeleteItemsLiveRequestItemsItem], request_options: typing.Optional[RequestOptions] = None, ) -> None: """ - Remove an item or multiple items (up to 100 items) from the live site. Deleting published items will unpublish the items from the live site and set them to draft. + Unpublish up to 100 items from the live site and set the `isDraft` property to `true`. - **Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be unpublished only in the primary locale. + Items will only be unpublished in the primary locale unless a `cmsLocaleId` is included in the request. Required scope | `CMS:write` @@ -3038,7 +1684,7 @@ async def delete_items_live( collection_id : str Unique identifier for a Collection - items : typing.Optional[typing.Sequence[ItemsDeleteItemsLiveRequestItemsItem]] + items : typing.Sequence[ItemsDeleteItemsLiveRequestItemsItem] request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -3052,6 +1698,9 @@ async def delete_items_live( import asyncio from webflow import AsyncWebflow + from webflow.resources.collections.resources.items import ( + ItemsDeleteItemsLiveRequestItemsItem, + ) client = AsyncWebflow( access_token="YOUR_ACCESS_TOKEN", @@ -3061,94 +1710,33 @@ async def delete_items_live( async def main() -> None: await client.collections.items.delete_items_live( collection_id="580e63fc8c9a982ac9b8b745", + items=[ + ItemsDeleteItemsLiveRequestItemsItem( + id="580e64008c9a982ac9b8b754", + ) + ], ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/live", - method="DELETE", - json={ - "items": convert_and_respect_annotation_metadata( - object_=items, annotation=typing.Sequence[ItemsDeleteItemsLiveRequestItemsItem], direction="write" - ), - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, + _response = await self._raw_client.delete_items_live( + collection_id, items=items, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def update_items_live( self, collection_id: str, *, + skip_invalid_files: typing.Optional[bool] = None, items: typing.Optional[typing.Sequence[CollectionItemWithIdInput]] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> CollectionItemListNoPagination: """ - Update a single live item or multiple live items (up to 100) in a Collection + Update a single published item or multiple published items (up to 100) in a Collection - **Note:** If the `cmsLocaleId` parameter is undefined or empty and the items are localized, items will be updated only in the primary locale. + Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request. Required scope | `CMS:write` @@ -3157,6 +1745,9 @@ async def update_items_live( collection_id : str Unique identifier for a Collection + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + items : typing.Optional[typing.Sequence[CollectionItemWithIdInput]] request_options : typing.Optional[RequestOptions] @@ -3185,6 +1776,7 @@ async def update_items_live( async def main() -> None: await client.collections.items.update_items_live( collection_id="580e63fc8c9a982ac9b8b745", + skip_invalid_files=True, items=[ CollectionItemWithIdInput( id="66f6ed9576ddacf3149d5ea6", @@ -3224,89 +1816,17 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/live", - method="PATCH", - json={ - "items": convert_and_respect_annotation_metadata( - object_=items, annotation=typing.Sequence[CollectionItemWithIdInput], direction="write" - ), - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, + _response = await self._raw_client.update_items_live( + collection_id, skip_invalid_files=skip_invalid_files, items=items, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CollectionItemListNoPagination, - parse_obj_as( - type_=CollectionItemListNoPagination, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def create_items( self, collection_id: str, *, field_data: CreateBulkCollectionItemRequestBodyFieldData, + skip_invalid_files: typing.Optional[bool] = None, cms_locale_ids: typing.Optional[typing.Sequence[str]] = OMIT, is_archived: typing.Optional[bool] = OMIT, is_draft: typing.Optional[bool] = OMIT, @@ -3315,9 +1835,10 @@ async def create_items( """ Create an item or multiple items in a CMS Collection across multiple corresponding locales. - **Notes:** + - This endpoint can create up to 100 items in a request. - - If the `cmsLocaleIds` parameter is undefined or empty and localization is enabled, items will only be created in the primary locale. + - If the `cmsLocaleIds` parameter is not included in the request, an item will only be created in the primary locale. + Required scope | `CMS:write` @@ -3328,6 +1849,9 @@ async def create_items( field_data : CreateBulkCollectionItemRequestBodyFieldData + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + cms_locale_ids : typing.Optional[typing.Sequence[str]] Array of identifiers for the locales where the item will be created @@ -3360,6 +1884,7 @@ async def create_items( async def main() -> None: await client.collections.items.create_items( collection_id="580e63fc8c9a982ac9b8b745", + skip_invalid_files=True, cms_locale_ids=[ "66f6e966c9e1dc700a857ca3", "66f6e966c9e1dc700a857ca4", @@ -3376,86 +1901,16 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/bulk", - method="POST", - json={ - "cmsLocaleIds": cms_locale_ids, - "isArchived": is_archived, - "isDraft": is_draft, - "fieldData": convert_and_respect_annotation_metadata( - object_=field_data, annotation=CreateBulkCollectionItemRequestBodyFieldData, direction="write" - ), - }, - headers={ - "content-type": "application/json", - }, + _response = await self._raw_client.create_items( + collection_id, + field_data=field_data, + skip_invalid_files=skip_invalid_files, + cms_locale_ids=cms_locale_ids, + is_archived=is_archived, + is_draft=is_draft, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - BulkCollectionItem, - parse_obj_as( - type_=BulkCollectionItem, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def get_item( self, @@ -3504,82 +1959,16 @@ async def main() -> None: await client.collections.items.get_item( collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754", + cms_locale_id="cmsLocaleId", ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}", - method="GET", - params={ - "cmsLocaleId": cms_locale_id, - }, - request_options=request_options, + _response = await self._raw_client.get_item( + collection_id, item_id, cms_locale_id=cms_locale_id, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CollectionItem, - parse_obj_as( - type_=CollectionItem, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def delete_item( self, @@ -3590,7 +1979,7 @@ async def delete_item( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ - Delete an Item from a Collection. This endpoint does not currently support bulk deletion. + Delete an item from a collection. Required scope | `CMS:write` @@ -3627,82 +2016,23 @@ async def main() -> None: await client.collections.items.delete_item( collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754", + cms_locale_id="cmsLocaleId", ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}", - method="DELETE", - params={ - "cmsLocaleId": cms_locale_id, - }, - request_options=request_options, + _response = await self._raw_client.delete_item( + collection_id, item_id, cms_locale_id=cms_locale_id, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def update_item( self, collection_id: str, item_id: str, *, + skip_invalid_files: typing.Optional[bool] = None, id: typing.Optional[str] = OMIT, cms_locale_id: typing.Optional[str] = OMIT, last_published: typing.Optional[str] = OMIT, @@ -3726,6 +2056,9 @@ async def update_item( item_id : str Unique identifier for an Item + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + id : typing.Optional[str] Unique identifier for the Item @@ -3772,98 +2105,33 @@ async def main() -> None: await client.collections.items.update_item( collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754", + skip_invalid_files=True, is_archived=False, is_draft=False, field_data=CollectionItemPatchSingleFieldData( - name="Pan Galactic Gargle Blaster Recipe", - slug="pan-galactic-gargle-blaster", + name="The Hitchhiker's Guide to the Galaxy", + slug="hitchhikers-guide-to-the-galaxy", ), ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}", - method="PATCH", - json={ - "id": id, - "cmsLocaleId": cms_locale_id, - "lastPublished": last_published, - "lastUpdated": last_updated, - "createdOn": created_on, - "isArchived": is_archived, - "isDraft": is_draft, - "fieldData": convert_and_respect_annotation_metadata( - object_=field_data, annotation=CollectionItemPatchSingleFieldData, direction="write" - ), - }, + _response = await self._raw_client.update_item( + collection_id, + item_id, + skip_invalid_files=skip_invalid_files, + id=id, + cms_locale_id=cms_locale_id, + last_published=last_published, + last_updated=last_updated, + created_on=created_on, + is_archived=is_archived, + is_draft=is_draft, + field_data=field_data, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CollectionItem, - parse_obj_as( - type_=CollectionItem, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def get_item_live( self, @@ -3876,6 +2144,10 @@ async def get_item_live( """ Get details of a selected Collection live Item. + + Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations. + + Required scope | `CMS:read` Parameters @@ -3912,82 +2184,16 @@ async def main() -> None: await client.collections.items.get_item_live( collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754", + cms_locale_id="cmsLocaleId", ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}/live", - method="GET", - params={ - "cmsLocaleId": cms_locale_id, - }, - request_options=request_options, + _response = await self._raw_client.get_item_live( + collection_id, item_id, cms_locale_id=cms_locale_id, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CollectionItem, - parse_obj_as( - type_=CollectionItem, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def delete_item_live( self, @@ -3998,9 +2204,9 @@ async def delete_item_live( request_options: typing.Optional[RequestOptions] = None, ) -> None: """ - Remove a live item from the site. Removing a published item will unpublish the item from the live site and set it to draft. + Unpublish a live item from the site and set the `isDraft` property to `true`. - This endpoint does not currently support bulk deletion. + For bulk unpublishing, please use [this endpoint.](/data/v2.0.0/reference/cms/collection-items/live-items/delete-items-live) Required scope | `CMS:write` @@ -4037,82 +2243,23 @@ async def main() -> None: await client.collections.items.delete_item_live( collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754", + cms_locale_id="cmsLocaleId", ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}/live", - method="DELETE", - params={ - "cmsLocaleId": cms_locale_id, - }, - request_options=request_options, + _response = await self._raw_client.delete_item_live( + collection_id, item_id, cms_locale_id=cms_locale_id, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def update_item_live( self, collection_id: str, item_id: str, *, + skip_invalid_files: typing.Optional[bool] = None, id: typing.Optional[str] = OMIT, cms_locale_id: typing.Optional[str] = OMIT, last_published: typing.Optional[str] = OMIT, @@ -4136,6 +2283,9 @@ async def update_item_live( item_id : str Unique identifier for an Item + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + id : typing.Optional[str] Unique identifier for the Item @@ -4182,104 +2332,39 @@ async def main() -> None: await client.collections.items.update_item_live( collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754", + skip_invalid_files=True, is_archived=False, is_draft=False, field_data=CollectionItemPatchSingleFieldData( - name="Pan Galactic Gargle Blaster Recipe", - slug="pan-galactic-gargle-blaster", + name="The Hitchhiker's Guide to the Galaxy", + slug="hitchhikers-guide-to-the-galaxy", ), ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}/live", - method="PATCH", - json={ - "id": id, - "cmsLocaleId": cms_locale_id, - "lastPublished": last_published, - "lastUpdated": last_updated, - "createdOn": created_on, - "isArchived": is_archived, - "isDraft": is_draft, - "fieldData": convert_and_respect_annotation_metadata( - object_=field_data, annotation=CollectionItemPatchSingleFieldData, direction="write" - ), - }, + _response = await self._raw_client.update_item_live( + collection_id, + item_id, + skip_invalid_files=skip_invalid_files, + id=id, + cms_locale_id=cms_locale_id, + last_published=last_published, + last_updated=last_updated, + created_on=created_on, + is_archived=is_archived, + is_draft=is_draft, + field_data=field_data, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CollectionItem, - parse_obj_as( - type_=CollectionItem, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def publish_item( self, collection_id: str, *, - item_ids: typing.Sequence[str], + request: ItemsPublishItemRequest, request_options: typing.Optional[RequestOptions] = None, ) -> ItemsPublishItemResponse: """ @@ -4292,7 +2377,7 @@ async def publish_item( collection_id : str Unique identifier for a Collection - item_ids : typing.Sequence[str] + request : ItemsPublishItemRequest request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -4307,6 +2392,7 @@ async def publish_item( import asyncio from webflow import AsyncWebflow + from webflow.resources.collections.resources.items import ItemIDs client = AsyncWebflow( access_token="YOUR_ACCESS_TOKEN", @@ -4316,94 +2402,17 @@ async def publish_item( async def main() -> None: await client.collections.items.publish_item( collection_id="580e63fc8c9a982ac9b8b745", - item_ids=["itemIds"], + request=ItemIDs( + item_ids=[ + "643fd856d66b6528195ee2ca", + "643fd856d66b6528195ee2cb", + "643fd856d66b6528195ee2cc", + ], + ), ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/publish", - method="POST", - json={ - "itemIds": item_ids, - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ItemsPublishItemResponse, - parse_obj_as( - type_=ItemsPublishItemResponse, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.publish_item(collection_id, request=request, request_options=request_options) + return _response.data diff --git a/src/webflow/resources/collections/resources/items/raw_client.py b/src/webflow/resources/collections/resources/items/raw_client.py new file mode 100644 index 0000000..010bbfd --- /dev/null +++ b/src/webflow/resources/collections/resources/items/raw_client.py @@ -0,0 +1,4246 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from .....core.api_error import ApiError +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from .....core.http_response import AsyncHttpResponse, HttpResponse +from .....core.jsonable_encoder import jsonable_encoder +from .....core.parse_error import ParsingError +from .....core.pydantic_utilities import parse_obj_as +from .....core.request_options import RequestOptions +from .....core.serialization import convert_and_respect_annotation_metadata +from .....errors.bad_request_error import BadRequestError +from .....errors.conflict_error import ConflictError +from .....errors.internal_server_error import InternalServerError +from .....errors.not_found_error import NotFoundError +from .....errors.too_many_requests_error import TooManyRequestsError +from .....errors.unauthorized_error import UnauthorizedError +from .....types.bulk_collection_item import BulkCollectionItem +from .....types.collection_item import CollectionItem +from .....types.collection_item_list import CollectionItemList +from .....types.collection_item_list_no_pagination import CollectionItemListNoPagination +from .....types.collection_item_patch_single_field_data import CollectionItemPatchSingleFieldData +from .....types.collection_item_with_id_input import CollectionItemWithIdInput +from .....types.error import Error +from .....types.items_list_items_live_request_last_published import ItemsListItemsLiveRequestLastPublished +from .....types.items_list_items_request_last_published import ItemsListItemsRequestLastPublished +from .types.create_bulk_collection_item_request_body_field_data import CreateBulkCollectionItemRequestBodyFieldData +from .types.items_create_item_live_request_body import ItemsCreateItemLiveRequestBody +from .types.items_create_item_request_body import ItemsCreateItemRequestBody +from .types.items_delete_items_live_request_items_item import ItemsDeleteItemsLiveRequestItemsItem +from .types.items_delete_items_request_items_item import ItemsDeleteItemsRequestItemsItem +from .types.items_list_items_live_request_sort_by import ItemsListItemsLiveRequestSortBy +from .types.items_list_items_live_request_sort_order import ItemsListItemsLiveRequestSortOrder +from .types.items_list_items_request_sort_by import ItemsListItemsRequestSortBy +from .types.items_list_items_request_sort_order import ItemsListItemsRequestSortOrder +from .types.items_publish_item_request import ItemsPublishItemRequest +from .types.items_publish_item_response import ItemsPublishItemResponse +from .types.items_update_items_response import ItemsUpdateItemsResponse +from pydantic import ValidationError + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawItemsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def list_items( + self, + collection_id: str, + *, + cms_locale_id: typing.Optional[str] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + name: typing.Optional[str] = None, + slug: typing.Optional[str] = None, + last_published: typing.Optional[ItemsListItemsRequestLastPublished] = None, + sort_by: typing.Optional[ItemsListItemsRequestSortBy] = None, + sort_order: typing.Optional[ItemsListItemsRequestSortOrder] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CollectionItemList]: + """ + List of all Items within a Collection. + + Required scope | `CMS:read` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + cms_locale_id : typing.Optional[str] + Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string. + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + name : typing.Optional[str] + Filter by the exact name of the item(s) + + slug : typing.Optional[str] + Filter by the exact slug of the item + + last_published : typing.Optional[ItemsListItemsRequestLastPublished] + Filter by the last published date of the item(s) + + sort_by : typing.Optional[ItemsListItemsRequestSortBy] + Sort results by the provided value + + sort_order : typing.Optional[ItemsListItemsRequestSortOrder] + Sorts the results by asc or desc + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CollectionItemList] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "cmsLocaleId": cms_locale_id, + "offset": offset, + "limit": limit, + "name": name, + "slug": slug, + "lastPublished": convert_and_respect_annotation_metadata( + object_=last_published, annotation=ItemsListItemsRequestLastPublished, direction="write" + ), + "sortBy": sort_by, + "sortOrder": sort_order, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CollectionItemList, + parse_obj_as( + type_=CollectionItemList, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def create_item( + self, + collection_id: str, + *, + request: ItemsCreateItemRequestBody, + skip_invalid_files: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CollectionItem]: + """ + Create Item(s) in a Collection. + + + To create items across multiple locales, please use [this endpoint.](/data/reference/cms/collection-items/staged-items/create-items) + + Required scope | `CMS:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + request : ItemsCreateItemRequestBody + + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CollectionItem] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items", + base_url=self._client_wrapper.get_environment().base, + method="POST", + params={ + "skipInvalidFiles": skip_invalid_files, + }, + json=convert_and_respect_annotation_metadata( + object_=request, annotation=ItemsCreateItemRequestBody, direction="write" + ), + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CollectionItem, + parse_obj_as( + type_=CollectionItem, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def delete_items( + self, + collection_id: str, + *, + items: typing.Sequence[ItemsDeleteItemsRequestItemsItem], + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[None]: + """ + Delete Items from a Collection. + + Items will only be deleted in the primary locale unless a `cmsLocaleId` is included in the request. + + Required scope | `CMS:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + items : typing.Sequence[ItemsDeleteItemsRequestItemsItem] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[None] + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + json={ + "items": convert_and_respect_annotation_metadata( + object_=items, annotation=typing.Sequence[ItemsDeleteItemsRequestItemsItem], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + return HttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def update_items( + self, + collection_id: str, + *, + skip_invalid_files: typing.Optional[bool] = None, + items: typing.Optional[typing.Sequence[CollectionItemWithIdInput]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[ItemsUpdateItemsResponse]: + """ + Update a single item or multiple items in a Collection. + + The limit for this endpoint is 100 items. + + Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request. + + Required scope | `CMS:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + + items : typing.Optional[typing.Sequence[CollectionItemWithIdInput]] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ItemsUpdateItemsResponse] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + params={ + "skipInvalidFiles": skip_invalid_files, + }, + json={ + "items": convert_and_respect_annotation_metadata( + object_=items, annotation=typing.Sequence[CollectionItemWithIdInput], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ItemsUpdateItemsResponse, + parse_obj_as( + type_=ItemsUpdateItemsResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def list_items_live( + self, + collection_id: str, + *, + cms_locale_id: typing.Optional[str] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + name: typing.Optional[str] = None, + slug: typing.Optional[str] = None, + last_published: typing.Optional[ItemsListItemsLiveRequestLastPublished] = None, + sort_by: typing.Optional[ItemsListItemsLiveRequestSortBy] = None, + sort_order: typing.Optional[ItemsListItemsLiveRequestSortOrder] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CollectionItemList]: + """ + List all published items in a collection. + + + Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations. + + + Required scope | `CMS:read` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + cms_locale_id : typing.Optional[str] + Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string. + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + name : typing.Optional[str] + Filter by the exact name of the item(s) + + slug : typing.Optional[str] + Filter by the exact slug of the item + + last_published : typing.Optional[ItemsListItemsLiveRequestLastPublished] + Filter by the last published date of the item(s) + + sort_by : typing.Optional[ItemsListItemsLiveRequestSortBy] + Sort results by the provided value + + sort_order : typing.Optional[ItemsListItemsLiveRequestSortOrder] + Sorts the results by asc or desc + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CollectionItemList] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/live", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "cmsLocaleId": cms_locale_id, + "offset": offset, + "limit": limit, + "name": name, + "slug": slug, + "lastPublished": convert_and_respect_annotation_metadata( + object_=last_published, annotation=ItemsListItemsLiveRequestLastPublished, direction="write" + ), + "sortBy": sort_by, + "sortOrder": sort_order, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CollectionItemList, + parse_obj_as( + type_=CollectionItemList, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def create_item_live( + self, + collection_id: str, + *, + request: ItemsCreateItemLiveRequestBody, + skip_invalid_files: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CollectionItem]: + """ + Create item(s) in a collection that will be immediately published to the live site. + + + To create items across multiple locales, [please use this endpoint.](/data/reference/cms/collection-items/staged-items/create-items) + + + Required scope | `CMS:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + request : ItemsCreateItemLiveRequestBody + + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CollectionItem] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/live", + base_url=self._client_wrapper.get_environment().base, + method="POST", + params={ + "skipInvalidFiles": skip_invalid_files, + }, + json=convert_and_respect_annotation_metadata( + object_=request, annotation=ItemsCreateItemLiveRequestBody, direction="write" + ), + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CollectionItem, + parse_obj_as( + type_=CollectionItem, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def delete_items_live( + self, + collection_id: str, + *, + items: typing.Sequence[ItemsDeleteItemsLiveRequestItemsItem], + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[None]: + """ + Unpublish up to 100 items from the live site and set the `isDraft` property to `true`. + + Items will only be unpublished in the primary locale unless a `cmsLocaleId` is included in the request. + + Required scope | `CMS:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + items : typing.Sequence[ItemsDeleteItemsLiveRequestItemsItem] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[None] + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/live", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + json={ + "items": convert_and_respect_annotation_metadata( + object_=items, annotation=typing.Sequence[ItemsDeleteItemsLiveRequestItemsItem], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + return HttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def update_items_live( + self, + collection_id: str, + *, + skip_invalid_files: typing.Optional[bool] = None, + items: typing.Optional[typing.Sequence[CollectionItemWithIdInput]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CollectionItemListNoPagination]: + """ + Update a single published item or multiple published items (up to 100) in a Collection + + Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request. + + Required scope | `CMS:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + + items : typing.Optional[typing.Sequence[CollectionItemWithIdInput]] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CollectionItemListNoPagination] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/live", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + params={ + "skipInvalidFiles": skip_invalid_files, + }, + json={ + "items": convert_and_respect_annotation_metadata( + object_=items, annotation=typing.Sequence[CollectionItemWithIdInput], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CollectionItemListNoPagination, + parse_obj_as( + type_=CollectionItemListNoPagination, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def create_items( + self, + collection_id: str, + *, + field_data: CreateBulkCollectionItemRequestBodyFieldData, + skip_invalid_files: typing.Optional[bool] = None, + cms_locale_ids: typing.Optional[typing.Sequence[str]] = OMIT, + is_archived: typing.Optional[bool] = OMIT, + is_draft: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[BulkCollectionItem]: + """ + Create an item or multiple items in a CMS Collection across multiple corresponding locales. + + + - This endpoint can create up to 100 items in a request. + - If the `cmsLocaleIds` parameter is not included in the request, an item will only be created in the primary locale. + + + Required scope | `CMS:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + field_data : CreateBulkCollectionItemRequestBodyFieldData + + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + + cms_locale_ids : typing.Optional[typing.Sequence[str]] + Array of identifiers for the locales where the item will be created + + is_archived : typing.Optional[bool] + Indicates whether the item is archived. + + is_draft : typing.Optional[bool] + Indicates whether the item is in draft state. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[BulkCollectionItem] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/bulk", + base_url=self._client_wrapper.get_environment().base, + method="POST", + params={ + "skipInvalidFiles": skip_invalid_files, + }, + json={ + "cmsLocaleIds": cms_locale_ids, + "isArchived": is_archived, + "isDraft": is_draft, + "fieldData": convert_and_respect_annotation_metadata( + object_=field_data, annotation=CreateBulkCollectionItemRequestBodyFieldData, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkCollectionItem, + parse_obj_as( + type_=BulkCollectionItem, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def get_item( + self, + collection_id: str, + item_id: str, + *, + cms_locale_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CollectionItem]: + """ + Get details of a selected Collection Item. + + Required scope | `CMS:read` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + item_id : str + Unique identifier for an Item + + cms_locale_id : typing.Optional[str] + Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CollectionItem] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "cmsLocaleId": cms_locale_id, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CollectionItem, + parse_obj_as( + type_=CollectionItem, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def delete_item( + self, + collection_id: str, + item_id: str, + *, + cms_locale_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[None]: + """ + Delete an item from a collection. + + Required scope | `CMS:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + item_id : str + Unique identifier for an Item + + cms_locale_id : typing.Optional[str] + Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[None] + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + params={ + "cmsLocaleId": cms_locale_id, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return HttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def update_item( + self, + collection_id: str, + item_id: str, + *, + skip_invalid_files: typing.Optional[bool] = None, + id: typing.Optional[str] = OMIT, + cms_locale_id: typing.Optional[str] = OMIT, + last_published: typing.Optional[str] = OMIT, + last_updated: typing.Optional[str] = OMIT, + created_on: typing.Optional[str] = OMIT, + is_archived: typing.Optional[bool] = OMIT, + is_draft: typing.Optional[bool] = OMIT, + field_data: typing.Optional[CollectionItemPatchSingleFieldData] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CollectionItem]: + """ + Update a selected Item in a Collection. + + Required scope | `CMS:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + item_id : str + Unique identifier for an Item + + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + + id : typing.Optional[str] + Unique identifier for the Item + + cms_locale_id : typing.Optional[str] + Identifier for the locale of the CMS item + + last_published : typing.Optional[str] + The date the item was last published + + last_updated : typing.Optional[str] + The date the item was last updated + + created_on : typing.Optional[str] + The date the item was created + + is_archived : typing.Optional[bool] + Boolean determining if the Item is set to archived + + is_draft : typing.Optional[bool] + Boolean determining if the Item is set to draft + + field_data : typing.Optional[CollectionItemPatchSingleFieldData] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CollectionItem] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + params={ + "skipInvalidFiles": skip_invalid_files, + }, + json={ + "id": id, + "cmsLocaleId": cms_locale_id, + "lastPublished": last_published, + "lastUpdated": last_updated, + "createdOn": created_on, + "isArchived": is_archived, + "isDraft": is_draft, + "fieldData": convert_and_respect_annotation_metadata( + object_=field_data, annotation=CollectionItemPatchSingleFieldData, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CollectionItem, + parse_obj_as( + type_=CollectionItem, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def get_item_live( + self, + collection_id: str, + item_id: str, + *, + cms_locale_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CollectionItem]: + """ + Get details of a selected Collection live Item. + + + Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations. + + + Required scope | `CMS:read` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + item_id : str + Unique identifier for an Item + + cms_locale_id : typing.Optional[str] + Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CollectionItem] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}/live", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "cmsLocaleId": cms_locale_id, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CollectionItem, + parse_obj_as( + type_=CollectionItem, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def delete_item_live( + self, + collection_id: str, + item_id: str, + *, + cms_locale_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[None]: + """ + Unpublish a live item from the site and set the `isDraft` property to `true`. + + For bulk unpublishing, please use [this endpoint.](/data/v2.0.0/reference/cms/collection-items/live-items/delete-items-live) + + Required scope | `CMS:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + item_id : str + Unique identifier for an Item + + cms_locale_id : typing.Optional[str] + Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[None] + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}/live", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + params={ + "cmsLocaleId": cms_locale_id, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return HttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def update_item_live( + self, + collection_id: str, + item_id: str, + *, + skip_invalid_files: typing.Optional[bool] = None, + id: typing.Optional[str] = OMIT, + cms_locale_id: typing.Optional[str] = OMIT, + last_published: typing.Optional[str] = OMIT, + last_updated: typing.Optional[str] = OMIT, + created_on: typing.Optional[str] = OMIT, + is_archived: typing.Optional[bool] = OMIT, + is_draft: typing.Optional[bool] = OMIT, + field_data: typing.Optional[CollectionItemPatchSingleFieldData] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CollectionItem]: + """ + Update a selected live Item in a Collection. The updates for this Item will be published to the live site. + + Required scope | `CMS:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + item_id : str + Unique identifier for an Item + + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + + id : typing.Optional[str] + Unique identifier for the Item + + cms_locale_id : typing.Optional[str] + Identifier for the locale of the CMS item + + last_published : typing.Optional[str] + The date the item was last published + + last_updated : typing.Optional[str] + The date the item was last updated + + created_on : typing.Optional[str] + The date the item was created + + is_archived : typing.Optional[bool] + Boolean determining if the Item is set to archived + + is_draft : typing.Optional[bool] + Boolean determining if the Item is set to draft + + field_data : typing.Optional[CollectionItemPatchSingleFieldData] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CollectionItem] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}/live", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + params={ + "skipInvalidFiles": skip_invalid_files, + }, + json={ + "id": id, + "cmsLocaleId": cms_locale_id, + "lastPublished": last_published, + "lastUpdated": last_updated, + "createdOn": created_on, + "isArchived": is_archived, + "isDraft": is_draft, + "fieldData": convert_and_respect_annotation_metadata( + object_=field_data, annotation=CollectionItemPatchSingleFieldData, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CollectionItem, + parse_obj_as( + type_=CollectionItem, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def publish_item( + self, + collection_id: str, + *, + request: ItemsPublishItemRequest, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[ItemsPublishItemResponse]: + """ + Publish an item or multiple items. + + Required scope | `cms:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + request : ItemsPublishItemRequest + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ItemsPublishItemResponse] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/publish", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json=convert_and_respect_annotation_metadata( + object_=request, annotation=ItemsPublishItemRequest, direction="write" + ), + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ItemsPublishItemResponse, + parse_obj_as( + type_=ItemsPublishItemResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawItemsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def list_items( + self, + collection_id: str, + *, + cms_locale_id: typing.Optional[str] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + name: typing.Optional[str] = None, + slug: typing.Optional[str] = None, + last_published: typing.Optional[ItemsListItemsRequestLastPublished] = None, + sort_by: typing.Optional[ItemsListItemsRequestSortBy] = None, + sort_order: typing.Optional[ItemsListItemsRequestSortOrder] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CollectionItemList]: + """ + List of all Items within a Collection. + + Required scope | `CMS:read` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + cms_locale_id : typing.Optional[str] + Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string. + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + name : typing.Optional[str] + Filter by the exact name of the item(s) + + slug : typing.Optional[str] + Filter by the exact slug of the item + + last_published : typing.Optional[ItemsListItemsRequestLastPublished] + Filter by the last published date of the item(s) + + sort_by : typing.Optional[ItemsListItemsRequestSortBy] + Sort results by the provided value + + sort_order : typing.Optional[ItemsListItemsRequestSortOrder] + Sorts the results by asc or desc + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CollectionItemList] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "cmsLocaleId": cms_locale_id, + "offset": offset, + "limit": limit, + "name": name, + "slug": slug, + "lastPublished": convert_and_respect_annotation_metadata( + object_=last_published, annotation=ItemsListItemsRequestLastPublished, direction="write" + ), + "sortBy": sort_by, + "sortOrder": sort_order, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CollectionItemList, + parse_obj_as( + type_=CollectionItemList, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def create_item( + self, + collection_id: str, + *, + request: ItemsCreateItemRequestBody, + skip_invalid_files: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CollectionItem]: + """ + Create Item(s) in a Collection. + + + To create items across multiple locales, please use [this endpoint.](/data/reference/cms/collection-items/staged-items/create-items) + + Required scope | `CMS:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + request : ItemsCreateItemRequestBody + + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CollectionItem] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items", + base_url=self._client_wrapper.get_environment().base, + method="POST", + params={ + "skipInvalidFiles": skip_invalid_files, + }, + json=convert_and_respect_annotation_metadata( + object_=request, annotation=ItemsCreateItemRequestBody, direction="write" + ), + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CollectionItem, + parse_obj_as( + type_=CollectionItem, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def delete_items( + self, + collection_id: str, + *, + items: typing.Sequence[ItemsDeleteItemsRequestItemsItem], + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[None]: + """ + Delete Items from a Collection. + + Items will only be deleted in the primary locale unless a `cmsLocaleId` is included in the request. + + Required scope | `CMS:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + items : typing.Sequence[ItemsDeleteItemsRequestItemsItem] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[None] + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + json={ + "items": convert_and_respect_annotation_metadata( + object_=items, annotation=typing.Sequence[ItemsDeleteItemsRequestItemsItem], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + return AsyncHttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def update_items( + self, + collection_id: str, + *, + skip_invalid_files: typing.Optional[bool] = None, + items: typing.Optional[typing.Sequence[CollectionItemWithIdInput]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[ItemsUpdateItemsResponse]: + """ + Update a single item or multiple items in a Collection. + + The limit for this endpoint is 100 items. + + Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request. + + Required scope | `CMS:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + + items : typing.Optional[typing.Sequence[CollectionItemWithIdInput]] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ItemsUpdateItemsResponse] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + params={ + "skipInvalidFiles": skip_invalid_files, + }, + json={ + "items": convert_and_respect_annotation_metadata( + object_=items, annotation=typing.Sequence[CollectionItemWithIdInput], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ItemsUpdateItemsResponse, + parse_obj_as( + type_=ItemsUpdateItemsResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def list_items_live( + self, + collection_id: str, + *, + cms_locale_id: typing.Optional[str] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + name: typing.Optional[str] = None, + slug: typing.Optional[str] = None, + last_published: typing.Optional[ItemsListItemsLiveRequestLastPublished] = None, + sort_by: typing.Optional[ItemsListItemsLiveRequestSortBy] = None, + sort_order: typing.Optional[ItemsListItemsLiveRequestSortOrder] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CollectionItemList]: + """ + List all published items in a collection. + + + Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations. + + + Required scope | `CMS:read` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + cms_locale_id : typing.Optional[str] + Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string. + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + name : typing.Optional[str] + Filter by the exact name of the item(s) + + slug : typing.Optional[str] + Filter by the exact slug of the item + + last_published : typing.Optional[ItemsListItemsLiveRequestLastPublished] + Filter by the last published date of the item(s) + + sort_by : typing.Optional[ItemsListItemsLiveRequestSortBy] + Sort results by the provided value + + sort_order : typing.Optional[ItemsListItemsLiveRequestSortOrder] + Sorts the results by asc or desc + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CollectionItemList] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/live", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "cmsLocaleId": cms_locale_id, + "offset": offset, + "limit": limit, + "name": name, + "slug": slug, + "lastPublished": convert_and_respect_annotation_metadata( + object_=last_published, annotation=ItemsListItemsLiveRequestLastPublished, direction="write" + ), + "sortBy": sort_by, + "sortOrder": sort_order, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CollectionItemList, + parse_obj_as( + type_=CollectionItemList, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def create_item_live( + self, + collection_id: str, + *, + request: ItemsCreateItemLiveRequestBody, + skip_invalid_files: typing.Optional[bool] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CollectionItem]: + """ + Create item(s) in a collection that will be immediately published to the live site. + + + To create items across multiple locales, [please use this endpoint.](/data/reference/cms/collection-items/staged-items/create-items) + + + Required scope | `CMS:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + request : ItemsCreateItemLiveRequestBody + + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CollectionItem] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/live", + base_url=self._client_wrapper.get_environment().base, + method="POST", + params={ + "skipInvalidFiles": skip_invalid_files, + }, + json=convert_and_respect_annotation_metadata( + object_=request, annotation=ItemsCreateItemLiveRequestBody, direction="write" + ), + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CollectionItem, + parse_obj_as( + type_=CollectionItem, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def delete_items_live( + self, + collection_id: str, + *, + items: typing.Sequence[ItemsDeleteItemsLiveRequestItemsItem], + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[None]: + """ + Unpublish up to 100 items from the live site and set the `isDraft` property to `true`. + + Items will only be unpublished in the primary locale unless a `cmsLocaleId` is included in the request. + + Required scope | `CMS:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + items : typing.Sequence[ItemsDeleteItemsLiveRequestItemsItem] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[None] + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/live", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + json={ + "items": convert_and_respect_annotation_metadata( + object_=items, annotation=typing.Sequence[ItemsDeleteItemsLiveRequestItemsItem], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + return AsyncHttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def update_items_live( + self, + collection_id: str, + *, + skip_invalid_files: typing.Optional[bool] = None, + items: typing.Optional[typing.Sequence[CollectionItemWithIdInput]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CollectionItemListNoPagination]: + """ + Update a single published item or multiple published items (up to 100) in a Collection + + Items will only be updated in the primary locale, unless a `cmsLocaleId` is included in the request. + + Required scope | `CMS:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + + items : typing.Optional[typing.Sequence[CollectionItemWithIdInput]] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CollectionItemListNoPagination] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/live", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + params={ + "skipInvalidFiles": skip_invalid_files, + }, + json={ + "items": convert_and_respect_annotation_metadata( + object_=items, annotation=typing.Sequence[CollectionItemWithIdInput], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CollectionItemListNoPagination, + parse_obj_as( + type_=CollectionItemListNoPagination, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def create_items( + self, + collection_id: str, + *, + field_data: CreateBulkCollectionItemRequestBodyFieldData, + skip_invalid_files: typing.Optional[bool] = None, + cms_locale_ids: typing.Optional[typing.Sequence[str]] = OMIT, + is_archived: typing.Optional[bool] = OMIT, + is_draft: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[BulkCollectionItem]: + """ + Create an item or multiple items in a CMS Collection across multiple corresponding locales. + + + - This endpoint can create up to 100 items in a request. + - If the `cmsLocaleIds` parameter is not included in the request, an item will only be created in the primary locale. + + + Required scope | `CMS:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + field_data : CreateBulkCollectionItemRequestBodyFieldData + + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + + cms_locale_ids : typing.Optional[typing.Sequence[str]] + Array of identifiers for the locales where the item will be created + + is_archived : typing.Optional[bool] + Indicates whether the item is archived. + + is_draft : typing.Optional[bool] + Indicates whether the item is in draft state. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[BulkCollectionItem] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/bulk", + base_url=self._client_wrapper.get_environment().base, + method="POST", + params={ + "skipInvalidFiles": skip_invalid_files, + }, + json={ + "cmsLocaleIds": cms_locale_ids, + "isArchived": is_archived, + "isDraft": is_draft, + "fieldData": convert_and_respect_annotation_metadata( + object_=field_data, annotation=CreateBulkCollectionItemRequestBodyFieldData, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + BulkCollectionItem, + parse_obj_as( + type_=BulkCollectionItem, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def get_item( + self, + collection_id: str, + item_id: str, + *, + cms_locale_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CollectionItem]: + """ + Get details of a selected Collection Item. + + Required scope | `CMS:read` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + item_id : str + Unique identifier for an Item + + cms_locale_id : typing.Optional[str] + Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CollectionItem] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "cmsLocaleId": cms_locale_id, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CollectionItem, + parse_obj_as( + type_=CollectionItem, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def delete_item( + self, + collection_id: str, + item_id: str, + *, + cms_locale_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[None]: + """ + Delete an item from a collection. + + Required scope | `CMS:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + item_id : str + Unique identifier for an Item + + cms_locale_id : typing.Optional[str] + Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[None] + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + params={ + "cmsLocaleId": cms_locale_id, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return AsyncHttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def update_item( + self, + collection_id: str, + item_id: str, + *, + skip_invalid_files: typing.Optional[bool] = None, + id: typing.Optional[str] = OMIT, + cms_locale_id: typing.Optional[str] = OMIT, + last_published: typing.Optional[str] = OMIT, + last_updated: typing.Optional[str] = OMIT, + created_on: typing.Optional[str] = OMIT, + is_archived: typing.Optional[bool] = OMIT, + is_draft: typing.Optional[bool] = OMIT, + field_data: typing.Optional[CollectionItemPatchSingleFieldData] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CollectionItem]: + """ + Update a selected Item in a Collection. + + Required scope | `CMS:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + item_id : str + Unique identifier for an Item + + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + + id : typing.Optional[str] + Unique identifier for the Item + + cms_locale_id : typing.Optional[str] + Identifier for the locale of the CMS item + + last_published : typing.Optional[str] + The date the item was last published + + last_updated : typing.Optional[str] + The date the item was last updated + + created_on : typing.Optional[str] + The date the item was created + + is_archived : typing.Optional[bool] + Boolean determining if the Item is set to archived + + is_draft : typing.Optional[bool] + Boolean determining if the Item is set to draft + + field_data : typing.Optional[CollectionItemPatchSingleFieldData] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CollectionItem] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + params={ + "skipInvalidFiles": skip_invalid_files, + }, + json={ + "id": id, + "cmsLocaleId": cms_locale_id, + "lastPublished": last_published, + "lastUpdated": last_updated, + "createdOn": created_on, + "isArchived": is_archived, + "isDraft": is_draft, + "fieldData": convert_and_respect_annotation_metadata( + object_=field_data, annotation=CollectionItemPatchSingleFieldData, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CollectionItem, + parse_obj_as( + type_=CollectionItem, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def get_item_live( + self, + collection_id: str, + item_id: str, + *, + cms_locale_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CollectionItem]: + """ + Get details of a selected Collection live Item. + + + Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations. + + + Required scope | `CMS:read` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + item_id : str + Unique identifier for an Item + + cms_locale_id : typing.Optional[str] + Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CollectionItem] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}/live", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "cmsLocaleId": cms_locale_id, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CollectionItem, + parse_obj_as( + type_=CollectionItem, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def delete_item_live( + self, + collection_id: str, + item_id: str, + *, + cms_locale_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[None]: + """ + Unpublish a live item from the site and set the `isDraft` property to `true`. + + For bulk unpublishing, please use [this endpoint.](/data/v2.0.0/reference/cms/collection-items/live-items/delete-items-live) + + Required scope | `CMS:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + item_id : str + Unique identifier for an Item + + cms_locale_id : typing.Optional[str] + Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as `cmsLocaleId` in the Sites response. To query multiple locales, input a comma separated string. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[None] + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}/live", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + params={ + "cmsLocaleId": cms_locale_id, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return AsyncHttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def update_item_live( + self, + collection_id: str, + item_id: str, + *, + skip_invalid_files: typing.Optional[bool] = None, + id: typing.Optional[str] = OMIT, + cms_locale_id: typing.Optional[str] = OMIT, + last_published: typing.Optional[str] = OMIT, + last_updated: typing.Optional[str] = OMIT, + created_on: typing.Optional[str] = OMIT, + is_archived: typing.Optional[bool] = OMIT, + is_draft: typing.Optional[bool] = OMIT, + field_data: typing.Optional[CollectionItemPatchSingleFieldData] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CollectionItem]: + """ + Update a selected live Item in a Collection. The updates for this Item will be published to the live site. + + Required scope | `CMS:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + item_id : str + Unique identifier for an Item + + skip_invalid_files : typing.Optional[bool] + When true, invalid files are skipped and processing continues. When false, the entire request fails if any file is invalid. + + id : typing.Optional[str] + Unique identifier for the Item + + cms_locale_id : typing.Optional[str] + Identifier for the locale of the CMS item + + last_published : typing.Optional[str] + The date the item was last published + + last_updated : typing.Optional[str] + The date the item was last updated + + created_on : typing.Optional[str] + The date the item was created + + is_archived : typing.Optional[bool] + Boolean determining if the Item is set to archived + + is_draft : typing.Optional[bool] + Boolean determining if the Item is set to draft + + field_data : typing.Optional[CollectionItemPatchSingleFieldData] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CollectionItem] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}/live", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + params={ + "skipInvalidFiles": skip_invalid_files, + }, + json={ + "id": id, + "cmsLocaleId": cms_locale_id, + "lastPublished": last_published, + "lastUpdated": last_updated, + "createdOn": created_on, + "isArchived": is_archived, + "isDraft": is_draft, + "fieldData": convert_and_respect_annotation_metadata( + object_=field_data, annotation=CollectionItemPatchSingleFieldData, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CollectionItem, + parse_obj_as( + type_=CollectionItem, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def publish_item( + self, + collection_id: str, + *, + request: ItemsPublishItemRequest, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[ItemsPublishItemResponse]: + """ + Publish an item or multiple items. + + Required scope | `cms:write` + + Parameters + ---------- + collection_id : str + Unique identifier for a Collection + + request : ItemsPublishItemRequest + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ItemsPublishItemResponse] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(collection_id)}/items/publish", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json=convert_and_respect_annotation_metadata( + object_=request, annotation=ItemsPublishItemRequest, direction="write" + ), + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ItemsPublishItemResponse, + parse_obj_as( + type_=ItemsPublishItemResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/collections/resources/items/types/__init__.py b/src/webflow/resources/collections/resources/items/types/__init__.py index 67040fb..6350593 100644 --- a/src/webflow/resources/collections/resources/items/types/__init__.py +++ b/src/webflow/resources/collections/resources/items/types/__init__.py @@ -1,32 +1,93 @@ # This file was auto-generated by Fern from our API Definition. -from .create_bulk_collection_item_request_body_field_data import CreateBulkCollectionItemRequestBodyFieldData -from .create_bulk_collection_item_request_body_field_data_item import CreateBulkCollectionItemRequestBodyFieldDataItem -from .items_create_item_live_request import ItemsCreateItemLiveRequest -from .items_create_item_request import ItemsCreateItemRequest -from .items_delete_items_live_request_items_item import ItemsDeleteItemsLiveRequestItemsItem -from .items_delete_items_request_items_item import ItemsDeleteItemsRequestItemsItem -from .items_list_items_live_request_sort_by import ItemsListItemsLiveRequestSortBy -from .items_list_items_live_request_sort_order import ItemsListItemsLiveRequestSortOrder -from .items_list_items_request_sort_by import ItemsListItemsRequestSortBy -from .items_list_items_request_sort_order import ItemsListItemsRequestSortOrder -from .items_publish_item_response import ItemsPublishItemResponse -from .multiple_items import MultipleItems -from .multiple_live_items import MultipleLiveItems -from .single_cms_item import SingleCmsItem +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .create_bulk_collection_item_request_body_field_data import CreateBulkCollectionItemRequestBodyFieldData + from .create_bulk_collection_item_request_body_field_data_one_item import ( + CreateBulkCollectionItemRequestBodyFieldDataOneItem, + ) + from .item_i_ds import ItemIDs + from .item_i_ds_with_locales import ItemIDsWithLocales + from .items_create_item_live_request_body import ItemsCreateItemLiveRequestBody + from .items_create_item_request_body import ItemsCreateItemRequestBody + from .items_delete_items_live_request_items_item import ItemsDeleteItemsLiveRequestItemsItem + from .items_delete_items_request_items_item import ItemsDeleteItemsRequestItemsItem + from .items_list_items_live_request_sort_by import ItemsListItemsLiveRequestSortBy + from .items_list_items_live_request_sort_order import ItemsListItemsLiveRequestSortOrder + from .items_list_items_request_sort_by import ItemsListItemsRequestSortBy + from .items_list_items_request_sort_order import ItemsListItemsRequestSortOrder + from .items_publish_item_request import ItemsPublishItemRequest + from .items_publish_item_request_items_items_item import ItemsPublishItemRequestItemsItemsItem + from .items_publish_item_response import ItemsPublishItemResponse + from .items_update_items_response import ItemsUpdateItemsResponse + from .multiple_items import MultipleItems + from .multiple_live_items import MultipleLiveItems + from .single_cms_item import SingleCmsItem +_dynamic_imports: typing.Dict[str, str] = { + "CreateBulkCollectionItemRequestBodyFieldData": ".create_bulk_collection_item_request_body_field_data", + "CreateBulkCollectionItemRequestBodyFieldDataOneItem": ".create_bulk_collection_item_request_body_field_data_one_item", + "ItemIDs": ".item_i_ds", + "ItemIDsWithLocales": ".item_i_ds_with_locales", + "ItemsCreateItemLiveRequestBody": ".items_create_item_live_request_body", + "ItemsCreateItemRequestBody": ".items_create_item_request_body", + "ItemsDeleteItemsLiveRequestItemsItem": ".items_delete_items_live_request_items_item", + "ItemsDeleteItemsRequestItemsItem": ".items_delete_items_request_items_item", + "ItemsListItemsLiveRequestSortBy": ".items_list_items_live_request_sort_by", + "ItemsListItemsLiveRequestSortOrder": ".items_list_items_live_request_sort_order", + "ItemsListItemsRequestSortBy": ".items_list_items_request_sort_by", + "ItemsListItemsRequestSortOrder": ".items_list_items_request_sort_order", + "ItemsPublishItemRequest": ".items_publish_item_request", + "ItemsPublishItemRequestItemsItemsItem": ".items_publish_item_request_items_items_item", + "ItemsPublishItemResponse": ".items_publish_item_response", + "ItemsUpdateItemsResponse": ".items_update_items_response", + "MultipleItems": ".multiple_items", + "MultipleLiveItems": ".multiple_live_items", + "SingleCmsItem": ".single_cms_item", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + __all__ = [ "CreateBulkCollectionItemRequestBodyFieldData", - "CreateBulkCollectionItemRequestBodyFieldDataItem", - "ItemsCreateItemLiveRequest", - "ItemsCreateItemRequest", + "CreateBulkCollectionItemRequestBodyFieldDataOneItem", + "ItemIDs", + "ItemIDsWithLocales", + "ItemsCreateItemLiveRequestBody", + "ItemsCreateItemRequestBody", "ItemsDeleteItemsLiveRequestItemsItem", "ItemsDeleteItemsRequestItemsItem", "ItemsListItemsLiveRequestSortBy", "ItemsListItemsLiveRequestSortOrder", "ItemsListItemsRequestSortBy", "ItemsListItemsRequestSortOrder", + "ItemsPublishItemRequest", + "ItemsPublishItemRequestItemsItemsItem", "ItemsPublishItemResponse", + "ItemsUpdateItemsResponse", "MultipleItems", "MultipleLiveItems", "SingleCmsItem", diff --git a/src/webflow/resources/collections/resources/items/types/create_bulk_collection_item_request_body_field_data.py b/src/webflow/resources/collections/resources/items/types/create_bulk_collection_item_request_body_field_data.py index c4bcb14..cfa74ad 100644 --- a/src/webflow/resources/collections/resources/items/types/create_bulk_collection_item_request_body_field_data.py +++ b/src/webflow/resources/collections/resources/items/types/create_bulk_collection_item_request_body_field_data.py @@ -1,9 +1,12 @@ # This file was auto-generated by Fern from our API Definition. import typing + +from .create_bulk_collection_item_request_body_field_data_one_item import ( + CreateBulkCollectionItemRequestBodyFieldDataOneItem, +) from .single_cms_item import SingleCmsItem -from .create_bulk_collection_item_request_body_field_data_item import CreateBulkCollectionItemRequestBodyFieldDataItem CreateBulkCollectionItemRequestBodyFieldData = typing.Union[ - SingleCmsItem, typing.List[CreateBulkCollectionItemRequestBodyFieldDataItem] + SingleCmsItem, typing.List[CreateBulkCollectionItemRequestBodyFieldDataOneItem] ] diff --git a/src/webflow/resources/collections/resources/items/types/create_bulk_collection_item_request_body_field_data_item.py b/src/webflow/resources/collections/resources/items/types/create_bulk_collection_item_request_body_field_data_one_item.py similarity index 73% rename from src/webflow/resources/collections/resources/items/types/create_bulk_collection_item_request_body_field_data_item.py rename to src/webflow/resources/collections/resources/items/types/create_bulk_collection_item_request_body_field_data_one_item.py index dd6a4f7..0999f96 100644 --- a/src/webflow/resources/collections/resources/items/types/create_bulk_collection_item_request_body_field_data_item.py +++ b/src/webflow/resources/collections/resources/items/types/create_bulk_collection_item_request_body_field_data_one_item.py @@ -1,12 +1,12 @@ # This file was auto-generated by Fern from our API Definition. -from ......core.pydantic_utilities import UniversalBaseModel -import pydantic -from ......core.pydantic_utilities import IS_PYDANTIC_V2 import typing +import pydantic +from ......core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + -class CreateBulkCollectionItemRequestBodyFieldDataItem(UniversalBaseModel): +class CreateBulkCollectionItemRequestBodyFieldDataOneItem(UniversalBaseModel): """ A single CMS item to create """ @@ -18,7 +18,7 @@ class CreateBulkCollectionItemRequestBodyFieldDataItem(UniversalBaseModel): slug: str = pydantic.Field() """ - URL slug for the item in your site. + URL slug for the item in your site. Note: Updating the item slug will break all links referencing the old slug. """ diff --git a/src/webflow/resources/collections/resources/items/types/item_i_ds.py b/src/webflow/resources/collections/resources/items/types/item_i_ds.py new file mode 100644 index 0000000..f71ca26 --- /dev/null +++ b/src/webflow/resources/collections/resources/items/types/item_i_ds.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ......core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ......core.serialization import FieldMetadata + + +class ItemIDs(UniversalBaseModel): + """ + An array of Item IDs in a single locale + """ + + item_ids: typing_extensions.Annotated[ + typing.Optional[typing.List[str]], FieldMetadata(alias="itemIds"), pydantic.Field(alias="itemIds") + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/resources/collections/resources/items/types/item_i_ds_with_locales.py b/src/webflow/resources/collections/resources/items/types/item_i_ds_with_locales.py new file mode 100644 index 0000000..23ad969 --- /dev/null +++ b/src/webflow/resources/collections/resources/items/types/item_i_ds_with_locales.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ......core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .items_publish_item_request_items_items_item import ItemsPublishItemRequestItemsItemsItem + + +class ItemIDsWithLocales(UniversalBaseModel): + """ + An array of Item IDs with included `cmsLocaleIds` + """ + + items: typing.Optional[typing.List[ItemsPublishItemRequestItemsItemsItem]] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/resources/collections/resources/items/types/items_create_item_live_request.py b/src/webflow/resources/collections/resources/items/types/items_create_item_live_request_body.py similarity index 69% rename from src/webflow/resources/collections/resources/items/types/items_create_item_live_request.py rename to src/webflow/resources/collections/resources/items/types/items_create_item_live_request_body.py index dc2f963..7e008a5 100644 --- a/src/webflow/resources/collections/resources/items/types/items_create_item_live_request.py +++ b/src/webflow/resources/collections/resources/items/types/items_create_item_live_request_body.py @@ -1,7 +1,8 @@ # This file was auto-generated by Fern from our API Definition. import typing + from ......types.collection_item import CollectionItem from .multiple_live_items import MultipleLiveItems -ItemsCreateItemLiveRequest = typing.Union[CollectionItem, MultipleLiveItems] +ItemsCreateItemLiveRequestBody = typing.Union[CollectionItem, MultipleLiveItems] diff --git a/src/webflow/resources/collections/resources/items/types/items_create_item_request.py b/src/webflow/resources/collections/resources/items/types/items_create_item_request_body.py similarity index 70% rename from src/webflow/resources/collections/resources/items/types/items_create_item_request.py rename to src/webflow/resources/collections/resources/items/types/items_create_item_request_body.py index 7627c55..94bd556 100644 --- a/src/webflow/resources/collections/resources/items/types/items_create_item_request.py +++ b/src/webflow/resources/collections/resources/items/types/items_create_item_request_body.py @@ -1,7 +1,8 @@ # This file was auto-generated by Fern from our API Definition. import typing + from ......types.collection_item_post_single import CollectionItemPostSingle from .multiple_items import MultipleItems -ItemsCreateItemRequest = typing.Union[CollectionItemPostSingle, MultipleItems] +ItemsCreateItemRequestBody = typing.Union[CollectionItemPostSingle, MultipleItems] diff --git a/src/webflow/resources/collections/resources/items/types/items_delete_items_live_request_items_item.py b/src/webflow/resources/collections/resources/items/types/items_delete_items_live_request_items_item.py index 63e00bc..0fa1b7b 100644 --- a/src/webflow/resources/collections/resources/items/types/items_delete_items_live_request_items_item.py +++ b/src/webflow/resources/collections/resources/items/types/items_delete_items_live_request_items_item.py @@ -1,25 +1,26 @@ # This file was auto-generated by Fern from our API Definition. -from ......core.pydantic_utilities import UniversalBaseModel +import typing + +import pydantic import typing_extensions +from ......core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ......core.serialization import FieldMetadata -import pydantic -import typing -from ......core.pydantic_utilities import IS_PYDANTIC_V2 class ItemsDeleteItemsLiveRequestItemsItem(UniversalBaseModel): - item_id: typing_extensions.Annotated[str, FieldMetadata(alias="itemId")] = pydantic.Field() + id: str = pydantic.Field() """ Unique identifier for the Item """ cms_locale_ids: typing_extensions.Annotated[ - typing.Optional[typing.List[str]], FieldMetadata(alias="cmsLocaleIds") - ] = pydantic.Field(default=None) - """ - Array of identifiers for the locales where the item will be created - """ + typing.Optional[typing.List[str]], + FieldMetadata(alias="cmsLocaleIds"), + pydantic.Field( + alias="cmsLocaleIds", description="Array of identifiers for the locales where the item will be created" + ), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/resources/collections/resources/items/types/items_delete_items_request_items_item.py b/src/webflow/resources/collections/resources/items/types/items_delete_items_request_items_item.py index 3b66981..5438d65 100644 --- a/src/webflow/resources/collections/resources/items/types/items_delete_items_request_items_item.py +++ b/src/webflow/resources/collections/resources/items/types/items_delete_items_request_items_item.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ......core.pydantic_utilities import UniversalBaseModel +import typing + import pydantic import typing_extensions -import typing +from ......core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ......core.serialization import FieldMetadata -from ......core.pydantic_utilities import IS_PYDANTIC_V2 class ItemsDeleteItemsRequestItemsItem(UniversalBaseModel): @@ -15,11 +15,12 @@ class ItemsDeleteItemsRequestItemsItem(UniversalBaseModel): """ cms_locale_ids: typing_extensions.Annotated[ - typing.Optional[typing.List[str]], FieldMetadata(alias="cmsLocaleIds") - ] = pydantic.Field(default=None) - """ - Array of identifiers for the locales where the item will be created - """ + typing.Optional[typing.List[str]], + FieldMetadata(alias="cmsLocaleIds"), + pydantic.Field( + alias="cmsLocaleIds", description="Array of identifiers for the locales where the item will be created" + ), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/resources/collections/resources/items/types/items_publish_item_request.py b/src/webflow/resources/collections/resources/items/types/items_publish_item_request.py new file mode 100644 index 0000000..dc4ca56 --- /dev/null +++ b/src/webflow/resources/collections/resources/items/types/items_publish_item_request.py @@ -0,0 +1,8 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .item_i_ds import ItemIDs +from .item_i_ds_with_locales import ItemIDsWithLocales + +ItemsPublishItemRequest = typing.Union[ItemIDs, ItemIDsWithLocales] diff --git a/src/webflow/resources/collections/resources/items/types/items_publish_item_request_items_items_item.py b/src/webflow/resources/collections/resources/items/types/items_publish_item_request_items_items_item.py new file mode 100644 index 0000000..6798991 --- /dev/null +++ b/src/webflow/resources/collections/resources/items/types/items_publish_item_request_items_items_item.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ......core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ......core.serialization import FieldMetadata + + +class ItemsPublishItemRequestItemsItemsItem(UniversalBaseModel): + id: str = pydantic.Field() + """ + The ID of the CMS item + """ + + cms_locale_ids: typing_extensions.Annotated[ + typing.Optional[typing.List[str]], + FieldMetadata(alias="cmsLocaleIds"), + pydantic.Field( + alias="cmsLocaleIds", description="Array of identifiers for the locales where the item will be published" + ), + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/resources/collections/resources/items/types/items_publish_item_response.py b/src/webflow/resources/collections/resources/items/types/items_publish_item_response.py index f793223..4e5d67e 100644 --- a/src/webflow/resources/collections/resources/items/types/items_publish_item_response.py +++ b/src/webflow/resources/collections/resources/items/types/items_publish_item_response.py @@ -1,16 +1,18 @@ # This file was auto-generated by Fern from our API Definition. -from ......core.pydantic_utilities import UniversalBaseModel -import typing_extensions import typing -from ......core.serialization import FieldMetadata -from ......core.pydantic_utilities import IS_PYDANTIC_V2 + import pydantic +import typing_extensions +from ......core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ......core.serialization import FieldMetadata class ItemsPublishItemResponse(UniversalBaseModel): published_item_ids: typing_extensions.Annotated[ - typing.Optional[typing.List[str]], FieldMetadata(alias="publishedItemIds") + typing.Optional[typing.List[str]], + FieldMetadata(alias="publishedItemIds"), + pydantic.Field(alias="publishedItemIds"), ] = None errors: typing.Optional[typing.List[str]] = None diff --git a/src/webflow/resources/collections/resources/items/types/items_update_items_response.py b/src/webflow/resources/collections/resources/items/types/items_update_items_response.py new file mode 100644 index 0000000..137ac3f --- /dev/null +++ b/src/webflow/resources/collections/resources/items/types/items_update_items_response.py @@ -0,0 +1,8 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from ......types.collection_item import CollectionItem +from ......types.collection_item_list import CollectionItemList + +ItemsUpdateItemsResponse = typing.Union[CollectionItem, CollectionItemList] diff --git a/src/webflow/resources/collections/resources/items/types/multiple_items.py b/src/webflow/resources/collections/resources/items/types/multiple_items.py index 8700990..44eed57 100644 --- a/src/webflow/resources/collections/resources/items/types/multiple_items.py +++ b/src/webflow/resources/collections/resources/items/types/multiple_items.py @@ -1,10 +1,10 @@ # This file was auto-generated by Fern from our API Definition. -from ......core.pydantic_utilities import UniversalBaseModel import typing -from ......types.collection_item_post_single import CollectionItemPostSingle + import pydantic -from ......core.pydantic_utilities import IS_PYDANTIC_V2 +from ......core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ......types.collection_item_post_single import CollectionItemPostSingle class MultipleItems(UniversalBaseModel): diff --git a/src/webflow/resources/collections/resources/items/types/multiple_live_items.py b/src/webflow/resources/collections/resources/items/types/multiple_live_items.py index 156fecf..8661342 100644 --- a/src/webflow/resources/collections/resources/items/types/multiple_live_items.py +++ b/src/webflow/resources/collections/resources/items/types/multiple_live_items.py @@ -1,10 +1,10 @@ # This file was auto-generated by Fern from our API Definition. -from ......core.pydantic_utilities import UniversalBaseModel import typing -from ......types.collection_item import CollectionItem + import pydantic -from ......core.pydantic_utilities import IS_PYDANTIC_V2 +from ......core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ......types.collection_item import CollectionItem class MultipleLiveItems(UniversalBaseModel): diff --git a/src/webflow/resources/collections/resources/items/types/single_cms_item.py b/src/webflow/resources/collections/resources/items/types/single_cms_item.py index b64f1a4..176d013 100644 --- a/src/webflow/resources/collections/resources/items/types/single_cms_item.py +++ b/src/webflow/resources/collections/resources/items/types/single_cms_item.py @@ -1,10 +1,10 @@ # This file was auto-generated by Fern from our API Definition. -from ......core.pydantic_utilities import UniversalBaseModel -import pydantic -from ......core.pydantic_utilities import IS_PYDANTIC_V2 import typing +import pydantic +from ......core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + class SingleCmsItem(UniversalBaseModel): name: str = pydantic.Field() @@ -14,7 +14,7 @@ class SingleCmsItem(UniversalBaseModel): slug: str = pydantic.Field() """ - URL slug for the item in your site. + URL slug for the item in your site. Note: Updating the item slug will break all links referencing the old slug. """ diff --git a/src/webflow/resources/components/__init__.py b/src/webflow/resources/components/__init__.py index 36f01b7..7b65fd3 100644 --- a/src/webflow/resources/components/__init__.py +++ b/src/webflow/resources/components/__init__.py @@ -1,11 +1,45 @@ # This file was auto-generated by Fern from our API Definition. -from .types import ( - ComponentDomWriteNodesItem, - ComponentPropertiesWritePropertiesItem, - ComponentsUpdateContentResponse, - ComponentsUpdatePropertiesResponse, -) +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .types import ( + ComponentDomWriteNodesItem, + ComponentPropertiesWritePropertiesItem, + ComponentsUpdateContentResponse, + ComponentsUpdatePropertiesResponse, + ) +_dynamic_imports: typing.Dict[str, str] = { + "ComponentDomWriteNodesItem": ".types", + "ComponentPropertiesWritePropertiesItem": ".types", + "ComponentsUpdateContentResponse": ".types", + "ComponentsUpdatePropertiesResponse": ".types", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + __all__ = [ "ComponentDomWriteNodesItem", diff --git a/src/webflow/resources/components/client.py b/src/webflow/resources/components/client.py index ef50ac9..a9584d8 100644 --- a/src/webflow/resources/components/client.py +++ b/src/webflow/resources/components/client.py @@ -1,28 +1,17 @@ # This file was auto-generated by Fern from our API Definition. import typing -from ...core.client_wrapper import SyncClientWrapper + +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ...core.request_options import RequestOptions -from ...types.component_list import ComponentList -from ...core.jsonable_encoder import jsonable_encoder -from ...core.pydantic_utilities import parse_obj_as -from ...errors.bad_request_error import BadRequestError -from ...errors.unauthorized_error import UnauthorizedError -from ...types.error import Error -from ...errors.not_found_error import NotFoundError -from ...errors.too_many_requests_error import TooManyRequestsError -from ...errors.internal_server_error import InternalServerError -from json.decoder import JSONDecodeError -from ...core.api_error import ApiError from ...types.component_dom import ComponentDom -from .types.component_dom_write_nodes_item import ComponentDomWriteNodesItem -from .types.components_update_content_response import ComponentsUpdateContentResponse -from ...core.serialization import convert_and_respect_annotation_metadata -from ...errors.forbidden_error import ForbiddenError +from ...types.component_list import ComponentList from ...types.component_properties import ComponentProperties +from .raw_client import AsyncRawComponentsClient, RawComponentsClient +from .types.component_dom_write_nodes_item import ComponentDomWriteNodesItem from .types.component_properties_write_properties_item import ComponentPropertiesWritePropertiesItem +from .types.components_update_content_response import ComponentsUpdateContentResponse from .types.components_update_properties_response import ComponentsUpdatePropertiesResponse -from ...core.client_wrapper import AsyncClientWrapper # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) @@ -30,14 +19,26 @@ class ComponentsClient: def __init__(self, *, client_wrapper: SyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = RawComponentsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawComponentsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawComponentsClient + """ + return self._raw_client def list( self, site_id: str, *, - limit: typing.Optional[float] = None, - offset: typing.Optional[float] = None, + branch_id: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> ComponentList: """ @@ -50,10 +51,13 @@ def list( site_id : str Unique identifier for a Site - limit : typing.Optional[float] + branch_id : typing.Optional[str] + Scope the operation to work on a specific branch. + + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records request_options : typing.Optional[RequestOptions] @@ -73,80 +77,15 @@ def list( ) client.components.list( site_id="580e63e98c9a982ac9b8b741", + branch_id="68026fa68ef6dc744c75b833", + limit=1, + offset=1, ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/components", - method="GET", - params={ - "limit": limit, - "offset": offset, - }, - request_options=request_options, + _response = self._raw_client.list( + site_id, branch_id=branch_id, limit=limit, offset=offset, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ComponentList, - parse_obj_as( - type_=ComponentList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def get_content( self, @@ -154,12 +93,13 @@ def get_content( component_id: str, *, locale_id: typing.Optional[str] = None, - limit: typing.Optional[float] = None, - offset: typing.Optional[float] = None, + branch_id: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> ComponentDom: """ - Get static content from a component definition. This includes text nodes, image nodes and nested component instances. + Get static content from a component definition. This includes text nodes, image nodes, select nodes, text input nodes, submit button nodes, and nested component instances. To retrieve dynamic content set by component properties, use the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint. If you do not provide a Locale ID in your request, the response will return any content that can be localized from the Primary locale. @@ -175,12 +115,17 @@ def get_content( Unique identifier for a Component locale_id : typing.Optional[str] - Unique identifier for a specific locale. Applicable, when using localization. + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + branch_id : typing.Optional[str] + Scope the operation to work on a specific branch. - limit : typing.Optional[float] + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records request_options : typing.Optional[RequestOptions] @@ -202,81 +147,21 @@ def get_content( site_id="580e63e98c9a982ac9b8b741", component_id="8505ba55-ef72-629e-f85c-33e4b703d48b", locale_id="65427cf400e02b306eaa04a0", + branch_id="68026fa68ef6dc744c75b833", + limit=1, + offset=1, ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/components/{jsonable_encoder(component_id)}/dom", - method="GET", - params={ - "localeId": locale_id, - "limit": limit, - "offset": offset, - }, + _response = self._raw_client.get_content( + site_id, + component_id, + locale_id=locale_id, + branch_id=branch_id, + limit=limit, + offset=offset, request_options=request_options, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ComponentDom, - parse_obj_as( - type_=ComponentDom, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def update_content( self, @@ -285,14 +170,16 @@ def update_content( *, nodes: typing.Sequence[ComponentDomWriteNodesItem], locale_id: typing.Optional[str] = None, + branch_id: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None, ) -> ComponentsUpdateContentResponse: """ This endpoint updates content within a component defintion for **secondary locales**. It supports updating up to 1000 nodes in a single request. Before making updates: - 1. Use the [get component content](/data/reference/pages-and-components/components/get-content) endpoint to identify available content nodes and their types - 2. If your component definition has a component instance nested within it, retrieve the nested component instance's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint + 1. Use the [get component content](/data/reference/pages-and-components/components/get-content) endpoint to identify available content nodes and their types. + 2. If your component definition has a component instance nested within it, retrieve the nested component instance's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint. + 3. DOM elements may include a `data-w-id` attribute. This attribute is used by Webflow to maintain custom attributes and links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales. This endpoint is specifically for localizing component definitions. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail. @@ -312,7 +199,12 @@ def update_content( List of DOM Nodes with the new content that will be updated in each node. locale_id : typing.Optional[str] - Unique identifier for a specific locale. Applicable, when using localization. + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + branch_id : typing.Optional[str] + Scope the operation to work on a specific branch. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -327,6 +219,10 @@ def update_content( from webflow import ( ComponentInstanceNodePropertyOverridesWrite, ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem, + Select, + SelectNodeWriteChoicesItem, + SubmitButtonNodeWrite, + TextInputNodeWrite, TextNodeWrite, Webflow, ) @@ -338,6 +234,7 @@ def update_content( site_id="580e63e98c9a982ac9b8b741", component_id="8505ba55-ef72-629e-f85c-33e4b703d48b", locale_id="65427cf400e02b306eaa04a0", + branch_id="68026fa68ef6dc744c75b833", nodes=[ TextNodeWrite( node_id="a245c12d-995b-55ee-5ec7-aa36a6cad623", @@ -347,6 +244,28 @@ def update_content( node_id="a245c12d-995b-55ee-5ec7-aa36a6cad627", text="

Don't Panic!

Always know where your towel is.

", ), + Select( + node_id="a245c12d-995b-55ee-5ec7-aa36a6cad635", + choices=[ + SelectNodeWriteChoicesItem( + value="choice-1", + text="First choice", + ), + SelectNodeWriteChoicesItem( + value="choice-2", + text="Second choice", + ), + ], + ), + TextInputNodeWrite( + node_id="a245c12d-995b-55ee-5ec7-aa36a6cad642", + placeholder="Enter something here...", + ), + SubmitButtonNodeWrite( + node_id="a245c12d-995b-55ee-5ec7-aa36a6cad671", + value="Submit", + waiting_text="Submitting...", + ), ComponentInstanceNodePropertyOverridesWrite( node_id="a245c12d-995b-55ee-5ec7-aa36a6cad629", property_overrides=[ @@ -363,96 +282,15 @@ def update_content( ], ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/components/{jsonable_encoder(component_id)}/dom", - method="POST", - params={ - "localeId": locale_id, - }, - json={ - "nodes": convert_and_respect_annotation_metadata( - object_=nodes, annotation=typing.Sequence[ComponentDomWriteNodesItem], direction="write" - ), - }, - headers={ - "content-type": "application/json", - }, + _response = self._raw_client.update_content( + site_id, + component_id, + nodes=nodes, + locale_id=locale_id, + branch_id=branch_id, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ComponentsUpdateContentResponse, - parse_obj_as( - type_=ComponentsUpdateContentResponse, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def get_properties( self, @@ -460,14 +298,15 @@ def get_properties( component_id: str, *, locale_id: typing.Optional[str] = None, - limit: typing.Optional[float] = None, - offset: typing.Optional[float] = None, + branch_id: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> ComponentProperties: """ - Get the property default values of a component definition. + Get the default property values of a component definition. - If you do not provide a Locale ID in your request, the response will return any properties that can be localized from the Primary locale. + If you do not include a `localeId` in your request, the response will return any properties that can be localized from the Primary locale. Required scope | `components:read` @@ -480,12 +319,17 @@ def get_properties( Unique identifier for a Component locale_id : typing.Optional[str] - Unique identifier for a specific locale. Applicable, when using localization. + Unique identifier for a specific Locale. - limit : typing.Optional[float] + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + branch_id : typing.Optional[str] + Scope the operation to work on a specific branch. + + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records request_options : typing.Optional[RequestOptions] @@ -507,81 +351,21 @@ def get_properties( site_id="580e63e98c9a982ac9b8b741", component_id="8505ba55-ef72-629e-f85c-33e4b703d48b", locale_id="65427cf400e02b306eaa04a0", + branch_id="68026fa68ef6dc744c75b833", + limit=1, + offset=1, ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/components/{jsonable_encoder(component_id)}/properties", - method="GET", - params={ - "localeId": locale_id, - "limit": limit, - "offset": offset, - }, + _response = self._raw_client.get_properties( + site_id, + component_id, + locale_id=locale_id, + branch_id=branch_id, + limit=limit, + offset=offset, request_options=request_options, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ComponentProperties, - parse_obj_as( - type_=ComponentProperties, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def update_properties( self, @@ -590,15 +374,17 @@ def update_properties( *, properties: typing.Sequence[ComponentPropertiesWritePropertiesItem], locale_id: typing.Optional[str] = None, + branch_id: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None, ) -> ComponentsUpdatePropertiesResponse: """ - Update the property default values of a component definition in a specificed locale. + Update the default property values of a component definition in a specificed locale. Before making updates: - 1. Use the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint to identify available properties + 1. Use the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint to identify properties that can be updated in a secondary locale. + 2. Rich Text properties may include a `data-w-id` attribute. This attribute is used by Webflow to maintain links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales. - The request requires a secondary locale ID. If a locale is missing, the request will not be processed and will result in an error. + The request requires a secondary locale ID. If a `localeId` is missing, the request will not be processed and will result in an error. Required scope | `components:write` @@ -614,7 +400,12 @@ def update_properties( A list of component properties to update within the specified secondary locale. locale_id : typing.Optional[str] - Unique identifier for a specific locale. Applicable, when using localization. + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + branch_id : typing.Optional[str] + Scope the operation to work on a specific branch. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -636,6 +427,7 @@ def update_properties( site_id="580e63e98c9a982ac9b8b741", component_id="8505ba55-ef72-629e-f85c-33e4b703d48b", locale_id="65427cf400e02b306eaa04a0", + branch_id="68026fa68ef6dc744c75b833", properties=[ ComponentPropertiesWritePropertiesItem( property_id="a245c12d-995b-55ee-5ec7-aa36a6cad623", @@ -648,100 +440,39 @@ def update_properties( ], ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/components/{jsonable_encoder(component_id)}/properties", - method="POST", - params={ - "localeId": locale_id, - }, - json={ - "properties": convert_and_respect_annotation_metadata( - object_=properties, - annotation=typing.Sequence[ComponentPropertiesWritePropertiesItem], - direction="write", - ), - }, - headers={ - "content-type": "application/json", - }, + _response = self._raw_client.update_properties( + site_id, + component_id, + properties=properties, + locale_id=locale_id, + branch_id=branch_id, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ComponentsUpdatePropertiesResponse, - parse_obj_as( - type_=ComponentsUpdatePropertiesResponse, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data class AsyncComponentsClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = AsyncRawComponentsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawComponentsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawComponentsClient + """ + return self._raw_client async def list( self, site_id: str, *, - limit: typing.Optional[float] = None, - offset: typing.Optional[float] = None, + branch_id: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> ComponentList: """ @@ -754,10 +485,13 @@ async def list( site_id : str Unique identifier for a Site - limit : typing.Optional[float] + branch_id : typing.Optional[str] + Scope the operation to work on a specific branch. + + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records request_options : typing.Optional[RequestOptions] @@ -782,83 +516,18 @@ async def list( async def main() -> None: await client.components.list( site_id="580e63e98c9a982ac9b8b741", + branch_id="68026fa68ef6dc744c75b833", + limit=1, + offset=1, ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/components", - method="GET", - params={ - "limit": limit, - "offset": offset, - }, - request_options=request_options, + _response = await self._raw_client.list( + site_id, branch_id=branch_id, limit=limit, offset=offset, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ComponentList, - parse_obj_as( - type_=ComponentList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def get_content( self, @@ -866,12 +535,13 @@ async def get_content( component_id: str, *, locale_id: typing.Optional[str] = None, - limit: typing.Optional[float] = None, - offset: typing.Optional[float] = None, + branch_id: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> ComponentDom: """ - Get static content from a component definition. This includes text nodes, image nodes and nested component instances. + Get static content from a component definition. This includes text nodes, image nodes, select nodes, text input nodes, submit button nodes, and nested component instances. To retrieve dynamic content set by component properties, use the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint. If you do not provide a Locale ID in your request, the response will return any content that can be localized from the Primary locale. @@ -887,12 +557,17 @@ async def get_content( Unique identifier for a Component locale_id : typing.Optional[str] - Unique identifier for a specific locale. Applicable, when using localization. + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + branch_id : typing.Optional[str] + Scope the operation to work on a specific branch. - limit : typing.Optional[float] + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records request_options : typing.Optional[RequestOptions] @@ -919,84 +594,24 @@ async def main() -> None: site_id="580e63e98c9a982ac9b8b741", component_id="8505ba55-ef72-629e-f85c-33e4b703d48b", locale_id="65427cf400e02b306eaa04a0", + branch_id="68026fa68ef6dc744c75b833", + limit=1, + offset=1, ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/components/{jsonable_encoder(component_id)}/dom", - method="GET", - params={ - "localeId": locale_id, - "limit": limit, - "offset": offset, - }, + _response = await self._raw_client.get_content( + site_id, + component_id, + locale_id=locale_id, + branch_id=branch_id, + limit=limit, + offset=offset, request_options=request_options, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ComponentDom, - parse_obj_as( - type_=ComponentDom, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def update_content( self, @@ -1005,14 +620,16 @@ async def update_content( *, nodes: typing.Sequence[ComponentDomWriteNodesItem], locale_id: typing.Optional[str] = None, + branch_id: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None, ) -> ComponentsUpdateContentResponse: """ This endpoint updates content within a component defintion for **secondary locales**. It supports updating up to 1000 nodes in a single request. Before making updates: - 1. Use the [get component content](/data/reference/pages-and-components/components/get-content) endpoint to identify available content nodes and their types - 2. If your component definition has a component instance nested within it, retrieve the nested component instance's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint + 1. Use the [get component content](/data/reference/pages-and-components/components/get-content) endpoint to identify available content nodes and their types. + 2. If your component definition has a component instance nested within it, retrieve the nested component instance's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint. + 3. DOM elements may include a `data-w-id` attribute. This attribute is used by Webflow to maintain custom attributes and links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales. This endpoint is specifically for localizing component definitions. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail. @@ -1032,7 +649,12 @@ async def update_content( List of DOM Nodes with the new content that will be updated in each node. locale_id : typing.Optional[str] - Unique identifier for a specific locale. Applicable, when using localization. + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + branch_id : typing.Optional[str] + Scope the operation to work on a specific branch. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -1050,6 +672,10 @@ async def update_content( AsyncWebflow, ComponentInstanceNodePropertyOverridesWrite, ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem, + Select, + SelectNodeWriteChoicesItem, + SubmitButtonNodeWrite, + TextInputNodeWrite, TextNodeWrite, ) @@ -1063,6 +689,7 @@ async def main() -> None: site_id="580e63e98c9a982ac9b8b741", component_id="8505ba55-ef72-629e-f85c-33e4b703d48b", locale_id="65427cf400e02b306eaa04a0", + branch_id="68026fa68ef6dc744c75b833", nodes=[ TextNodeWrite( node_id="a245c12d-995b-55ee-5ec7-aa36a6cad623", @@ -1072,6 +699,28 @@ async def main() -> None: node_id="a245c12d-995b-55ee-5ec7-aa36a6cad627", text="

Don't Panic!

Always know where your towel is.

", ), + Select( + node_id="a245c12d-995b-55ee-5ec7-aa36a6cad635", + choices=[ + SelectNodeWriteChoicesItem( + value="choice-1", + text="First choice", + ), + SelectNodeWriteChoicesItem( + value="choice-2", + text="Second choice", + ), + ], + ), + TextInputNodeWrite( + node_id="a245c12d-995b-55ee-5ec7-aa36a6cad642", + placeholder="Enter something here...", + ), + SubmitButtonNodeWrite( + node_id="a245c12d-995b-55ee-5ec7-aa36a6cad671", + value="Submit", + waiting_text="Submitting...", + ), ComponentInstanceNodePropertyOverridesWrite( node_id="a245c12d-995b-55ee-5ec7-aa36a6cad629", property_overrides=[ @@ -1091,96 +740,15 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/components/{jsonable_encoder(component_id)}/dom", - method="POST", - params={ - "localeId": locale_id, - }, - json={ - "nodes": convert_and_respect_annotation_metadata( - object_=nodes, annotation=typing.Sequence[ComponentDomWriteNodesItem], direction="write" - ), - }, - headers={ - "content-type": "application/json", - }, + _response = await self._raw_client.update_content( + site_id, + component_id, + nodes=nodes, + locale_id=locale_id, + branch_id=branch_id, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ComponentsUpdateContentResponse, - parse_obj_as( - type_=ComponentsUpdateContentResponse, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def get_properties( self, @@ -1188,14 +756,15 @@ async def get_properties( component_id: str, *, locale_id: typing.Optional[str] = None, - limit: typing.Optional[float] = None, - offset: typing.Optional[float] = None, + branch_id: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> ComponentProperties: """ - Get the property default values of a component definition. + Get the default property values of a component definition. - If you do not provide a Locale ID in your request, the response will return any properties that can be localized from the Primary locale. + If you do not include a `localeId` in your request, the response will return any properties that can be localized from the Primary locale. Required scope | `components:read` @@ -1208,12 +777,17 @@ async def get_properties( Unique identifier for a Component locale_id : typing.Optional[str] - Unique identifier for a specific locale. Applicable, when using localization. + Unique identifier for a specific Locale. - limit : typing.Optional[float] + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + branch_id : typing.Optional[str] + Scope the operation to work on a specific branch. + + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records request_options : typing.Optional[RequestOptions] @@ -1240,84 +814,24 @@ async def main() -> None: site_id="580e63e98c9a982ac9b8b741", component_id="8505ba55-ef72-629e-f85c-33e4b703d48b", locale_id="65427cf400e02b306eaa04a0", + branch_id="68026fa68ef6dc744c75b833", + limit=1, + offset=1, ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/components/{jsonable_encoder(component_id)}/properties", - method="GET", - params={ - "localeId": locale_id, - "limit": limit, - "offset": offset, - }, + _response = await self._raw_client.get_properties( + site_id, + component_id, + locale_id=locale_id, + branch_id=branch_id, + limit=limit, + offset=offset, request_options=request_options, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ComponentProperties, - parse_obj_as( - type_=ComponentProperties, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def update_properties( self, @@ -1326,15 +840,17 @@ async def update_properties( *, properties: typing.Sequence[ComponentPropertiesWritePropertiesItem], locale_id: typing.Optional[str] = None, + branch_id: typing.Optional[str] = None, request_options: typing.Optional[RequestOptions] = None, ) -> ComponentsUpdatePropertiesResponse: """ - Update the property default values of a component definition in a specificed locale. + Update the default property values of a component definition in a specificed locale. Before making updates: - 1. Use the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint to identify available properties + 1. Use the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint to identify properties that can be updated in a secondary locale. + 2. Rich Text properties may include a `data-w-id` attribute. This attribute is used by Webflow to maintain links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales. - The request requires a secondary locale ID. If a locale is missing, the request will not be processed and will result in an error. + The request requires a secondary locale ID. If a `localeId` is missing, the request will not be processed and will result in an error. Required scope | `components:write` @@ -1350,7 +866,12 @@ async def update_properties( A list of component properties to update within the specified secondary locale. locale_id : typing.Optional[str] - Unique identifier for a specific locale. Applicable, when using localization. + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + branch_id : typing.Optional[str] + Scope the operation to work on a specific branch. request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -1377,6 +898,7 @@ async def main() -> None: site_id="580e63e98c9a982ac9b8b741", component_id="8505ba55-ef72-629e-f85c-33e4b703d48b", locale_id="65427cf400e02b306eaa04a0", + branch_id="68026fa68ef6dc744c75b833", properties=[ ComponentPropertiesWritePropertiesItem( property_id="a245c12d-995b-55ee-5ec7-aa36a6cad623", @@ -1392,85 +914,12 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/components/{jsonable_encoder(component_id)}/properties", - method="POST", - params={ - "localeId": locale_id, - }, - json={ - "properties": convert_and_respect_annotation_metadata( - object_=properties, - annotation=typing.Sequence[ComponentPropertiesWritePropertiesItem], - direction="write", - ), - }, - headers={ - "content-type": "application/json", - }, + _response = await self._raw_client.update_properties( + site_id, + component_id, + properties=properties, + locale_id=locale_id, + branch_id=branch_id, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ComponentsUpdatePropertiesResponse, - parse_obj_as( - type_=ComponentsUpdatePropertiesResponse, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data diff --git a/src/webflow/resources/components/raw_client.py b/src/webflow/resources/components/raw_client.py new file mode 100644 index 0000000..caf0799 --- /dev/null +++ b/src/webflow/resources/components/raw_client.py @@ -0,0 +1,1417 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from ...core.api_error import ApiError +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from ...core.http_response import AsyncHttpResponse, HttpResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.parse_error import ParsingError +from ...core.pydantic_utilities import parse_obj_as +from ...core.request_options import RequestOptions +from ...core.serialization import convert_and_respect_annotation_metadata +from ...errors.bad_request_error import BadRequestError +from ...errors.forbidden_error import ForbiddenError +from ...errors.internal_server_error import InternalServerError +from ...errors.not_found_error import NotFoundError +from ...errors.too_many_requests_error import TooManyRequestsError +from ...errors.unauthorized_error import UnauthorizedError +from ...types.component_dom import ComponentDom +from ...types.component_list import ComponentList +from ...types.component_properties import ComponentProperties +from ...types.error import Error +from .types.component_dom_write_nodes_item import ComponentDomWriteNodesItem +from .types.component_properties_write_properties_item import ComponentPropertiesWritePropertiesItem +from .types.components_update_content_response import ComponentsUpdateContentResponse +from .types.components_update_properties_response import ComponentsUpdatePropertiesResponse +from pydantic import ValidationError + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawComponentsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def list( + self, + site_id: str, + *, + branch_id: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[ComponentList]: + """ + List of all components for a site. + + Required scope | `components:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + branch_id : typing.Optional[str] + Scope the operation to work on a specific branch. + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ComponentList] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/components", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "branchId": branch_id, + "limit": limit, + "offset": offset, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ComponentList, + parse_obj_as( + type_=ComponentList, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def get_content( + self, + site_id: str, + component_id: str, + *, + locale_id: typing.Optional[str] = None, + branch_id: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[ComponentDom]: + """ + Get static content from a component definition. This includes text nodes, image nodes, select nodes, text input nodes, submit button nodes, and nested component instances. + To retrieve dynamic content set by component properties, use the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint. + + If you do not provide a Locale ID in your request, the response will return any content that can be localized from the Primary locale. + + Required scope | `components:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + component_id : str + Unique identifier for a Component + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + branch_id : typing.Optional[str] + Scope the operation to work on a specific branch. + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ComponentDom] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/components/{jsonable_encoder(component_id)}/dom", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "localeId": locale_id, + "branchId": branch_id, + "limit": limit, + "offset": offset, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ComponentDom, + parse_obj_as( + type_=ComponentDom, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def update_content( + self, + site_id: str, + component_id: str, + *, + nodes: typing.Sequence[ComponentDomWriteNodesItem], + locale_id: typing.Optional[str] = None, + branch_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[ComponentsUpdateContentResponse]: + """ + This endpoint updates content within a component defintion for **secondary locales**. It supports updating up to 1000 nodes in a single request. + + Before making updates: + 1. Use the [get component content](/data/reference/pages-and-components/components/get-content) endpoint to identify available content nodes and their types. + 2. If your component definition has a component instance nested within it, retrieve the nested component instance's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint. + 3. DOM elements may include a `data-w-id` attribute. This attribute is used by Webflow to maintain custom attributes and links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales. + + + This endpoint is specifically for localizing component definitions. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail. + + + Required scope | `components:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + component_id : str + Unique identifier for a Component + + nodes : typing.Sequence[ComponentDomWriteNodesItem] + List of DOM Nodes with the new content that will be updated in each node. + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + branch_id : typing.Optional[str] + Scope the operation to work on a specific branch. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ComponentsUpdateContentResponse] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/components/{jsonable_encoder(component_id)}/dom", + base_url=self._client_wrapper.get_environment().base, + method="POST", + params={ + "localeId": locale_id, + "branchId": branch_id, + }, + json={ + "nodes": convert_and_respect_annotation_metadata( + object_=nodes, annotation=typing.Sequence[ComponentDomWriteNodesItem], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ComponentsUpdateContentResponse, + parse_obj_as( + type_=ComponentsUpdateContentResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def get_properties( + self, + site_id: str, + component_id: str, + *, + locale_id: typing.Optional[str] = None, + branch_id: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[ComponentProperties]: + """ + Get the default property values of a component definition. + + If you do not include a `localeId` in your request, the response will return any properties that can be localized from the Primary locale. + + Required scope | `components:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + component_id : str + Unique identifier for a Component + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + branch_id : typing.Optional[str] + Scope the operation to work on a specific branch. + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ComponentProperties] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/components/{jsonable_encoder(component_id)}/properties", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "localeId": locale_id, + "branchId": branch_id, + "limit": limit, + "offset": offset, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ComponentProperties, + parse_obj_as( + type_=ComponentProperties, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def update_properties( + self, + site_id: str, + component_id: str, + *, + properties: typing.Sequence[ComponentPropertiesWritePropertiesItem], + locale_id: typing.Optional[str] = None, + branch_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[ComponentsUpdatePropertiesResponse]: + """ + Update the default property values of a component definition in a specificed locale. + + Before making updates: + 1. Use the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint to identify properties that can be updated in a secondary locale. + 2. Rich Text properties may include a `data-w-id` attribute. This attribute is used by Webflow to maintain links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales. + + The request requires a secondary locale ID. If a `localeId` is missing, the request will not be processed and will result in an error. + + Required scope | `components:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + component_id : str + Unique identifier for a Component + + properties : typing.Sequence[ComponentPropertiesWritePropertiesItem] + A list of component properties to update within the specified secondary locale. + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + branch_id : typing.Optional[str] + Scope the operation to work on a specific branch. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ComponentsUpdatePropertiesResponse] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/components/{jsonable_encoder(component_id)}/properties", + base_url=self._client_wrapper.get_environment().base, + method="POST", + params={ + "localeId": locale_id, + "branchId": branch_id, + }, + json={ + "properties": convert_and_respect_annotation_metadata( + object_=properties, + annotation=typing.Sequence[ComponentPropertiesWritePropertiesItem], + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ComponentsUpdatePropertiesResponse, + parse_obj_as( + type_=ComponentsUpdatePropertiesResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawComponentsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def list( + self, + site_id: str, + *, + branch_id: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[ComponentList]: + """ + List of all components for a site. + + Required scope | `components:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + branch_id : typing.Optional[str] + Scope the operation to work on a specific branch. + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ComponentList] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/components", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "branchId": branch_id, + "limit": limit, + "offset": offset, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ComponentList, + parse_obj_as( + type_=ComponentList, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def get_content( + self, + site_id: str, + component_id: str, + *, + locale_id: typing.Optional[str] = None, + branch_id: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[ComponentDom]: + """ + Get static content from a component definition. This includes text nodes, image nodes, select nodes, text input nodes, submit button nodes, and nested component instances. + To retrieve dynamic content set by component properties, use the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint. + + If you do not provide a Locale ID in your request, the response will return any content that can be localized from the Primary locale. + + Required scope | `components:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + component_id : str + Unique identifier for a Component + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + branch_id : typing.Optional[str] + Scope the operation to work on a specific branch. + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ComponentDom] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/components/{jsonable_encoder(component_id)}/dom", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "localeId": locale_id, + "branchId": branch_id, + "limit": limit, + "offset": offset, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ComponentDom, + parse_obj_as( + type_=ComponentDom, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def update_content( + self, + site_id: str, + component_id: str, + *, + nodes: typing.Sequence[ComponentDomWriteNodesItem], + locale_id: typing.Optional[str] = None, + branch_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[ComponentsUpdateContentResponse]: + """ + This endpoint updates content within a component defintion for **secondary locales**. It supports updating up to 1000 nodes in a single request. + + Before making updates: + 1. Use the [get component content](/data/reference/pages-and-components/components/get-content) endpoint to identify available content nodes and their types. + 2. If your component definition has a component instance nested within it, retrieve the nested component instance's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint. + 3. DOM elements may include a `data-w-id` attribute. This attribute is used by Webflow to maintain custom attributes and links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales. + + + This endpoint is specifically for localizing component definitions. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail. + + + Required scope | `components:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + component_id : str + Unique identifier for a Component + + nodes : typing.Sequence[ComponentDomWriteNodesItem] + List of DOM Nodes with the new content that will be updated in each node. + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + branch_id : typing.Optional[str] + Scope the operation to work on a specific branch. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ComponentsUpdateContentResponse] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/components/{jsonable_encoder(component_id)}/dom", + base_url=self._client_wrapper.get_environment().base, + method="POST", + params={ + "localeId": locale_id, + "branchId": branch_id, + }, + json={ + "nodes": convert_and_respect_annotation_metadata( + object_=nodes, annotation=typing.Sequence[ComponentDomWriteNodesItem], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ComponentsUpdateContentResponse, + parse_obj_as( + type_=ComponentsUpdateContentResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def get_properties( + self, + site_id: str, + component_id: str, + *, + locale_id: typing.Optional[str] = None, + branch_id: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[ComponentProperties]: + """ + Get the default property values of a component definition. + + If you do not include a `localeId` in your request, the response will return any properties that can be localized from the Primary locale. + + Required scope | `components:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + component_id : str + Unique identifier for a Component + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + branch_id : typing.Optional[str] + Scope the operation to work on a specific branch. + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ComponentProperties] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/components/{jsonable_encoder(component_id)}/properties", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "localeId": locale_id, + "branchId": branch_id, + "limit": limit, + "offset": offset, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ComponentProperties, + parse_obj_as( + type_=ComponentProperties, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def update_properties( + self, + site_id: str, + component_id: str, + *, + properties: typing.Sequence[ComponentPropertiesWritePropertiesItem], + locale_id: typing.Optional[str] = None, + branch_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[ComponentsUpdatePropertiesResponse]: + """ + Update the default property values of a component definition in a specificed locale. + + Before making updates: + 1. Use the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint to identify properties that can be updated in a secondary locale. + 2. Rich Text properties may include a `data-w-id` attribute. This attribute is used by Webflow to maintain links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales. + + The request requires a secondary locale ID. If a `localeId` is missing, the request will not be processed and will result in an error. + + Required scope | `components:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + component_id : str + Unique identifier for a Component + + properties : typing.Sequence[ComponentPropertiesWritePropertiesItem] + A list of component properties to update within the specified secondary locale. + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + branch_id : typing.Optional[str] + Scope the operation to work on a specific branch. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ComponentsUpdatePropertiesResponse] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/components/{jsonable_encoder(component_id)}/properties", + base_url=self._client_wrapper.get_environment().base, + method="POST", + params={ + "localeId": locale_id, + "branchId": branch_id, + }, + json={ + "properties": convert_and_respect_annotation_metadata( + object_=properties, + annotation=typing.Sequence[ComponentPropertiesWritePropertiesItem], + direction="write", + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ComponentsUpdatePropertiesResponse, + parse_obj_as( + type_=ComponentsUpdatePropertiesResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/components/types/__init__.py b/src/webflow/resources/components/types/__init__.py index dc8d684..d3d0a32 100644 --- a/src/webflow/resources/components/types/__init__.py +++ b/src/webflow/resources/components/types/__init__.py @@ -1,9 +1,43 @@ # This file was auto-generated by Fern from our API Definition. -from .component_dom_write_nodes_item import ComponentDomWriteNodesItem -from .component_properties_write_properties_item import ComponentPropertiesWritePropertiesItem -from .components_update_content_response import ComponentsUpdateContentResponse -from .components_update_properties_response import ComponentsUpdatePropertiesResponse +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .component_dom_write_nodes_item import ComponentDomWriteNodesItem + from .component_properties_write_properties_item import ComponentPropertiesWritePropertiesItem + from .components_update_content_response import ComponentsUpdateContentResponse + from .components_update_properties_response import ComponentsUpdatePropertiesResponse +_dynamic_imports: typing.Dict[str, str] = { + "ComponentDomWriteNodesItem": ".component_dom_write_nodes_item", + "ComponentPropertiesWritePropertiesItem": ".component_properties_write_properties_item", + "ComponentsUpdateContentResponse": ".components_update_content_response", + "ComponentsUpdatePropertiesResponse": ".components_update_properties_response", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + __all__ = [ "ComponentDomWriteNodesItem", diff --git a/src/webflow/resources/components/types/component_dom_write_nodes_item.py b/src/webflow/resources/components/types/component_dom_write_nodes_item.py index 27888e6..8bb5e53 100644 --- a/src/webflow/resources/components/types/component_dom_write_nodes_item.py +++ b/src/webflow/resources/components/types/component_dom_write_nodes_item.py @@ -1,7 +1,19 @@ # This file was auto-generated by Fern from our API Definition. import typing -from ....types.text_node_write import TextNodeWrite + from ....types.component_instance_node_property_overrides_write import ComponentInstanceNodePropertyOverridesWrite +from ....types.search_button_node_write import SearchButtonNodeWrite +from ....types.select import Select +from ....types.submit_button_node_write import SubmitButtonNodeWrite +from ....types.text_input_node_write import TextInputNodeWrite +from ....types.text_node_write import TextNodeWrite -ComponentDomWriteNodesItem = typing.Union[TextNodeWrite, ComponentInstanceNodePropertyOverridesWrite] +ComponentDomWriteNodesItem = typing.Union[ + TextNodeWrite, + ComponentInstanceNodePropertyOverridesWrite, + Select, + TextInputNodeWrite, + SubmitButtonNodeWrite, + SearchButtonNodeWrite, +] diff --git a/src/webflow/resources/components/types/component_properties_write_properties_item.py b/src/webflow/resources/components/types/component_properties_write_properties_item.py index b4f8f50..30da057 100644 --- a/src/webflow/resources/components/types/component_properties_write_properties_item.py +++ b/src/webflow/resources/components/types/component_properties_write_properties_item.py @@ -1,26 +1,26 @@ # This file was auto-generated by Fern from our API Definition. -from ....core.pydantic_utilities import UniversalBaseModel +import typing + +import pydantic import typing_extensions +from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ....core.serialization import FieldMetadata -import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 -import typing class ComponentPropertiesWritePropertiesItem(UniversalBaseModel): - property_id: typing_extensions.Annotated[str, FieldMetadata(alias="propertyId")] = pydantic.Field() - """ - The ID of the property. - """ - + property_id: typing_extensions.Annotated[ + str, + FieldMetadata(alias="propertyId"), + pydantic.Field(alias="propertyId", description="The ID of the property."), + ] text: str = pydantic.Field() """ The new string or HTML value used to update the component property in the secondary locale. The provided value must be compatible with the type of the component property. - For example, attempting to update a single-line plain-text property with a multi-line + For example, attempting to update a single-line plain-text property with a multi-line value will result in an error. """ diff --git a/src/webflow/resources/components/types/components_update_content_response.py b/src/webflow/resources/components/types/components_update_content_response.py index 6129dda..9021766 100644 --- a/src/webflow/resources/components/types/components_update_content_response.py +++ b/src/webflow/resources/components/types/components_update_content_response.py @@ -1,9 +1,9 @@ # This file was auto-generated by Fern from our API Definition. -from ....core.pydantic_utilities import UniversalBaseModel import typing + import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel class ComponentsUpdateContentResponse(UniversalBaseModel): diff --git a/src/webflow/resources/components/types/components_update_properties_response.py b/src/webflow/resources/components/types/components_update_properties_response.py index b0c8824..7dffd8b 100644 --- a/src/webflow/resources/components/types/components_update_properties_response.py +++ b/src/webflow/resources/components/types/components_update_properties_response.py @@ -1,9 +1,9 @@ # This file was auto-generated by Fern from our API Definition. -from ....core.pydantic_utilities import UniversalBaseModel import typing + import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel class ComponentsUpdatePropertiesResponse(UniversalBaseModel): diff --git a/src/webflow/resources/ecommerce/__init__.py b/src/webflow/resources/ecommerce/__init__.py index f3ea265..5cde020 100644 --- a/src/webflow/resources/ecommerce/__init__.py +++ b/src/webflow/resources/ecommerce/__init__.py @@ -1,2 +1,4 @@ # This file was auto-generated by Fern from our API Definition. +# isort: skip_file + diff --git a/src/webflow/resources/ecommerce/client.py b/src/webflow/resources/ecommerce/client.py index bbd3a5d..e62f87b 100644 --- a/src/webflow/resources/ecommerce/client.py +++ b/src/webflow/resources/ecommerce/client.py @@ -1,27 +1,27 @@ # This file was auto-generated by Fern from our API Definition. -from ...core.client_wrapper import SyncClientWrapper import typing + +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ...core.request_options import RequestOptions from ...types.ecommerce_settings import EcommerceSettings -from ...core.jsonable_encoder import jsonable_encoder -from ...core.pydantic_utilities import parse_obj_as -from ...errors.bad_request_error import BadRequestError -from ...errors.unauthorized_error import UnauthorizedError -from ...types.error import Error -from ...errors.forbidden_error import ForbiddenError -from ...errors.not_found_error import NotFoundError -from ...errors.conflict_error import ConflictError -from ...errors.too_many_requests_error import TooManyRequestsError -from ...errors.internal_server_error import InternalServerError -from json.decoder import JSONDecodeError -from ...core.api_error import ApiError -from ...core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawEcommerceClient, RawEcommerceClient class EcommerceClient: def __init__(self, *, client_wrapper: SyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = RawEcommerceClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawEcommerceClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawEcommerceClient + """ + return self._raw_client def get_settings( self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None @@ -55,99 +55,24 @@ def get_settings( site_id="580e63e98c9a982ac9b8b741", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/ecommerce/settings", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - EcommerceSettings, - parse_obj_as( - type_=EcommerceSettings, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.get_settings(site_id, request_options=request_options) + return _response.data class AsyncEcommerceClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = AsyncRawEcommerceClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawEcommerceClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawEcommerceClient + """ + return self._raw_client async def get_settings( self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None @@ -189,91 +114,5 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/ecommerce/settings", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - EcommerceSettings, - parse_obj_as( - type_=EcommerceSettings, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.get_settings(site_id, request_options=request_options) + return _response.data diff --git a/src/webflow/resources/access_groups/client.py b/src/webflow/resources/ecommerce/raw_client.py similarity index 52% rename from src/webflow/resources/access_groups/client.py rename to src/webflow/resources/ecommerce/raw_client.py index ee7668a..4aa1da3 100644 --- a/src/webflow/resources/access_groups/client.py +++ b/src/webflow/resources/ecommerce/raw_client.py @@ -1,301 +1,278 @@ # This file was auto-generated by Fern from our API Definition. -from ...core.client_wrapper import SyncClientWrapper import typing -from .types.access_groups_list_request_sort import AccessGroupsListRequestSort -from ...core.request_options import RequestOptions -from ...types.access_group_list import AccessGroupList +from json.decoder import JSONDecodeError + +from ...core.api_error import ApiError +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from ...core.http_response import AsyncHttpResponse, HttpResponse from ...core.jsonable_encoder import jsonable_encoder +from ...core.parse_error import ParsingError from ...core.pydantic_utilities import parse_obj_as +from ...core.request_options import RequestOptions from ...errors.bad_request_error import BadRequestError -from ...errors.unauthorized_error import UnauthorizedError -from ...types.error import Error +from ...errors.conflict_error import ConflictError from ...errors.forbidden_error import ForbiddenError +from ...errors.internal_server_error import InternalServerError from ...errors.not_found_error import NotFoundError from ...errors.too_many_requests_error import TooManyRequestsError -from ...errors.internal_server_error import InternalServerError -from json.decoder import JSONDecodeError -from ...core.api_error import ApiError -from ...core.client_wrapper import AsyncClientWrapper +from ...errors.unauthorized_error import UnauthorizedError +from ...types.ecommerce_settings import EcommerceSettings +from ...types.error import Error +from pydantic import ValidationError -class AccessGroupsClient: +class RawEcommerceClient: def __init__(self, *, client_wrapper: SyncClientWrapper): self._client_wrapper = client_wrapper - def list( - self, - site_id: str, - *, - offset: typing.Optional[float] = None, - limit: typing.Optional[float] = None, - sort: typing.Optional[AccessGroupsListRequestSort] = None, - request_options: typing.Optional[RequestOptions] = None, - ) -> AccessGroupList: + def get_settings( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[EcommerceSettings]: """ - Get a list of access groups for a site + Retrieve ecommerce settings for a site. - Required scope | `users:read` + Required scope | `ecommerce:read` Parameters ---------- site_id : str Unique identifier for a Site - offset : typing.Optional[float] - Offset used for pagination if the results have more than limit records - - limit : typing.Optional[float] - Maximum number of records to be returned (max limit: 100) - - sort : typing.Optional[AccessGroupsListRequestSort] - Sort string to use when ordering access groups - Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) - request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- - AccessGroupList + HttpResponse[EcommerceSettings] Request was successful - - Examples - -------- - from webflow import Webflow - - client = Webflow( - access_token="YOUR_ACCESS_TOKEN", - ) - client.access_groups.list( - site_id="580e63e98c9a982ac9b8b741", - ) """ _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/accessgroups", + f"sites/{jsonable_encoder(site_id)}/ecommerce/settings", + base_url=self._client_wrapper.get_environment().base, method="GET", - params={ - "offset": offset, - "limit": limit, - "sort": sort, - }, request_options=request_options, ) try: if 200 <= _response.status_code < 300: - return typing.cast( - AccessGroupList, + _data = typing.cast( + EcommerceSettings, parse_obj_as( - type_=AccessGroupList, # type: ignore + type_=EcommerceSettings, # type: ignore object_=_response.json(), ), ) + return HttpResponse(response=_response, data=_data) if _response.status_code == 400: raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], + headers=dict(_response.headers), + body=typing.cast( + typing.Any, parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore + type_=typing.Any, # type: ignore object_=_response.json(), ), - ) + ), ) if _response.status_code == 401: raise UnauthorizedError( - typing.cast( + headers=dict(_response.headers), + body=typing.cast( Error, parse_obj_as( type_=Error, # type: ignore object_=_response.json(), ), - ) + ), ) if _response.status_code == 403: raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], + headers=dict(_response.headers), + body=typing.cast( + typing.Any, parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore + type_=typing.Any, # type: ignore object_=_response.json(), ), - ) + ), ) if _response.status_code == 404: raise NotFoundError( - typing.cast( + headers=dict(_response.headers), + body=typing.cast( Error, parse_obj_as( type_=Error, # type: ignore object_=_response.json(), ), - ) + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), ) if _response.status_code == 429: raise TooManyRequestsError( - typing.cast( + headers=dict(_response.headers), + body=typing.cast( Error, parse_obj_as( type_=Error, # type: ignore object_=_response.json(), ), - ) + ), ) if _response.status_code == 500: raise InternalServerError( - typing.cast( + headers=dict(_response.headers), + body=typing.cast( Error, parse_obj_as( type_=Error, # type: ignore object_=_response.json(), ), - ) + ), ) _response_json = _response.json() except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) -class AsyncAccessGroupsClient: +class AsyncRawEcommerceClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): self._client_wrapper = client_wrapper - async def list( - self, - site_id: str, - *, - offset: typing.Optional[float] = None, - limit: typing.Optional[float] = None, - sort: typing.Optional[AccessGroupsListRequestSort] = None, - request_options: typing.Optional[RequestOptions] = None, - ) -> AccessGroupList: + async def get_settings( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[EcommerceSettings]: """ - Get a list of access groups for a site + Retrieve ecommerce settings for a site. - Required scope | `users:read` + Required scope | `ecommerce:read` Parameters ---------- site_id : str Unique identifier for a Site - offset : typing.Optional[float] - Offset used for pagination if the results have more than limit records - - limit : typing.Optional[float] - Maximum number of records to be returned (max limit: 100) - - sort : typing.Optional[AccessGroupsListRequestSort] - Sort string to use when ordering access groups - Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) - request_options : typing.Optional[RequestOptions] Request-specific configuration. Returns ------- - AccessGroupList + AsyncHttpResponse[EcommerceSettings] Request was successful - - Examples - -------- - import asyncio - - from webflow import AsyncWebflow - - client = AsyncWebflow( - access_token="YOUR_ACCESS_TOKEN", - ) - - - async def main() -> None: - await client.access_groups.list( - site_id="580e63e98c9a982ac9b8b741", - ) - - - asyncio.run(main()) """ _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/accessgroups", + f"sites/{jsonable_encoder(site_id)}/ecommerce/settings", + base_url=self._client_wrapper.get_environment().base, method="GET", - params={ - "offset": offset, - "limit": limit, - "sort": sort, - }, request_options=request_options, ) try: if 200 <= _response.status_code < 300: - return typing.cast( - AccessGroupList, + _data = typing.cast( + EcommerceSettings, parse_obj_as( - type_=AccessGroupList, # type: ignore + type_=EcommerceSettings, # type: ignore object_=_response.json(), ), ) + return AsyncHttpResponse(response=_response, data=_data) if _response.status_code == 400: raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], + headers=dict(_response.headers), + body=typing.cast( + typing.Any, parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore + type_=typing.Any, # type: ignore object_=_response.json(), ), - ) + ), ) if _response.status_code == 401: raise UnauthorizedError( - typing.cast( + headers=dict(_response.headers), + body=typing.cast( Error, parse_obj_as( type_=Error, # type: ignore object_=_response.json(), ), - ) + ), ) if _response.status_code == 403: raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], + headers=dict(_response.headers), + body=typing.cast( + typing.Any, parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore + type_=typing.Any, # type: ignore object_=_response.json(), ), - ) + ), ) if _response.status_code == 404: raise NotFoundError( - typing.cast( + headers=dict(_response.headers), + body=typing.cast( Error, parse_obj_as( type_=Error, # type: ignore object_=_response.json(), ), - ) + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), ) if _response.status_code == 429: raise TooManyRequestsError( - typing.cast( + headers=dict(_response.headers), + body=typing.cast( Error, parse_obj_as( type_=Error, # type: ignore object_=_response.json(), ), - ) + ), ) if _response.status_code == 500: raise InternalServerError( - typing.cast( + headers=dict(_response.headers), + body=typing.cast( Error, parse_obj_as( type_=Error, # type: ignore object_=_response.json(), ), - ) + ), ) _response_json = _response.json() except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/forms/__init__.py b/src/webflow/resources/forms/__init__.py index f3ea265..5cde020 100644 --- a/src/webflow/resources/forms/__init__.py +++ b/src/webflow/resources/forms/__init__.py @@ -1,2 +1,4 @@ # This file was auto-generated by Fern from our API Definition. +# isort: skip_file + diff --git a/src/webflow/resources/forms/client.py b/src/webflow/resources/forms/client.py index 515b631..f49ab25 100644 --- a/src/webflow/resources/forms/client.py +++ b/src/webflow/resources/forms/client.py @@ -1,25 +1,14 @@ # This file was auto-generated by Fern from our API Definition. import typing -from ...core.client_wrapper import SyncClientWrapper + +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ...core.request_options import RequestOptions -from ...types.form_list import FormList -from ...core.jsonable_encoder import jsonable_encoder -from ...core.pydantic_utilities import parse_obj_as -from ...errors.bad_request_error import BadRequestError -from ...errors.unauthorized_error import UnauthorizedError -from ...types.error import Error -from ...errors.forbidden_error import ForbiddenError -from ...errors.not_found_error import NotFoundError -from ...errors.conflict_error import ConflictError -from ...errors.too_many_requests_error import TooManyRequestsError -from ...errors.internal_server_error import InternalServerError -from json.decoder import JSONDecodeError -from ...core.api_error import ApiError from ...types.form import Form -from ...types.form_submission_list import FormSubmissionList +from ...types.form_list import FormList from ...types.form_submission import FormSubmission -from ...core.client_wrapper import AsyncClientWrapper +from ...types.form_submission_list import FormSubmissionList +from .raw_client import AsyncRawFormsClient, RawFormsClient # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) @@ -27,14 +16,25 @@ class FormsClient: def __init__(self, *, client_wrapper: SyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = RawFormsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawFormsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawFormsClient + """ + return self._raw_client def list( self, site_id: str, *, - limit: typing.Optional[float] = None, - offset: typing.Optional[float] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> FormList: """ @@ -47,10 +47,10 @@ def list( site_id : str Unique identifier for a Site - limit : typing.Optional[float] + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records request_options : typing.Optional[RequestOptions] @@ -70,100 +70,12 @@ def list( ) client.forms.list( site_id="580e63e98c9a982ac9b8b741", + limit=1, + offset=1, ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/forms", - method="GET", - params={ - "limit": limit, - "offset": offset, - }, - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - FormList, - parse_obj_as( - type_=FormList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.list(site_id, limit=limit, offset=offset, request_options=request_options) + return _response.data def get(self, form_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Form: """ @@ -195,96 +107,26 @@ def get(self, form_id: str, *, request_options: typing.Optional[RequestOptions] form_id="580e63e98c9a982ac9b8b741", ) """ - _response = self._client_wrapper.httpx_client.request( - f"forms/{jsonable_encoder(form_id)}", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Form, - parse_obj_as( - type_=Form, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.get(form_id, request_options=request_options) + return _response.data def list_submissions( self, form_id: str, *, - offset: typing.Optional[float] = None, - limit: typing.Optional[float] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> FormSubmissionList: """ List form submissions for a given form + + When a form is used in a component definition, each instance of the form is considered a unique form. + + To get a combined list of submissions for a form that appears across multiple component instances, use the [List Form Submissions by Site](/data/reference/forms/form-submissions/list-submissions-by-site) endpoint. + + Required scope | `forms:read` Parameters @@ -292,10 +134,10 @@ def list_submissions( form_id : str Unique identifier for a Form - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records - limit : typing.Optional[float] + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) request_options : typing.Optional[RequestOptions] @@ -315,90 +157,14 @@ def list_submissions( ) client.forms.list_submissions( form_id="580e63e98c9a982ac9b8b741", + offset=1, + limit=1, ) """ - _response = self._client_wrapper.httpx_client.request( - f"forms/{jsonable_encoder(form_id)}/submissions", - method="GET", - params={ - "offset": offset, - "limit": limit, - }, - request_options=request_options, + _response = self._raw_client.list_submissions( + form_id, offset=offset, limit=limit, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - FormSubmissionList, - parse_obj_as( - type_=FormSubmissionList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def get_submission( self, form_submission_id: str, *, request_options: typing.Optional[RequestOptions] = None @@ -432,90 +198,49 @@ def get_submission( form_submission_id="580e63e98c9a982ac9b8b741", ) """ - _response = self._client_wrapper.httpx_client.request( - f"form_submissions/{jsonable_encoder(form_submission_id)}", - method="GET", - request_options=request_options, + _response = self._raw_client.get_submission(form_submission_id, request_options=request_options) + return _response.data + + def delete_submission( + self, form_submission_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> None: + """ + Delete a form submission + + + Required scope | `forms:write` + + Parameters + ---------- + form_submission_id : str + Unique identifier for a Form Submission + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + None + + Examples + -------- + from webflow import Webflow + + client = Webflow( + access_token="YOUR_ACCESS_TOKEN", ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - FormSubmission, - parse_obj_as( - type_=FormSubmission, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + client.forms.delete_submission( + form_submission_id="580e63e98c9a982ac9b8b741", + ) + """ + _response = self._raw_client.delete_submission(form_submission_id, request_options=request_options) + return _response.data def update_submission( self, form_submission_id: str, *, - form_submission_data: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT, + form_submission_data: typing.Optional[typing.Dict[str, typing.Any]] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> FormSubmission: """ @@ -528,7 +253,7 @@ def update_submission( form_submission_id : str Unique identifier for a Form Submission - form_submission_data : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + form_submission_data : typing.Optional[typing.Dict[str, typing.Any]] An existing **hidden field** defined on the form schema, and the corresponding value to set request_options : typing.Optional[RequestOptions] @@ -550,113 +275,33 @@ def update_submission( form_submission_id="580e63e98c9a982ac9b8b741", ) """ - _response = self._client_wrapper.httpx_client.request( - f"form_submissions/{jsonable_encoder(form_submission_id)}", - method="PATCH", - json={ - "formSubmissionData": form_submission_data, - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, + _response = self._raw_client.update_submission( + form_submission_id, form_submission_data=form_submission_data, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - FormSubmission, - parse_obj_as( - type_=FormSubmission, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data class AsyncFormsClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = AsyncRawFormsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawFormsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawFormsClient + """ + return self._raw_client async def list( self, site_id: str, *, - limit: typing.Optional[float] = None, - offset: typing.Optional[float] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> FormList: """ @@ -669,10 +314,10 @@ async def list( site_id : str Unique identifier for a Site - limit : typing.Optional[float] + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records request_options : typing.Optional[RequestOptions] @@ -697,103 +342,15 @@ async def list( async def main() -> None: await client.forms.list( site_id="580e63e98c9a982ac9b8b741", + limit=1, + offset=1, ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/forms", - method="GET", - params={ - "limit": limit, - "offset": offset, - }, - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - FormList, - parse_obj_as( - type_=FormList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.list(site_id, limit=limit, offset=offset, request_options=request_options) + return _response.data async def get(self, form_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Form: """ @@ -833,96 +390,26 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"forms/{jsonable_encoder(form_id)}", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Form, - parse_obj_as( - type_=Form, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.get(form_id, request_options=request_options) + return _response.data async def list_submissions( self, form_id: str, *, - offset: typing.Optional[float] = None, - limit: typing.Optional[float] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> FormSubmissionList: """ List form submissions for a given form + + When a form is used in a component definition, each instance of the form is considered a unique form. + + To get a combined list of submissions for a form that appears across multiple component instances, use the [List Form Submissions by Site](/data/reference/forms/form-submissions/list-submissions-by-site) endpoint. + + Required scope | `forms:read` Parameters @@ -930,10 +417,10 @@ async def list_submissions( form_id : str Unique identifier for a Form - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records - limit : typing.Optional[float] + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) request_options : typing.Optional[RequestOptions] @@ -958,93 +445,17 @@ async def list_submissions( async def main() -> None: await client.forms.list_submissions( form_id="580e63e98c9a982ac9b8b741", + offset=1, + limit=1, ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"forms/{jsonable_encoder(form_id)}/submissions", - method="GET", - params={ - "offset": offset, - "limit": limit, - }, - request_options=request_options, + _response = await self._raw_client.list_submissions( + form_id, offset=offset, limit=limit, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - FormSubmissionList, - parse_obj_as( - type_=FormSubmissionList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def get_submission( self, form_submission_id: str, *, request_options: typing.Optional[RequestOptions] = None @@ -1086,90 +497,57 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"form_submissions/{jsonable_encoder(form_submission_id)}", - method="GET", - request_options=request_options, + _response = await self._raw_client.get_submission(form_submission_id, request_options=request_options) + return _response.data + + async def delete_submission( + self, form_submission_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> None: + """ + Delete a form submission + + + Required scope | `forms:write` + + Parameters + ---------- + form_submission_id : str + Unique identifier for a Form Submission + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + None + + Examples + -------- + import asyncio + + from webflow import AsyncWebflow + + client = AsyncWebflow( + access_token="YOUR_ACCESS_TOKEN", ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - FormSubmission, - parse_obj_as( - type_=FormSubmission, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + + + async def main() -> None: + await client.forms.delete_submission( + form_submission_id="580e63e98c9a982ac9b8b741", + ) + + + asyncio.run(main()) + """ + _response = await self._raw_client.delete_submission(form_submission_id, request_options=request_options) + return _response.data async def update_submission( self, form_submission_id: str, *, - form_submission_data: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = OMIT, + form_submission_data: typing.Optional[typing.Dict[str, typing.Any]] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> FormSubmission: """ @@ -1182,7 +560,7 @@ async def update_submission( form_submission_id : str Unique identifier for a Form Submission - form_submission_data : typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] + form_submission_data : typing.Optional[typing.Dict[str, typing.Any]] An existing **hidden field** defined on the form schema, and the corresponding value to set request_options : typing.Optional[RequestOptions] @@ -1212,98 +590,7 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"form_submissions/{jsonable_encoder(form_submission_id)}", - method="PATCH", - json={ - "formSubmissionData": form_submission_data, - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, + _response = await self._raw_client.update_submission( + form_submission_id, form_submission_data=form_submission_data, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - FormSubmission, - parse_obj_as( - type_=FormSubmission, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data diff --git a/src/webflow/resources/forms/raw_client.py b/src/webflow/resources/forms/raw_client.py new file mode 100644 index 0000000..aa85c4e --- /dev/null +++ b/src/webflow/resources/forms/raw_client.py @@ -0,0 +1,1532 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from ...core.api_error import ApiError +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from ...core.http_response import AsyncHttpResponse, HttpResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.parse_error import ParsingError +from ...core.pydantic_utilities import parse_obj_as +from ...core.request_options import RequestOptions +from ...errors.bad_request_error import BadRequestError +from ...errors.conflict_error import ConflictError +from ...errors.forbidden_error import ForbiddenError +from ...errors.internal_server_error import InternalServerError +from ...errors.not_found_error import NotFoundError +from ...errors.too_many_requests_error import TooManyRequestsError +from ...errors.unauthorized_error import UnauthorizedError +from ...types.error import Error +from ...types.form import Form +from ...types.form_list import FormList +from ...types.form_submission import FormSubmission +from ...types.form_submission_list import FormSubmissionList +from pydantic import ValidationError + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawFormsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def list( + self, + site_id: str, + *, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[FormList]: + """ + List forms for a given site. + + Required scope | `forms:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[FormList] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/forms", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "limit": limit, + "offset": offset, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + FormList, + parse_obj_as( + type_=FormList, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def get(self, form_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[Form]: + """ + Get information about a given form. + + Required scope | `forms:read` + + Parameters + ---------- + form_id : str + Unique identifier for a Form + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Form] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"forms/{jsonable_encoder(form_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Form, + parse_obj_as( + type_=Form, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def list_submissions( + self, + form_id: str, + *, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[FormSubmissionList]: + """ + List form submissions for a given form + + + When a form is used in a component definition, each instance of the form is considered a unique form. + + To get a combined list of submissions for a form that appears across multiple component instances, use the [List Form Submissions by Site](/data/reference/forms/form-submissions/list-submissions-by-site) endpoint. + + + Required scope | `forms:read` + + Parameters + ---------- + form_id : str + Unique identifier for a Form + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[FormSubmissionList] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"forms/{jsonable_encoder(form_id)}/submissions", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "offset": offset, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + FormSubmissionList, + parse_obj_as( + type_=FormSubmissionList, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def get_submission( + self, form_submission_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[FormSubmission]: + """ + Get information about a given form submissio. + + Required scope | `forms:read` + + Parameters + ---------- + form_submission_id : str + Unique identifier for a Form Submission + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[FormSubmission] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"form_submissions/{jsonable_encoder(form_submission_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + FormSubmission, + parse_obj_as( + type_=FormSubmission, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def delete_submission( + self, form_submission_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[None]: + """ + Delete a form submission + + + Required scope | `forms:write` + + Parameters + ---------- + form_submission_id : str + Unique identifier for a Form Submission + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[None] + """ + _response = self._client_wrapper.httpx_client.request( + f"form_submissions/{jsonable_encoder(form_submission_id)}", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return HttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def update_submission( + self, + form_submission_id: str, + *, + form_submission_data: typing.Optional[typing.Dict[str, typing.Any]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[FormSubmission]: + """ + Update hidden fields on a form submission + + Required scope | `forms:write` + + Parameters + ---------- + form_submission_id : str + Unique identifier for a Form Submission + + form_submission_data : typing.Optional[typing.Dict[str, typing.Any]] + An existing **hidden field** defined on the form schema, and the corresponding value to set + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[FormSubmission] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"form_submissions/{jsonable_encoder(form_submission_id)}", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + json={ + "formSubmissionData": form_submission_data, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + FormSubmission, + parse_obj_as( + type_=FormSubmission, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawFormsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def list( + self, + site_id: str, + *, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[FormList]: + """ + List forms for a given site. + + Required scope | `forms:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[FormList] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/forms", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "limit": limit, + "offset": offset, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + FormList, + parse_obj_as( + type_=FormList, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def get( + self, form_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[Form]: + """ + Get information about a given form. + + Required scope | `forms:read` + + Parameters + ---------- + form_id : str + Unique identifier for a Form + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Form] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"forms/{jsonable_encoder(form_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Form, + parse_obj_as( + type_=Form, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def list_submissions( + self, + form_id: str, + *, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[FormSubmissionList]: + """ + List form submissions for a given form + + + When a form is used in a component definition, each instance of the form is considered a unique form. + + To get a combined list of submissions for a form that appears across multiple component instances, use the [List Form Submissions by Site](/data/reference/forms/form-submissions/list-submissions-by-site) endpoint. + + + Required scope | `forms:read` + + Parameters + ---------- + form_id : str + Unique identifier for a Form + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[FormSubmissionList] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"forms/{jsonable_encoder(form_id)}/submissions", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "offset": offset, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + FormSubmissionList, + parse_obj_as( + type_=FormSubmissionList, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def get_submission( + self, form_submission_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[FormSubmission]: + """ + Get information about a given form submissio. + + Required scope | `forms:read` + + Parameters + ---------- + form_submission_id : str + Unique identifier for a Form Submission + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[FormSubmission] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"form_submissions/{jsonable_encoder(form_submission_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + FormSubmission, + parse_obj_as( + type_=FormSubmission, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def delete_submission( + self, form_submission_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[None]: + """ + Delete a form submission + + + Required scope | `forms:write` + + Parameters + ---------- + form_submission_id : str + Unique identifier for a Form Submission + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[None] + """ + _response = await self._client_wrapper.httpx_client.request( + f"form_submissions/{jsonable_encoder(form_submission_id)}", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return AsyncHttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def update_submission( + self, + form_submission_id: str, + *, + form_submission_data: typing.Optional[typing.Dict[str, typing.Any]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[FormSubmission]: + """ + Update hidden fields on a form submission + + Required scope | `forms:write` + + Parameters + ---------- + form_submission_id : str + Unique identifier for a Form Submission + + form_submission_data : typing.Optional[typing.Dict[str, typing.Any]] + An existing **hidden field** defined on the form schema, and the corresponding value to set + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[FormSubmission] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"form_submissions/{jsonable_encoder(form_submission_id)}", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + json={ + "formSubmissionData": form_submission_data, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + FormSubmission, + parse_obj_as( + type_=FormSubmission, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/inventory/__init__.py b/src/webflow/resources/inventory/__init__.py index f95deee..018e6a1 100644 --- a/src/webflow/resources/inventory/__init__.py +++ b/src/webflow/resources/inventory/__init__.py @@ -1,5 +1,37 @@ # This file was auto-generated by Fern from our API Definition. -from .types import InventoryUpdateRequestInventoryType +# isort: skip_file -__all__ = ["InventoryUpdateRequestInventoryType"] +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .types import EcommInventoryChangedPayload, InventoryUpdateRequestInventoryType +_dynamic_imports: typing.Dict[str, str] = { + "EcommInventoryChangedPayload": ".types", + "InventoryUpdateRequestInventoryType": ".types", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + + +__all__ = ["EcommInventoryChangedPayload", "InventoryUpdateRequestInventoryType"] diff --git a/src/webflow/resources/inventory/client.py b/src/webflow/resources/inventory/client.py index 27e4f3c..51c9454 100644 --- a/src/webflow/resources/inventory/client.py +++ b/src/webflow/resources/inventory/client.py @@ -1,23 +1,12 @@ # This file was auto-generated by Fern from our API Definition. import typing -from ...core.client_wrapper import SyncClientWrapper + +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ...core.request_options import RequestOptions from ...types.inventory_item import InventoryItem -from ...core.jsonable_encoder import jsonable_encoder -from ...core.pydantic_utilities import parse_obj_as -from ...errors.bad_request_error import BadRequestError -from ...errors.unauthorized_error import UnauthorizedError -from ...types.error import Error -from ...errors.forbidden_error import ForbiddenError -from ...errors.not_found_error import NotFoundError -from ...errors.conflict_error import ConflictError -from ...errors.too_many_requests_error import TooManyRequestsError -from ...errors.internal_server_error import InternalServerError -from json.decoder import JSONDecodeError -from ...core.api_error import ApiError +from .raw_client import AsyncRawInventoryClient, RawInventoryClient from .types.inventory_update_request_inventory_type import InventoryUpdateRequestInventoryType -from ...core.client_wrapper import AsyncClientWrapper # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) @@ -25,10 +14,21 @@ class InventoryClient: def __init__(self, *, client_wrapper: SyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = RawInventoryClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawInventoryClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawInventoryClient + """ + return self._raw_client def list( - self, collection_id: str, item_id: str, *, request_options: typing.Optional[RequestOptions] = None + self, sku_collection_id: str, sku_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> InventoryItem: """ List the current inventory levels for a particular SKU item. @@ -37,11 +37,11 @@ def list( Parameters ---------- - collection_id : str - Unique identifier for a Collection + sku_collection_id : str + Unique identifier for a SKU collection. Use the List Collections API to find this ID. - item_id : str - Unique identifier for an Item + sku_id : str + Unique identifier for a SKU request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -59,103 +59,17 @@ def list( access_token="YOUR_ACCESS_TOKEN", ) client.inventory.list( - collection_id="580e63fc8c9a982ac9b8b745", - item_id="580e64008c9a982ac9b8b754", + sku_collection_id="6377a7c4b7a79608c34a46f7", + sku_id="5e8518516e147040726cc415", ) """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}/inventory", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - InventoryItem, - parse_obj_as( - type_=InventoryItem, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.list(sku_collection_id, sku_id, request_options=request_options) + return _response.data def update( self, - collection_id: str, - item_id: str, + sku_collection_id: str, + sku_id: str, *, inventory_type: InventoryUpdateRequestInventoryType, update_quantity: typing.Optional[float] = OMIT, @@ -173,11 +87,11 @@ def update( Parameters ---------- - collection_id : str - Unique identifier for a Collection + sku_collection_id : str + Unique identifier for a SKU collection. Use the List Collections API to find this ID. - item_id : str - Unique identifier for an Item + sku_id : str + Unique identifier for a SKU inventory_type : InventoryUpdateRequestInventoryType infinite or finite @@ -204,116 +118,39 @@ def update( access_token="YOUR_ACCESS_TOKEN", ) client.inventory.update( - collection_id="580e63fc8c9a982ac9b8b745", - item_id="580e64008c9a982ac9b8b754", + sku_collection_id="6377a7c4b7a79608c34a46f7", + sku_id="5e8518516e147040726cc415", inventory_type="infinite", ) """ - _response = self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}/inventory", - method="PATCH", - json={ - "inventoryType": inventory_type, - "updateQuantity": update_quantity, - "quantity": quantity, - }, - headers={ - "content-type": "application/json", - }, + _response = self._raw_client.update( + sku_collection_id, + sku_id, + inventory_type=inventory_type, + update_quantity=update_quantity, + quantity=quantity, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - InventoryItem, - parse_obj_as( - type_=InventoryItem, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data class AsyncInventoryClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = AsyncRawInventoryClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawInventoryClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawInventoryClient + """ + return self._raw_client async def list( - self, collection_id: str, item_id: str, *, request_options: typing.Optional[RequestOptions] = None + self, sku_collection_id: str, sku_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> InventoryItem: """ List the current inventory levels for a particular SKU item. @@ -322,11 +159,11 @@ async def list( Parameters ---------- - collection_id : str - Unique identifier for a Collection + sku_collection_id : str + Unique identifier for a SKU collection. Use the List Collections API to find this ID. - item_id : str - Unique identifier for an Item + sku_id : str + Unique identifier for a SKU request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -349,106 +186,20 @@ async def list( async def main() -> None: await client.inventory.list( - collection_id="580e63fc8c9a982ac9b8b745", - item_id="580e64008c9a982ac9b8b754", + sku_collection_id="6377a7c4b7a79608c34a46f7", + sku_id="5e8518516e147040726cc415", ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}/inventory", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - InventoryItem, - parse_obj_as( - type_=InventoryItem, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.list(sku_collection_id, sku_id, request_options=request_options) + return _response.data async def update( self, - collection_id: str, - item_id: str, + sku_collection_id: str, + sku_id: str, *, inventory_type: InventoryUpdateRequestInventoryType, update_quantity: typing.Optional[float] = OMIT, @@ -466,11 +217,11 @@ async def update( Parameters ---------- - collection_id : str - Unique identifier for a Collection + sku_collection_id : str + Unique identifier for a SKU collection. Use the List Collections API to find this ID. - item_id : str - Unique identifier for an Item + sku_id : str + Unique identifier for a SKU inventory_type : InventoryUpdateRequestInventoryType infinite or finite @@ -502,108 +253,20 @@ async def update( async def main() -> None: await client.inventory.update( - collection_id="580e63fc8c9a982ac9b8b745", - item_id="580e64008c9a982ac9b8b754", + sku_collection_id="6377a7c4b7a79608c34a46f7", + sku_id="5e8518516e147040726cc415", inventory_type="infinite", ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"collections/{jsonable_encoder(collection_id)}/items/{jsonable_encoder(item_id)}/inventory", - method="PATCH", - json={ - "inventoryType": inventory_type, - "updateQuantity": update_quantity, - "quantity": quantity, - }, - headers={ - "content-type": "application/json", - }, + _response = await self._raw_client.update( + sku_collection_id, + sku_id, + inventory_type=inventory_type, + update_quantity=update_quantity, + quantity=quantity, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - InventoryItem, - parse_obj_as( - type_=InventoryItem, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data diff --git a/src/webflow/resources/inventory/raw_client.py b/src/webflow/resources/inventory/raw_client.py new file mode 100644 index 0000000..af0c454 --- /dev/null +++ b/src/webflow/resources/inventory/raw_client.py @@ -0,0 +1,598 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from ...core.api_error import ApiError +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from ...core.http_response import AsyncHttpResponse, HttpResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.parse_error import ParsingError +from ...core.pydantic_utilities import parse_obj_as +from ...core.request_options import RequestOptions +from ...errors.bad_request_error import BadRequestError +from ...errors.conflict_error import ConflictError +from ...errors.forbidden_error import ForbiddenError +from ...errors.internal_server_error import InternalServerError +from ...errors.not_found_error import NotFoundError +from ...errors.too_many_requests_error import TooManyRequestsError +from ...errors.unauthorized_error import UnauthorizedError +from ...types.error import Error +from ...types.inventory_item import InventoryItem +from .types.inventory_update_request_inventory_type import InventoryUpdateRequestInventoryType +from pydantic import ValidationError + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawInventoryClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def list( + self, sku_collection_id: str, sku_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[InventoryItem]: + """ + List the current inventory levels for a particular SKU item. + + Required scope | `ecommerce:read` + + Parameters + ---------- + sku_collection_id : str + Unique identifier for a SKU collection. Use the List Collections API to find this ID. + + sku_id : str + Unique identifier for a SKU + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[InventoryItem] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(sku_collection_id)}/items/{jsonable_encoder(sku_id)}/inventory", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + InventoryItem, + parse_obj_as( + type_=InventoryItem, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def update( + self, + sku_collection_id: str, + sku_id: str, + *, + inventory_type: InventoryUpdateRequestInventoryType, + update_quantity: typing.Optional[float] = OMIT, + quantity: typing.Optional[float] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[InventoryItem]: + """ + Updates the current inventory levels for a particular SKU item. + + Updates may be given in one or two methods, absolutely or incrementally. + - Absolute updates are done by setting `quantity` directly. + - Incremental updates are by specifying the inventory delta in `updateQuantity` which is then added to the `quantity` stored on the server. + + Required scope | `ecommerce:write` + + Parameters + ---------- + sku_collection_id : str + Unique identifier for a SKU collection. Use the List Collections API to find this ID. + + sku_id : str + Unique identifier for a SKU + + inventory_type : InventoryUpdateRequestInventoryType + infinite or finite + + update_quantity : typing.Optional[float] + Adds this quantity to currently store quantity. Can be negative. + + quantity : typing.Optional[float] + Immediately sets quantity to this value. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[InventoryItem] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(sku_collection_id)}/items/{jsonable_encoder(sku_id)}/inventory", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + json={ + "inventoryType": inventory_type, + "updateQuantity": update_quantity, + "quantity": quantity, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + InventoryItem, + parse_obj_as( + type_=InventoryItem, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawInventoryClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def list( + self, sku_collection_id: str, sku_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[InventoryItem]: + """ + List the current inventory levels for a particular SKU item. + + Required scope | `ecommerce:read` + + Parameters + ---------- + sku_collection_id : str + Unique identifier for a SKU collection. Use the List Collections API to find this ID. + + sku_id : str + Unique identifier for a SKU + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[InventoryItem] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(sku_collection_id)}/items/{jsonable_encoder(sku_id)}/inventory", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + InventoryItem, + parse_obj_as( + type_=InventoryItem, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def update( + self, + sku_collection_id: str, + sku_id: str, + *, + inventory_type: InventoryUpdateRequestInventoryType, + update_quantity: typing.Optional[float] = OMIT, + quantity: typing.Optional[float] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[InventoryItem]: + """ + Updates the current inventory levels for a particular SKU item. + + Updates may be given in one or two methods, absolutely or incrementally. + - Absolute updates are done by setting `quantity` directly. + - Incremental updates are by specifying the inventory delta in `updateQuantity` which is then added to the `quantity` stored on the server. + + Required scope | `ecommerce:write` + + Parameters + ---------- + sku_collection_id : str + Unique identifier for a SKU collection. Use the List Collections API to find this ID. + + sku_id : str + Unique identifier for a SKU + + inventory_type : InventoryUpdateRequestInventoryType + infinite or finite + + update_quantity : typing.Optional[float] + Adds this quantity to currently store quantity. Can be negative. + + quantity : typing.Optional[float] + Immediately sets quantity to this value. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[InventoryItem] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"collections/{jsonable_encoder(sku_collection_id)}/items/{jsonable_encoder(sku_id)}/inventory", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + json={ + "inventoryType": inventory_type, + "updateQuantity": update_quantity, + "quantity": quantity, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + InventoryItem, + parse_obj_as( + type_=InventoryItem, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/inventory/types/__init__.py b/src/webflow/resources/inventory/types/__init__.py index e929f4e..2cc6148 100644 --- a/src/webflow/resources/inventory/types/__init__.py +++ b/src/webflow/resources/inventory/types/__init__.py @@ -1,5 +1,38 @@ # This file was auto-generated by Fern from our API Definition. -from .inventory_update_request_inventory_type import InventoryUpdateRequestInventoryType +# isort: skip_file -__all__ = ["InventoryUpdateRequestInventoryType"] +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .ecomm_inventory_changed_payload import EcommInventoryChangedPayload + from .inventory_update_request_inventory_type import InventoryUpdateRequestInventoryType +_dynamic_imports: typing.Dict[str, str] = { + "EcommInventoryChangedPayload": ".ecomm_inventory_changed_payload", + "InventoryUpdateRequestInventoryType": ".inventory_update_request_inventory_type", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + + +__all__ = ["EcommInventoryChangedPayload", "InventoryUpdateRequestInventoryType"] diff --git a/src/webflow/resources/inventory/types/ecomm_inventory_changed_payload.py b/src/webflow/resources/inventory/types/ecomm_inventory_changed_payload.py new file mode 100644 index 0000000..729740d --- /dev/null +++ b/src/webflow/resources/inventory/types/ecomm_inventory_changed_payload.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ....core.serialization import FieldMetadata +from ....types.inventory_item import InventoryItem + + +class EcommInventoryChangedPayload(UniversalBaseModel): + trigger_type: typing_extensions.Annotated[ + typing.Optional[typing.Literal["ecomm_inventory_changed"]], + FieldMetadata(alias="triggerType"), + pydantic.Field(alias="triggerType"), + ] = None + payload: typing.Optional[InventoryItem] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/resources/orders/__init__.py b/src/webflow/resources/orders/__init__.py index 7076133..7af8880 100644 --- a/src/webflow/resources/orders/__init__.py +++ b/src/webflow/resources/orders/__init__.py @@ -1,5 +1,34 @@ # This file was auto-generated by Fern from our API Definition. -from .types import OrdersListRequestStatus, OrdersRefundRequestReason +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .types import OrdersListRequestStatus, OrdersRefundRequestReason +_dynamic_imports: typing.Dict[str, str] = {"OrdersListRequestStatus": ".types", "OrdersRefundRequestReason": ".types"} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + __all__ = ["OrdersListRequestStatus", "OrdersRefundRequestReason"] diff --git a/src/webflow/resources/orders/client.py b/src/webflow/resources/orders/client.py index 4aa4b77..ef55043 100644 --- a/src/webflow/resources/orders/client.py +++ b/src/webflow/resources/orders/client.py @@ -1,25 +1,14 @@ # This file was auto-generated by Fern from our API Definition. import typing -from ...core.client_wrapper import SyncClientWrapper -from .types.orders_list_request_status import OrdersListRequestStatus + +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ...core.request_options import RequestOptions -from ...types.order_list import OrderList -from ...core.jsonable_encoder import jsonable_encoder -from ...core.pydantic_utilities import parse_obj_as -from ...errors.bad_request_error import BadRequestError -from ...errors.unauthorized_error import UnauthorizedError -from ...types.error import Error -from ...errors.forbidden_error import ForbiddenError -from ...errors.not_found_error import NotFoundError -from ...errors.conflict_error import ConflictError -from ...errors.too_many_requests_error import TooManyRequestsError -from ...errors.internal_server_error import InternalServerError -from json.decoder import JSONDecodeError -from ...core.api_error import ApiError from ...types.order import Order +from ...types.order_list import OrderList +from .raw_client import AsyncRawOrdersClient, RawOrdersClient +from .types.orders_list_request_status import OrdersListRequestStatus from .types.orders_refund_request_reason import OrdersRefundRequestReason -from ...core.client_wrapper import AsyncClientWrapper # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) @@ -27,15 +16,26 @@ class OrdersClient: def __init__(self, *, client_wrapper: SyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = RawOrdersClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawOrdersClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawOrdersClient + """ + return self._raw_client def list( self, site_id: str, *, status: typing.Optional[OrdersListRequestStatus] = None, - offset: typing.Optional[float] = None, - limit: typing.Optional[float] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> OrderList: """ @@ -51,10 +51,10 @@ def list( status : typing.Optional[OrdersListRequestStatus] Filter the orders by status - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records - limit : typing.Optional[float] + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) request_options : typing.Optional[RequestOptions] @@ -74,101 +74,15 @@ def list( ) client.orders.list( site_id="580e63e98c9a982ac9b8b741", + status="pending", + offset=1, + limit=1, ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/orders", - method="GET", - params={ - "status": status, - "offset": offset, - "limit": limit, - }, - request_options=request_options, + _response = self._raw_client.list( + site_id, status=status, offset=offset, limit=limit, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - OrderList, - parse_obj_as( - type_=OrderList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def get(self, site_id: str, order_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Order: """ @@ -205,94 +119,8 @@ def get(self, site_id: str, order_id: str, *, request_options: typing.Optional[R order_id="5e8518516e147040726cc415", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/orders/{jsonable_encoder(order_id)}", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Order, - parse_obj_as( - type_=Order, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.get(site_id, order_id, request_options=request_options) + return _response.data def update( self, @@ -352,104 +180,16 @@ def update( order_id="5e8518516e147040726cc415", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/orders/{jsonable_encoder(order_id)}", - method="PATCH", - json={ - "comment": comment, - "shippingProvider": shipping_provider, - "shippingTracking": shipping_tracking, - "shippingTrackingURL": shipping_tracking_url, - }, - headers={ - "content-type": "application/json", - }, + _response = self._raw_client.update( + site_id, + order_id, + comment=comment, + shipping_provider=shipping_provider, + shipping_tracking=shipping_tracking, + shipping_tracking_url=shipping_tracking_url, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Order, - parse_obj_as( - type_=Order, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def update_fulfill( self, @@ -495,101 +235,10 @@ def update_fulfill( order_id="5e8518516e147040726cc415", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/orders/{jsonable_encoder(order_id)}/fulfill", - method="POST", - json={ - "sendOrderFulfilledEmail": send_order_fulfilled_email, - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, + _response = self._raw_client.update_fulfill( + site_id, order_id, send_order_fulfilled_email=send_order_fulfilled_email, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Order, - parse_obj_as( - type_=Order, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def update_unfulfill( self, site_id: str, order_id: str, *, request_options: typing.Optional[RequestOptions] = None @@ -627,94 +276,8 @@ def update_unfulfill( order_id="5e8518516e147040726cc415", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/orders/{jsonable_encoder(order_id)}/unfulfill", - method="POST", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Order, - parse_obj_as( - type_=Order, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.update_unfulfill(site_id, order_id, request_options=request_options) + return _response.data def refund( self, @@ -761,114 +324,32 @@ def refund( order_id="5e8518516e147040726cc415", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/orders/{jsonable_encoder(order_id)}/refund", - method="POST", - json={ - "reason": reason, - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Order, - parse_obj_as( - type_=Order, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.refund(site_id, order_id, reason=reason, request_options=request_options) + return _response.data class AsyncOrdersClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = AsyncRawOrdersClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawOrdersClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawOrdersClient + """ + return self._raw_client async def list( self, site_id: str, *, status: typing.Optional[OrdersListRequestStatus] = None, - offset: typing.Optional[float] = None, - limit: typing.Optional[float] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> OrderList: """ @@ -884,10 +365,10 @@ async def list( status : typing.Optional[OrdersListRequestStatus] Filter the orders by status - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records - limit : typing.Optional[float] + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) request_options : typing.Optional[RequestOptions] @@ -912,104 +393,18 @@ async def list( async def main() -> None: await client.orders.list( site_id="580e63e98c9a982ac9b8b741", + status="pending", + offset=1, + limit=1, ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/orders", - method="GET", - params={ - "status": status, - "offset": offset, - "limit": limit, - }, - request_options=request_options, + _response = await self._raw_client.list( + site_id, status=status, offset=offset, limit=limit, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - OrderList, - parse_obj_as( - type_=OrderList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def get( self, site_id: str, order_id: str, *, request_options: typing.Optional[RequestOptions] = None @@ -1056,94 +451,8 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/orders/{jsonable_encoder(order_id)}", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Order, - parse_obj_as( - type_=Order, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.get(site_id, order_id, request_options=request_options) + return _response.data async def update( self, @@ -1211,104 +520,16 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/orders/{jsonable_encoder(order_id)}", - method="PATCH", - json={ - "comment": comment, - "shippingProvider": shipping_provider, - "shippingTracking": shipping_tracking, - "shippingTrackingURL": shipping_tracking_url, - }, - headers={ - "content-type": "application/json", - }, + _response = await self._raw_client.update( + site_id, + order_id, + comment=comment, + shipping_provider=shipping_provider, + shipping_tracking=shipping_tracking, + shipping_tracking_url=shipping_tracking_url, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Order, - parse_obj_as( - type_=Order, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def update_fulfill( self, @@ -1362,101 +583,10 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/orders/{jsonable_encoder(order_id)}/fulfill", - method="POST", - json={ - "sendOrderFulfilledEmail": send_order_fulfilled_email, - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, + _response = await self._raw_client.update_fulfill( + site_id, order_id, send_order_fulfilled_email=send_order_fulfilled_email, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Order, - parse_obj_as( - type_=Order, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def update_unfulfill( self, site_id: str, order_id: str, *, request_options: typing.Optional[RequestOptions] = None @@ -1502,94 +632,8 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/orders/{jsonable_encoder(order_id)}/unfulfill", - method="POST", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Order, - parse_obj_as( - type_=Order, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.update_unfulfill(site_id, order_id, request_options=request_options) + return _response.data async def refund( self, @@ -1644,98 +688,5 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/orders/{jsonable_encoder(order_id)}/refund", - method="POST", - json={ - "reason": reason, - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Order, - parse_obj_as( - type_=Order, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.refund(site_id, order_id, reason=reason, request_options=request_options) + return _response.data diff --git a/src/webflow/resources/orders/raw_client.py b/src/webflow/resources/orders/raw_client.py new file mode 100644 index 0000000..be3cd04 --- /dev/null +++ b/src/webflow/resources/orders/raw_client.py @@ -0,0 +1,1712 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from ...core.api_error import ApiError +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from ...core.http_response import AsyncHttpResponse, HttpResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.parse_error import ParsingError +from ...core.pydantic_utilities import parse_obj_as +from ...core.request_options import RequestOptions +from ...errors.bad_request_error import BadRequestError +from ...errors.conflict_error import ConflictError +from ...errors.forbidden_error import ForbiddenError +from ...errors.internal_server_error import InternalServerError +from ...errors.not_found_error import NotFoundError +from ...errors.too_many_requests_error import TooManyRequestsError +from ...errors.unauthorized_error import UnauthorizedError +from ...types.error import Error +from ...types.order import Order +from ...types.order_list import OrderList +from .types.orders_list_request_status import OrdersListRequestStatus +from .types.orders_refund_request_reason import OrdersRefundRequestReason +from pydantic import ValidationError + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawOrdersClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def list( + self, + site_id: str, + *, + status: typing.Optional[OrdersListRequestStatus] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[OrderList]: + """ + List all orders created for a given site. + + Required scope | `ecommerce:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + status : typing.Optional[OrdersListRequestStatus] + Filter the orders by status + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[OrderList] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/orders", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "status": status, + "offset": offset, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + OrderList, + parse_obj_as( + type_=OrderList, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def get( + self, site_id: str, order_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[Order]: + """ + Retrieve a single product by its ID. All of its SKUs will also be + retrieved. + + Required scope | `ecommerce:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + order_id : str + Unique identifier for an Order + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Order] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/orders/{jsonable_encoder(order_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Order, + parse_obj_as( + type_=Order, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def update( + self, + site_id: str, + order_id: str, + *, + comment: typing.Optional[str] = OMIT, + shipping_provider: typing.Optional[str] = OMIT, + shipping_tracking: typing.Optional[str] = OMIT, + shipping_tracking_url: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[Order]: + """ + This API lets you update the fields, `comment`, `shippingProvider`, + and/or `shippingTracking` for a given order. All three fields can be + updated simultaneously or independently. + + Required scope | `ecommerce:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + order_id : str + Unique identifier for an Order + + comment : typing.Optional[str] + Arbitrary data for your records + + shipping_provider : typing.Optional[str] + Company or method used to ship order + + shipping_tracking : typing.Optional[str] + Tracking number for order shipment + + shipping_tracking_url : typing.Optional[str] + URL to track order shipment + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Order] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/orders/{jsonable_encoder(order_id)}", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + json={ + "comment": comment, + "shippingProvider": shipping_provider, + "shippingTracking": shipping_tracking, + "shippingTrackingURL": shipping_tracking_url, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Order, + parse_obj_as( + type_=Order, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def update_fulfill( + self, + site_id: str, + order_id: str, + *, + send_order_fulfilled_email: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[Order]: + """ + Updates an order's status to fulfilled + + Required scope | `ecommerce:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + order_id : str + Unique identifier for an Order + + send_order_fulfilled_email : typing.Optional[bool] + Whether or not the Order Fulfilled email should be sent + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Order] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/orders/{jsonable_encoder(order_id)}/fulfill", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "sendOrderFulfilledEmail": send_order_fulfilled_email, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Order, + parse_obj_as( + type_=Order, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def update_unfulfill( + self, site_id: str, order_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[Order]: + """ + Updates an order's status to unfulfilled + + Required scope | `ecommerce:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + order_id : str + Unique identifier for an Order + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Order] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/orders/{jsonable_encoder(order_id)}/unfulfill", + base_url=self._client_wrapper.get_environment().base, + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Order, + parse_obj_as( + type_=Order, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def refund( + self, + site_id: str, + order_id: str, + *, + reason: typing.Optional[OrdersRefundRequestReason] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[Order]: + """ + This API will reverse a Stripe charge and refund an order back to a + customer. It will also set the order's status to `refunded`. + + Required scope | `ecommerce:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + order_id : str + Unique identifier for an Order + + reason : typing.Optional[OrdersRefundRequestReason] + The reason for the refund + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Order] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/orders/{jsonable_encoder(order_id)}/refund", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "reason": reason, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Order, + parse_obj_as( + type_=Order, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawOrdersClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def list( + self, + site_id: str, + *, + status: typing.Optional[OrdersListRequestStatus] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[OrderList]: + """ + List all orders created for a given site. + + Required scope | `ecommerce:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + status : typing.Optional[OrdersListRequestStatus] + Filter the orders by status + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[OrderList] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/orders", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "status": status, + "offset": offset, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + OrderList, + parse_obj_as( + type_=OrderList, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def get( + self, site_id: str, order_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[Order]: + """ + Retrieve a single product by its ID. All of its SKUs will also be + retrieved. + + Required scope | `ecommerce:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + order_id : str + Unique identifier for an Order + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Order] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/orders/{jsonable_encoder(order_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Order, + parse_obj_as( + type_=Order, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def update( + self, + site_id: str, + order_id: str, + *, + comment: typing.Optional[str] = OMIT, + shipping_provider: typing.Optional[str] = OMIT, + shipping_tracking: typing.Optional[str] = OMIT, + shipping_tracking_url: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[Order]: + """ + This API lets you update the fields, `comment`, `shippingProvider`, + and/or `shippingTracking` for a given order. All three fields can be + updated simultaneously or independently. + + Required scope | `ecommerce:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + order_id : str + Unique identifier for an Order + + comment : typing.Optional[str] + Arbitrary data for your records + + shipping_provider : typing.Optional[str] + Company or method used to ship order + + shipping_tracking : typing.Optional[str] + Tracking number for order shipment + + shipping_tracking_url : typing.Optional[str] + URL to track order shipment + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Order] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/orders/{jsonable_encoder(order_id)}", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + json={ + "comment": comment, + "shippingProvider": shipping_provider, + "shippingTracking": shipping_tracking, + "shippingTrackingURL": shipping_tracking_url, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Order, + parse_obj_as( + type_=Order, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def update_fulfill( + self, + site_id: str, + order_id: str, + *, + send_order_fulfilled_email: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[Order]: + """ + Updates an order's status to fulfilled + + Required scope | `ecommerce:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + order_id : str + Unique identifier for an Order + + send_order_fulfilled_email : typing.Optional[bool] + Whether or not the Order Fulfilled email should be sent + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Order] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/orders/{jsonable_encoder(order_id)}/fulfill", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "sendOrderFulfilledEmail": send_order_fulfilled_email, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Order, + parse_obj_as( + type_=Order, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def update_unfulfill( + self, site_id: str, order_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[Order]: + """ + Updates an order's status to unfulfilled + + Required scope | `ecommerce:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + order_id : str + Unique identifier for an Order + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Order] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/orders/{jsonable_encoder(order_id)}/unfulfill", + base_url=self._client_wrapper.get_environment().base, + method="POST", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Order, + parse_obj_as( + type_=Order, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def refund( + self, + site_id: str, + order_id: str, + *, + reason: typing.Optional[OrdersRefundRequestReason] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[Order]: + """ + This API will reverse a Stripe charge and refund an order back to a + customer. It will also set the order's status to `refunded`. + + Required scope | `ecommerce:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + order_id : str + Unique identifier for an Order + + reason : typing.Optional[OrdersRefundRequestReason] + The reason for the refund + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Order] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/orders/{jsonable_encoder(order_id)}/refund", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "reason": reason, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Order, + parse_obj_as( + type_=Order, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/orders/types/__init__.py b/src/webflow/resources/orders/types/__init__.py index 7df0fa1..d06e415 100644 --- a/src/webflow/resources/orders/types/__init__.py +++ b/src/webflow/resources/orders/types/__init__.py @@ -1,6 +1,38 @@ # This file was auto-generated by Fern from our API Definition. -from .orders_list_request_status import OrdersListRequestStatus -from .orders_refund_request_reason import OrdersRefundRequestReason +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .orders_list_request_status import OrdersListRequestStatus + from .orders_refund_request_reason import OrdersRefundRequestReason +_dynamic_imports: typing.Dict[str, str] = { + "OrdersListRequestStatus": ".orders_list_request_status", + "OrdersRefundRequestReason": ".orders_refund_request_reason", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + __all__ = ["OrdersListRequestStatus", "OrdersRefundRequestReason"] diff --git a/src/webflow/resources/pages/__init__.py b/src/webflow/resources/pages/__init__.py index 0fed8e6..25684a4 100644 --- a/src/webflow/resources/pages/__init__.py +++ b/src/webflow/resources/pages/__init__.py @@ -1,6 +1,52 @@ # This file was auto-generated by Fern from our API Definition. -from .types import PageDomWriteNodesItem, UpdateStaticContentResponse -from .resources import scripts +# isort: skip_file -__all__ = ["PageDomWriteNodesItem", "UpdateStaticContentResponse", "scripts"] +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .types import ( + PageDomWriteNodesItem, + PageMetadataWriteOpenGraph, + PageMetadataWriteSeo, + UpdateStaticContentResponse, + ) + from .resources import scripts +_dynamic_imports: typing.Dict[str, str] = { + "PageDomWriteNodesItem": ".types", + "PageMetadataWriteOpenGraph": ".types", + "PageMetadataWriteSeo": ".types", + "UpdateStaticContentResponse": ".types", + "scripts": ".resources", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + + +__all__ = [ + "PageDomWriteNodesItem", + "PageMetadataWriteOpenGraph", + "PageMetadataWriteSeo", + "UpdateStaticContentResponse", + "scripts", +] diff --git a/src/webflow/resources/pages/client.py b/src/webflow/resources/pages/client.py index 851f4e7..9f6f980 100644 --- a/src/webflow/resources/pages/client.py +++ b/src/webflow/resources/pages/client.py @@ -1,48 +1,50 @@ # This file was auto-generated by Fern from our API Definition. +from __future__ import annotations + import typing -from ...core.client_wrapper import SyncClientWrapper -from .resources.scripts.client import ScriptsClient + +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ...core.request_options import RequestOptions -from ...types.page_list import PageList -from ...core.jsonable_encoder import jsonable_encoder -from ...core.pydantic_utilities import parse_obj_as -from ...errors.bad_request_error import BadRequestError -from ...errors.unauthorized_error import UnauthorizedError -from ...types.error import Error -from ...errors.not_found_error import NotFoundError -from ...errors.too_many_requests_error import TooManyRequestsError -from ...errors.internal_server_error import InternalServerError -from json.decoder import JSONDecodeError -from ...core.api_error import ApiError -from ...types.page import Page -import datetime as dt -from ...types.page_seo import PageSeo -from ...types.page_open_graph import PageOpenGraph -from ...core.serialization import convert_and_respect_annotation_metadata from ...types.dom import Dom -from ...errors.forbidden_error import ForbiddenError +from ...types.page import Page +from ...types.page_list import PageList +from .raw_client import AsyncRawPagesClient, RawPagesClient from .types.page_dom_write_nodes_item import PageDomWriteNodesItem +from .types.page_metadata_write_open_graph import PageMetadataWriteOpenGraph +from .types.page_metadata_write_seo import PageMetadataWriteSeo from .types.update_static_content_response import UpdateStaticContentResponse -from ...core.client_wrapper import AsyncClientWrapper -from .resources.scripts.client import AsyncScriptsClient +if typing.TYPE_CHECKING: + from .resources.scripts.client import AsyncScriptsClient, ScriptsClient # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) class PagesClient: def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawPagesClient(client_wrapper=client_wrapper) self._client_wrapper = client_wrapper - self.scripts = ScriptsClient(client_wrapper=self._client_wrapper) + self._scripts: typing.Optional[ScriptsClient] = None + + @property + def with_raw_response(self) -> RawPagesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawPagesClient + """ + return self._raw_client def list( self, site_id: str, *, locale_id: typing.Optional[str] = None, - limit: typing.Optional[float] = None, - offset: typing.Optional[float] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> PageList: """ @@ -56,12 +58,14 @@ def list( Unique identifier for a Site locale_id : typing.Optional[str] - Unique identifier for a specific locale. Applicable, when using localization. + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) - limit : typing.Optional[float] + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records request_options : typing.Optional[RequestOptions] @@ -82,81 +86,14 @@ def list( client.pages.list( site_id="580e63e98c9a982ac9b8b741", locale_id="65427cf400e02b306eaa04a0", + limit=1, + offset=1, ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/pages", - method="GET", - params={ - "localeId": locale_id, - "limit": limit, - "offset": offset, - }, - request_options=request_options, + _response = self._raw_client.list( + site_id, locale_id=locale_id, limit=limit, offset=offset, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - PageList, - parse_obj_as( - type_=PageList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def get_metadata( self, @@ -176,7 +113,9 @@ def get_metadata( Unique identifier for a Page locale_id : typing.Optional[str] - Unique identifier for a specific locale. Applicable, when using localization. + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -198,100 +137,18 @@ def get_metadata( locale_id="65427cf400e02b306eaa04a0", ) """ - _response = self._client_wrapper.httpx_client.request( - f"pages/{jsonable_encoder(page_id)}", - method="GET", - params={ - "localeId": locale_id, - }, - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Page, - parse_obj_as( - type_=Page, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.get_metadata(page_id, locale_id=locale_id, request_options=request_options) + return _response.data def update_page_settings( self, page_id: str, *, - id: str, locale_id: typing.Optional[str] = None, - site_id: typing.Optional[str] = OMIT, title: typing.Optional[str] = OMIT, slug: typing.Optional[str] = OMIT, - parent_id: typing.Optional[str] = OMIT, - collection_id: typing.Optional[str] = OMIT, - created_on: typing.Optional[dt.datetime] = OMIT, - last_updated: typing.Optional[dt.datetime] = OMIT, - archived: typing.Optional[bool] = OMIT, - draft: typing.Optional[bool] = OMIT, - can_branch: typing.Optional[bool] = OMIT, - is_branch: typing.Optional[bool] = OMIT, - is_members_only: typing.Optional[bool] = OMIT, - seo: typing.Optional[PageSeo] = OMIT, - open_graph: typing.Optional[PageOpenGraph] = OMIT, - page_locale_id: typing.Optional[str] = OMIT, - published_path: typing.Optional[str] = OMIT, + seo: typing.Optional[PageMetadataWriteSeo] = OMIT, + open_graph: typing.Optional[PageMetadataWriteOpenGraph] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> Page: """ @@ -304,60 +161,26 @@ def update_page_settings( page_id : str Unique identifier for a Page - id : str - Unique identifier for the Page - locale_id : typing.Optional[str] - Unique identifier for a specific locale. Applicable, when using localization. + Unique identifier for a specific Locale. - site_id : typing.Optional[str] - Unique identifier for the Site + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) title : typing.Optional[str] - Title of the Page + Title for the page slug : typing.Optional[str] - slug of the Page (derived from title) - - parent_id : typing.Optional[str] - Identifier of the parent folder - - collection_id : typing.Optional[str] - Unique identifier for a linked Collection, value will be null if the Page is not part of a Collection. - - created_on : typing.Optional[dt.datetime] - The date the Page was created - - last_updated : typing.Optional[dt.datetime] - The date the Page was most recently updated - - archived : typing.Optional[bool] - Whether the Page has been archived - - draft : typing.Optional[bool] - Whether the Page is a draft - - can_branch : typing.Optional[bool] - Indicates whether the Page supports [Page Branching](https://university.webflow.com/lesson/page-branching) + Slug for the page. - is_branch : typing.Optional[bool] - Indicates whether the Page is a Branch of another Page [Page Branching](https://university.webflow.com/lesson/page-branching) - is_members_only : typing.Optional[bool] - Indicates whether the Page is restricted by [Memberships Controls](https://university.webflow.com/lesson/webflow-memberships-overview#how-to-manage-page-restrictions) + **Note:** Updating slugs in secondary locales is only supported in Advanced and Enterprise localization add-on plans. - seo : typing.Optional[PageSeo] + seo : typing.Optional[PageMetadataWriteSeo] SEO-related fields for the Page - open_graph : typing.Optional[PageOpenGraph] + open_graph : typing.Optional[PageMetadataWriteOpenGraph] Open Graph fields for the Page - page_locale_id : typing.Optional[str] - Unique ID of the page locale - - published_path : typing.Optional[str] - Relative path of the published page URL - request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -368,9 +191,11 @@ def update_page_settings( Examples -------- - import datetime - - from webflow import PageOpenGraph, PageSeo, Webflow + from webflow import Webflow + from webflow.resources.pages import ( + PageMetadataWriteOpenGraph, + PageMetadataWriteSeo, + ) client = Webflow( access_token="YOUR_ACCESS_TOKEN", @@ -378,142 +203,44 @@ def update_page_settings( client.pages.update_page_settings( page_id="63c720f9347c2139b248e552", locale_id="65427cf400e02b306eaa04a0", - id="6596da6045e56dee495bcbba", - site_id="6258612d1ee792848f805dcf", title="Guide to the Galaxy", slug="guide-to-the-galaxy", - created_on=datetime.datetime.fromisoformat( - "2024-03-11 10:42:00+00:00", - ), - last_updated=datetime.datetime.fromisoformat( - "2024-03-11 10:42:42+00:00", - ), - archived=False, - draft=False, - can_branch=True, - is_branch=False, - seo=PageSeo( + seo=PageMetadataWriteSeo( title="The Ultimate Hitchhiker's Guide to the Galaxy", description="Everything you need to know about the galaxy, from avoiding Vogon poetry to the importance of towels.", ), - open_graph=PageOpenGraph( + open_graph=PageMetadataWriteOpenGraph( title="Explore the Cosmos with The Ultimate Guide", title_copied=False, description="Dive deep into the mysteries of the universe with your guide to everything galactic.", description_copied=False, ), - page_locale_id="653fd9af6a07fc9cfd7a5e57", - published_path="/en-us/guide-to-the-galaxy", ) """ - _response = self._client_wrapper.httpx_client.request( - f"pages/{jsonable_encoder(page_id)}", - method="PUT", - params={ - "localeId": locale_id, - }, - json={ - "id": id, - "siteId": site_id, - "title": title, - "slug": slug, - "parentId": parent_id, - "collectionId": collection_id, - "createdOn": created_on, - "lastUpdated": last_updated, - "archived": archived, - "draft": draft, - "canBranch": can_branch, - "isBranch": is_branch, - "isMembersOnly": is_members_only, - "seo": convert_and_respect_annotation_metadata(object_=seo, annotation=PageSeo, direction="write"), - "openGraph": convert_and_respect_annotation_metadata( - object_=open_graph, annotation=PageOpenGraph, direction="write" - ), - "localeId": locale_id, - "publishedPath": published_path, - }, + _response = self._raw_client.update_page_settings( + page_id, + locale_id=locale_id, + title=title, + slug=slug, + seo=seo, + open_graph=open_graph, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Page, - parse_obj_as( - type_=Page, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def get_content( self, page_id: str, *, locale_id: typing.Optional[str] = None, - limit: typing.Optional[float] = None, - offset: typing.Optional[float] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> Dom: """ - Get static content from a static page. This includes text nodes, image nodes and component instances. - To retrieve the contents of components in the page use the [get component content](/data/reference/pages-and-components/components/get-content) endpoint. + Get text and component instance content from a static page. - If you do not provide a Locale ID in your request, the response will return any content that can be localized from the Primary locale. + Localization Required scope | `pages:read` @@ -523,12 +250,14 @@ def get_content( Unique identifier for a Page locale_id : typing.Optional[str] - Unique identifier for a specific locale. Applicable, when using localization. + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) - limit : typing.Optional[float] + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records request_options : typing.Optional[RequestOptions] @@ -549,91 +278,14 @@ def get_content( client.pages.get_content( page_id="63c720f9347c2139b248e552", locale_id="65427cf400e02b306eaa04a0", + limit=1, + offset=1, ) """ - _response = self._client_wrapper.httpx_client.request( - f"pages/{jsonable_encoder(page_id)}/dom", - method="GET", - params={ - "localeId": locale_id, - "limit": limit, - "offset": offset, - }, - request_options=request_options, + _response = self._raw_client.get_content( + page_id, locale_id=locale_id, limit=limit, offset=offset, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Dom, - parse_obj_as( - type_=Dom, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def update_static_content( self, @@ -647,8 +299,9 @@ def update_static_content( This endpoint updates content on a static page in **secondary locales**. It supports updating up to 1000 nodes in a single request. Before making updates: - 1. Use the [get page content](/data/reference/pages-and-components/pages/get-content) endpoint to identify available content nodes and their types - 2. If the page has component instances, retrieve the component's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint + 1. Use the [get page content](/data/reference/pages-and-components/pages/get-content) endpoint to identify available content nodes and their types. + 2. If the page has component instances, retrieve the component's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint. + 3. DOM elements may include a `data-w-id` attribute. This attribute is used by Webflow to maintain custom attributes and links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales. This endpoint is specifically for localized pages. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail. @@ -680,6 +333,10 @@ def update_static_content( from webflow import ( ComponentInstanceNodePropertyOverridesWrite, ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem, + Select, + SelectNodeWriteChoicesItem, + SubmitButtonNodeWrite, + TextInputNodeWrite, TextNodeWrite, Webflow, ) @@ -699,6 +356,28 @@ def update_static_content( node_id="a245c12d-995b-55ee-5ec7-aa36a6cad627", text="

Don't Panic!

Always know where your towel is.

", ), + Select( + node_id="a245c12d-995b-55ee-5ec7-aa36a6cad635", + choices=[ + SelectNodeWriteChoicesItem( + value="choice-1", + text="First choice", + ), + SelectNodeWriteChoicesItem( + value="choice-2", + text="Second choice", + ), + ], + ), + TextInputNodeWrite( + node_id="a245c12d-995b-55ee-5ec7-aa36a6cad642", + placeholder="Enter something here...", + ), + SubmitButtonNodeWrite( + node_id="a245c12d-995b-55ee-5ec7-aa36a6cad671", + value="Submit", + waiting_text="Submitting...", + ), ComponentInstanceNodePropertyOverridesWrite( node_id="a245c12d-995b-55ee-5ec7-aa36a6cad629", property_overrides=[ @@ -715,110 +394,44 @@ def update_static_content( ], ) """ - _response = self._client_wrapper.httpx_client.request( - f"pages/{jsonable_encoder(page_id)}/dom", - method="POST", - params={ - "localeId": locale_id, - }, - json={ - "nodes": convert_and_respect_annotation_metadata( - object_=nodes, annotation=typing.Sequence[PageDomWriteNodesItem], direction="write" - ), - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, + _response = self._raw_client.update_static_content( + page_id, locale_id=locale_id, nodes=nodes, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - UpdateStaticContentResponse, - parse_obj_as( - type_=UpdateStaticContentResponse, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data + + @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 class AsyncPagesClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawPagesClient(client_wrapper=client_wrapper) self._client_wrapper = client_wrapper - self.scripts = AsyncScriptsClient(client_wrapper=self._client_wrapper) + self._scripts: typing.Optional[AsyncScriptsClient] = None + + @property + def with_raw_response(self) -> AsyncRawPagesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawPagesClient + """ + return self._raw_client async def list( self, site_id: str, *, locale_id: typing.Optional[str] = None, - limit: typing.Optional[float] = None, - offset: typing.Optional[float] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> PageList: """ @@ -832,12 +445,14 @@ async def list( Unique identifier for a Site locale_id : typing.Optional[str] - Unique identifier for a specific locale. Applicable, when using localization. + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) - limit : typing.Optional[float] + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records request_options : typing.Optional[RequestOptions] @@ -863,84 +478,17 @@ async def main() -> None: await client.pages.list( site_id="580e63e98c9a982ac9b8b741", locale_id="65427cf400e02b306eaa04a0", + limit=1, + offset=1, ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/pages", - method="GET", - params={ - "localeId": locale_id, - "limit": limit, - "offset": offset, - }, - request_options=request_options, + _response = await self._raw_client.list( + site_id, locale_id=locale_id, limit=limit, offset=offset, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - PageList, - parse_obj_as( - type_=PageList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def get_metadata( self, @@ -960,7 +508,9 @@ async def get_metadata( Unique identifier for a Page locale_id : typing.Optional[str] - Unique identifier for a specific locale. Applicable, when using localization. + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -990,100 +540,18 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"pages/{jsonable_encoder(page_id)}", - method="GET", - params={ - "localeId": locale_id, - }, - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Page, - parse_obj_as( - type_=Page, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.get_metadata(page_id, locale_id=locale_id, request_options=request_options) + return _response.data async def update_page_settings( self, page_id: str, *, - id: str, locale_id: typing.Optional[str] = None, - site_id: typing.Optional[str] = OMIT, title: typing.Optional[str] = OMIT, slug: typing.Optional[str] = OMIT, - parent_id: typing.Optional[str] = OMIT, - collection_id: typing.Optional[str] = OMIT, - created_on: typing.Optional[dt.datetime] = OMIT, - last_updated: typing.Optional[dt.datetime] = OMIT, - archived: typing.Optional[bool] = OMIT, - draft: typing.Optional[bool] = OMIT, - can_branch: typing.Optional[bool] = OMIT, - is_branch: typing.Optional[bool] = OMIT, - is_members_only: typing.Optional[bool] = OMIT, - seo: typing.Optional[PageSeo] = OMIT, - open_graph: typing.Optional[PageOpenGraph] = OMIT, - page_locale_id: typing.Optional[str] = OMIT, - published_path: typing.Optional[str] = OMIT, + seo: typing.Optional[PageMetadataWriteSeo] = OMIT, + open_graph: typing.Optional[PageMetadataWriteOpenGraph] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> Page: """ @@ -1096,60 +564,26 @@ async def update_page_settings( page_id : str Unique identifier for a Page - id : str - Unique identifier for the Page - locale_id : typing.Optional[str] - Unique identifier for a specific locale. Applicable, when using localization. + Unique identifier for a specific Locale. - site_id : typing.Optional[str] - Unique identifier for the Site + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) title : typing.Optional[str] - Title of the Page + Title for the page slug : typing.Optional[str] - slug of the Page (derived from title) - - parent_id : typing.Optional[str] - Identifier of the parent folder + Slug for the page. - collection_id : typing.Optional[str] - Unique identifier for a linked Collection, value will be null if the Page is not part of a Collection. - created_on : typing.Optional[dt.datetime] - The date the Page was created + **Note:** Updating slugs in secondary locales is only supported in Advanced and Enterprise localization add-on plans. - last_updated : typing.Optional[dt.datetime] - The date the Page was most recently updated - - archived : typing.Optional[bool] - Whether the Page has been archived - - draft : typing.Optional[bool] - Whether the Page is a draft - - can_branch : typing.Optional[bool] - Indicates whether the Page supports [Page Branching](https://university.webflow.com/lesson/page-branching) - - is_branch : typing.Optional[bool] - Indicates whether the Page is a Branch of another Page [Page Branching](https://university.webflow.com/lesson/page-branching) - - is_members_only : typing.Optional[bool] - Indicates whether the Page is restricted by [Memberships Controls](https://university.webflow.com/lesson/webflow-memberships-overview#how-to-manage-page-restrictions) - - seo : typing.Optional[PageSeo] + seo : typing.Optional[PageMetadataWriteSeo] SEO-related fields for the Page - open_graph : typing.Optional[PageOpenGraph] + open_graph : typing.Optional[PageMetadataWriteOpenGraph] Open Graph fields for the Page - page_locale_id : typing.Optional[str] - Unique ID of the page locale - - published_path : typing.Optional[str] - Relative path of the published page URL - request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -1161,9 +595,12 @@ async def update_page_settings( Examples -------- import asyncio - import datetime - from webflow import AsyncWebflow, PageOpenGraph, PageSeo + from webflow import AsyncWebflow + from webflow.resources.pages import ( + PageMetadataWriteOpenGraph, + PageMetadataWriteSeo, + ) client = AsyncWebflow( access_token="YOUR_ACCESS_TOKEN", @@ -1174,145 +611,47 @@ async def main() -> None: await client.pages.update_page_settings( page_id="63c720f9347c2139b248e552", locale_id="65427cf400e02b306eaa04a0", - id="6596da6045e56dee495bcbba", - site_id="6258612d1ee792848f805dcf", title="Guide to the Galaxy", slug="guide-to-the-galaxy", - created_on=datetime.datetime.fromisoformat( - "2024-03-11 10:42:00+00:00", - ), - last_updated=datetime.datetime.fromisoformat( - "2024-03-11 10:42:42+00:00", - ), - archived=False, - draft=False, - can_branch=True, - is_branch=False, - seo=PageSeo( + seo=PageMetadataWriteSeo( title="The Ultimate Hitchhiker's Guide to the Galaxy", description="Everything you need to know about the galaxy, from avoiding Vogon poetry to the importance of towels.", ), - open_graph=PageOpenGraph( + open_graph=PageMetadataWriteOpenGraph( title="Explore the Cosmos with The Ultimate Guide", title_copied=False, description="Dive deep into the mysteries of the universe with your guide to everything galactic.", description_copied=False, ), - page_locale_id="653fd9af6a07fc9cfd7a5e57", - published_path="/en-us/guide-to-the-galaxy", ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"pages/{jsonable_encoder(page_id)}", - method="PUT", - params={ - "localeId": locale_id, - }, - json={ - "id": id, - "siteId": site_id, - "title": title, - "slug": slug, - "parentId": parent_id, - "collectionId": collection_id, - "createdOn": created_on, - "lastUpdated": last_updated, - "archived": archived, - "draft": draft, - "canBranch": can_branch, - "isBranch": is_branch, - "isMembersOnly": is_members_only, - "seo": convert_and_respect_annotation_metadata(object_=seo, annotation=PageSeo, direction="write"), - "openGraph": convert_and_respect_annotation_metadata( - object_=open_graph, annotation=PageOpenGraph, direction="write" - ), - "localeId": locale_id, - "publishedPath": published_path, - }, + _response = await self._raw_client.update_page_settings( + page_id, + locale_id=locale_id, + title=title, + slug=slug, + seo=seo, + open_graph=open_graph, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Page, - parse_obj_as( - type_=Page, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def get_content( self, page_id: str, *, locale_id: typing.Optional[str] = None, - limit: typing.Optional[float] = None, - offset: typing.Optional[float] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> Dom: """ - Get static content from a static page. This includes text nodes, image nodes and component instances. - To retrieve the contents of components in the page use the [get component content](/data/reference/pages-and-components/components/get-content) endpoint. + Get text and component instance content from a static page. - If you do not provide a Locale ID in your request, the response will return any content that can be localized from the Primary locale. + Localization Required scope | `pages:read` @@ -1322,12 +661,14 @@ async def get_content( Unique identifier for a Page locale_id : typing.Optional[str] - Unique identifier for a specific locale. Applicable, when using localization. + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) - limit : typing.Optional[float] + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records request_options : typing.Optional[RequestOptions] @@ -1353,94 +694,17 @@ async def main() -> None: await client.pages.get_content( page_id="63c720f9347c2139b248e552", locale_id="65427cf400e02b306eaa04a0", + limit=1, + offset=1, ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"pages/{jsonable_encoder(page_id)}/dom", - method="GET", - params={ - "localeId": locale_id, - "limit": limit, - "offset": offset, - }, - request_options=request_options, + _response = await self._raw_client.get_content( + page_id, locale_id=locale_id, limit=limit, offset=offset, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Dom, - parse_obj_as( - type_=Dom, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def update_static_content( self, @@ -1454,8 +718,9 @@ async def update_static_content( This endpoint updates content on a static page in **secondary locales**. It supports updating up to 1000 nodes in a single request. Before making updates: - 1. Use the [get page content](/data/reference/pages-and-components/pages/get-content) endpoint to identify available content nodes and their types - 2. If the page has component instances, retrieve the component's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint + 1. Use the [get page content](/data/reference/pages-and-components/pages/get-content) endpoint to identify available content nodes and their types. + 2. If the page has component instances, retrieve the component's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint. + 3. DOM elements may include a `data-w-id` attribute. This attribute is used by Webflow to maintain custom attributes and links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales. This endpoint is specifically for localized pages. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail. @@ -1490,6 +755,10 @@ async def update_static_content( AsyncWebflow, ComponentInstanceNodePropertyOverridesWrite, ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem, + Select, + SelectNodeWriteChoicesItem, + SubmitButtonNodeWrite, + TextInputNodeWrite, TextNodeWrite, ) @@ -1511,6 +780,28 @@ async def main() -> None: node_id="a245c12d-995b-55ee-5ec7-aa36a6cad627", text="

Don't Panic!

Always know where your towel is.

", ), + Select( + node_id="a245c12d-995b-55ee-5ec7-aa36a6cad635", + choices=[ + SelectNodeWriteChoicesItem( + value="choice-1", + text="First choice", + ), + SelectNodeWriteChoicesItem( + value="choice-2", + text="Second choice", + ), + ], + ), + TextInputNodeWrite( + node_id="a245c12d-995b-55ee-5ec7-aa36a6cad642", + placeholder="Enter something here...", + ), + SubmitButtonNodeWrite( + node_id="a245c12d-995b-55ee-5ec7-aa36a6cad671", + value="Submit", + waiting_text="Submitting...", + ), ComponentInstanceNodePropertyOverridesWrite( node_id="a245c12d-995b-55ee-5ec7-aa36a6cad629", property_overrides=[ @@ -1530,93 +821,15 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"pages/{jsonable_encoder(page_id)}/dom", - method="POST", - params={ - "localeId": locale_id, - }, - json={ - "nodes": convert_and_respect_annotation_metadata( - object_=nodes, annotation=typing.Sequence[PageDomWriteNodesItem], direction="write" - ), - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, + _response = await self._raw_client.update_static_content( + page_id, locale_id=locale_id, nodes=nodes, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - UpdateStaticContentResponse, - parse_obj_as( - type_=UpdateStaticContentResponse, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data + + @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 diff --git a/src/webflow/resources/pages/raw_client.py b/src/webflow/resources/pages/raw_client.py new file mode 100644 index 0000000..1287d92 --- /dev/null +++ b/src/webflow/resources/pages/raw_client.py @@ -0,0 +1,1365 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from ...core.api_error import ApiError +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from ...core.http_response import AsyncHttpResponse, HttpResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.parse_error import ParsingError +from ...core.pydantic_utilities import parse_obj_as +from ...core.request_options import RequestOptions +from ...core.serialization import convert_and_respect_annotation_metadata +from ...errors.bad_request_error import BadRequestError +from ...errors.forbidden_error import ForbiddenError +from ...errors.internal_server_error import InternalServerError +from ...errors.not_found_error import NotFoundError +from ...errors.too_many_requests_error import TooManyRequestsError +from ...errors.unauthorized_error import UnauthorizedError +from ...types.dom import Dom +from ...types.error import Error +from ...types.page import Page +from ...types.page_list import PageList +from .types.page_dom_write_nodes_item import PageDomWriteNodesItem +from .types.page_metadata_write_open_graph import PageMetadataWriteOpenGraph +from .types.page_metadata_write_seo import PageMetadataWriteSeo +from .types.update_static_content_response import UpdateStaticContentResponse +from pydantic import ValidationError + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawPagesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def list( + self, + site_id: str, + *, + locale_id: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[PageList]: + """ + List of all pages for a site. + + Required scope | `pages:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[PageList] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/pages", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "localeId": locale_id, + "limit": limit, + "offset": offset, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + PageList, + parse_obj_as( + type_=PageList, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def get_metadata( + self, + page_id: str, + *, + locale_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[Page]: + """ + Get metadata information for a single page. + + Required scope | `pages:read` + + Parameters + ---------- + page_id : str + Unique identifier for a Page + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Page] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"pages/{jsonable_encoder(page_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "localeId": locale_id, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Page, + parse_obj_as( + type_=Page, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def update_page_settings( + self, + page_id: str, + *, + locale_id: typing.Optional[str] = None, + title: typing.Optional[str] = OMIT, + slug: typing.Optional[str] = OMIT, + seo: typing.Optional[PageMetadataWriteSeo] = OMIT, + open_graph: typing.Optional[PageMetadataWriteOpenGraph] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[Page]: + """ + Update Page-level metadata, including SEO and Open Graph fields. + + Required scope | `pages:write` + + Parameters + ---------- + page_id : str + Unique identifier for a Page + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + title : typing.Optional[str] + Title for the page + + slug : typing.Optional[str] + Slug for the page. + + + **Note:** Updating slugs in secondary locales is only supported in Advanced and Enterprise localization add-on plans. + + seo : typing.Optional[PageMetadataWriteSeo] + SEO-related fields for the Page + + open_graph : typing.Optional[PageMetadataWriteOpenGraph] + Open Graph fields for the Page + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Page] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"pages/{jsonable_encoder(page_id)}", + base_url=self._client_wrapper.get_environment().base, + method="PUT", + params={ + "localeId": locale_id, + }, + json={ + "title": title, + "slug": slug, + "seo": convert_and_respect_annotation_metadata( + object_=seo, annotation=PageMetadataWriteSeo, direction="write" + ), + "openGraph": convert_and_respect_annotation_metadata( + object_=open_graph, annotation=PageMetadataWriteOpenGraph, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Page, + parse_obj_as( + type_=Page, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def get_content( + self, + page_id: str, + *, + locale_id: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[Dom]: + """ + Get text and component instance content from a static page. + + Localization + + Required scope | `pages:read` + + Parameters + ---------- + page_id : str + Unique identifier for a Page + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Dom] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"pages/{jsonable_encoder(page_id)}/dom", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "localeId": locale_id, + "limit": limit, + "offset": offset, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Dom, + parse_obj_as( + type_=Dom, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def update_static_content( + self, + page_id: str, + *, + locale_id: str, + nodes: typing.Sequence[PageDomWriteNodesItem], + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[UpdateStaticContentResponse]: + """ + This endpoint updates content on a static page in **secondary locales**. It supports updating up to 1000 nodes in a single request. + + Before making updates: + 1. Use the [get page content](/data/reference/pages-and-components/pages/get-content) endpoint to identify available content nodes and their types. + 2. If the page has component instances, retrieve the component's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint. + 3. DOM elements may include a `data-w-id` attribute. This attribute is used by Webflow to maintain custom attributes and links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales. + + + This endpoint is specifically for localized pages. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail. + + + Required scope | `pages:write` + + Parameters + ---------- + page_id : str + Unique identifier for a Page + + locale_id : str + The locale identifier. + + nodes : typing.Sequence[PageDomWriteNodesItem] + List of DOM Nodes with the new content that will be updated in each node. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[UpdateStaticContentResponse] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"pages/{jsonable_encoder(page_id)}/dom", + base_url=self._client_wrapper.get_environment().base, + method="POST", + params={ + "localeId": locale_id, + }, + json={ + "nodes": convert_and_respect_annotation_metadata( + object_=nodes, annotation=typing.Sequence[PageDomWriteNodesItem], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateStaticContentResponse, + parse_obj_as( + type_=UpdateStaticContentResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawPagesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def list( + self, + site_id: str, + *, + locale_id: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[PageList]: + """ + List of all pages for a site. + + Required scope | `pages:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[PageList] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/pages", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "localeId": locale_id, + "limit": limit, + "offset": offset, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + PageList, + parse_obj_as( + type_=PageList, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def get_metadata( + self, + page_id: str, + *, + locale_id: typing.Optional[str] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[Page]: + """ + Get metadata information for a single page. + + Required scope | `pages:read` + + Parameters + ---------- + page_id : str + Unique identifier for a Page + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Page] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"pages/{jsonable_encoder(page_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "localeId": locale_id, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Page, + parse_obj_as( + type_=Page, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def update_page_settings( + self, + page_id: str, + *, + locale_id: typing.Optional[str] = None, + title: typing.Optional[str] = OMIT, + slug: typing.Optional[str] = OMIT, + seo: typing.Optional[PageMetadataWriteSeo] = OMIT, + open_graph: typing.Optional[PageMetadataWriteOpenGraph] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[Page]: + """ + Update Page-level metadata, including SEO and Open Graph fields. + + Required scope | `pages:write` + + Parameters + ---------- + page_id : str + Unique identifier for a Page + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + title : typing.Optional[str] + Title for the page + + slug : typing.Optional[str] + Slug for the page. + + + **Note:** Updating slugs in secondary locales is only supported in Advanced and Enterprise localization add-on plans. + + seo : typing.Optional[PageMetadataWriteSeo] + SEO-related fields for the Page + + open_graph : typing.Optional[PageMetadataWriteOpenGraph] + Open Graph fields for the Page + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Page] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"pages/{jsonable_encoder(page_id)}", + base_url=self._client_wrapper.get_environment().base, + method="PUT", + params={ + "localeId": locale_id, + }, + json={ + "title": title, + "slug": slug, + "seo": convert_and_respect_annotation_metadata( + object_=seo, annotation=PageMetadataWriteSeo, direction="write" + ), + "openGraph": convert_and_respect_annotation_metadata( + object_=open_graph, annotation=PageMetadataWriteOpenGraph, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Page, + parse_obj_as( + type_=Page, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def get_content( + self, + page_id: str, + *, + locale_id: typing.Optional[str] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[Dom]: + """ + Get text and component instance content from a static page. + + Localization + + Required scope | `pages:read` + + Parameters + ---------- + page_id : str + Unique identifier for a Page + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Dom] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"pages/{jsonable_encoder(page_id)}/dom", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "localeId": locale_id, + "limit": limit, + "offset": offset, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Dom, + parse_obj_as( + type_=Dom, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def update_static_content( + self, + page_id: str, + *, + locale_id: str, + nodes: typing.Sequence[PageDomWriteNodesItem], + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[UpdateStaticContentResponse]: + """ + This endpoint updates content on a static page in **secondary locales**. It supports updating up to 1000 nodes in a single request. + + Before making updates: + 1. Use the [get page content](/data/reference/pages-and-components/pages/get-content) endpoint to identify available content nodes and their types. + 2. If the page has component instances, retrieve the component's properties that you'll override using the [get component properties](/data/reference/pages-and-components/components/get-properties) endpoint. + 3. DOM elements may include a `data-w-id` attribute. This attribute is used by Webflow to maintain custom attributes and links across locales. Always include the original `data-w-id` value in your update requests to ensure consistent behavior across all locales. + + + This endpoint is specifically for localized pages. Ensure that the specified `localeId` is a valid **secondary locale** for the site otherwise the request will fail. + + + Required scope | `pages:write` + + Parameters + ---------- + page_id : str + Unique identifier for a Page + + locale_id : str + The locale identifier. + + nodes : typing.Sequence[PageDomWriteNodesItem] + List of DOM Nodes with the new content that will be updated in each node. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[UpdateStaticContentResponse] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"pages/{jsonable_encoder(page_id)}/dom", + base_url=self._client_wrapper.get_environment().base, + method="POST", + params={ + "localeId": locale_id, + }, + json={ + "nodes": convert_and_respect_annotation_metadata( + object_=nodes, annotation=typing.Sequence[PageDomWriteNodesItem], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + UpdateStaticContentResponse, + parse_obj_as( + type_=UpdateStaticContentResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/pages/resources/__init__.py b/src/webflow/resources/pages/resources/__init__.py index 58b2c01..14bbc78 100644 --- a/src/webflow/resources/pages/resources/__init__.py +++ b/src/webflow/resources/pages/resources/__init__.py @@ -1,5 +1,34 @@ # This file was auto-generated by Fern from our API Definition. -from . import scripts +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from . import scripts +_dynamic_imports: typing.Dict[str, str] = {"scripts": ".scripts"} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + __all__ = ["scripts"] diff --git a/src/webflow/resources/pages/resources/scripts/__init__.py b/src/webflow/resources/pages/resources/scripts/__init__.py index f3ea265..5cde020 100644 --- a/src/webflow/resources/pages/resources/scripts/__init__.py +++ b/src/webflow/resources/pages/resources/scripts/__init__.py @@ -1,2 +1,4 @@ # This file was auto-generated by Fern from our API Definition. +# isort: skip_file + diff --git a/src/webflow/resources/pages/resources/scripts/client.py b/src/webflow/resources/pages/resources/scripts/client.py index 56bd39a..205dca5 100644 --- a/src/webflow/resources/pages/resources/scripts/client.py +++ b/src/webflow/resources/pages/resources/scripts/client.py @@ -1,23 +1,12 @@ # This file was auto-generated by Fern from our API Definition. import typing -from .....core.client_wrapper import SyncClientWrapper + +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from .....core.request_options import RequestOptions -from .....types.script_apply_list import ScriptApplyList -from .....core.jsonable_encoder import jsonable_encoder -from .....core.pydantic_utilities import parse_obj_as -from .....errors.bad_request_error import BadRequestError -from .....errors.unauthorized_error import UnauthorizedError -from .....types.error import Error -from .....errors.not_found_error import NotFoundError -from .....errors.too_many_requests_error import TooManyRequestsError -from .....errors.internal_server_error import InternalServerError -from json.decoder import JSONDecodeError -from .....core.api_error import ApiError from .....types.script_apply import ScriptApply -from .....core.serialization import convert_and_respect_annotation_metadata -from .....errors.conflict_error import ConflictError -from .....core.client_wrapper import AsyncClientWrapper +from .....types.script_apply_list import ScriptApplyList +from .raw_client import AsyncRawScriptsClient, RawScriptsClient # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) @@ -25,19 +14,24 @@ class ScriptsClient: def __init__(self, *, client_wrapper: SyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = RawScriptsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawScriptsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawScriptsClient + """ + return self._raw_client def get_custom_code( self, page_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> ScriptApplyList: """ - Get all registered scripts that have been applied to a specific Page. - - In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered - to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate - `custom_code` endpoints. - - Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + Get all scripts applied to a page. Required scope | `custom_code:read` @@ -65,74 +59,8 @@ def get_custom_code( page_id="63c720f9347c2139b248e552", ) """ - _response = self._client_wrapper.httpx_client.request( - f"pages/{jsonable_encoder(page_id)}/custom_code", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ScriptApplyList, - parse_obj_as( - type_=ScriptApplyList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.get_custom_code(page_id, request_options=request_options) + return _response.data def upsert_custom_code( self, @@ -144,15 +72,11 @@ def upsert_custom_code( request_options: typing.Optional[RequestOptions] = None, ) -> ScriptApplyList: """ - Add a registered script to a Page. + Apply registered scripts to a page. If you have multiple scripts your App needs to apply or maintain on a page, ensure they are always included in the request body for this endpoint. To remove individual scripts, simply call this endpoint without the script in the request body. - In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered - to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate - `custom_code` endpoints. - - A site can have a maximum of 800 registered scripts. - - Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + + To apply a script to a page, the script must first be registered to a Site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + Required scope | `custom_code:write` @@ -202,102 +126,18 @@ def upsert_custom_code( ], ) """ - _response = self._client_wrapper.httpx_client.request( - f"pages/{jsonable_encoder(page_id)}/custom_code", - method="PUT", - json={ - "scripts": convert_and_respect_annotation_metadata( - object_=scripts, annotation=typing.Sequence[ScriptApply], direction="write" - ), - "lastUpdated": last_updated, - "createdOn": created_on, - }, - request_options=request_options, - omit=OMIT, + _response = self._raw_client.upsert_custom_code( + page_id, scripts=scripts, last_updated=last_updated, created_on=created_on, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ScriptApplyList, - parse_obj_as( - type_=ScriptApplyList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def delete_custom_code(self, page_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ - Delete the custom code block that an app has created for a page + Remove all scripts from a page applied by the App. This endpoint will not remove scripts from the site's registered scripts. - In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered - to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate - `custom_code` endpoints. + To remove individual scripts applied by the App, use the [Add/Update Custom Code](/data/reference/custom-code/custom-code-pages/upsert-custom-code) endpoint. - Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app). Required scope | `custom_code:write` @@ -324,85 +164,30 @@ def delete_custom_code(self, page_id: str, *, request_options: typing.Optional[R page_id="63c720f9347c2139b248e552", ) """ - _response = self._client_wrapper.httpx_client.request( - f"pages/{jsonable_encoder(page_id)}/custom_code", - method="DELETE", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.delete_custom_code(page_id, request_options=request_options) + return _response.data class AsyncScriptsClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = AsyncRawScriptsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawScriptsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawScriptsClient + """ + return self._raw_client async def get_custom_code( self, page_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> ScriptApplyList: """ - Get all registered scripts that have been applied to a specific Page. - - In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered - to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate - `custom_code` endpoints. - - Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + Get all scripts applied to a page. Required scope | `custom_code:read` @@ -438,74 +223,8 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"pages/{jsonable_encoder(page_id)}/custom_code", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ScriptApplyList, - parse_obj_as( - type_=ScriptApplyList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.get_custom_code(page_id, request_options=request_options) + return _response.data async def upsert_custom_code( self, @@ -517,15 +236,11 @@ async def upsert_custom_code( request_options: typing.Optional[RequestOptions] = None, ) -> ScriptApplyList: """ - Add a registered script to a Page. - - In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered - to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate - `custom_code` endpoints. + Apply registered scripts to a page. If you have multiple scripts your App needs to apply or maintain on a page, ensure they are always included in the request body for this endpoint. To remove individual scripts, simply call this endpoint without the script in the request body. - A site can have a maximum of 800 registered scripts. - - Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + + To apply a script to a page, the script must first be registered to a Site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + Required scope | `custom_code:write` @@ -583,104 +298,20 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"pages/{jsonable_encoder(page_id)}/custom_code", - method="PUT", - json={ - "scripts": convert_and_respect_annotation_metadata( - object_=scripts, annotation=typing.Sequence[ScriptApply], direction="write" - ), - "lastUpdated": last_updated, - "createdOn": created_on, - }, - request_options=request_options, - omit=OMIT, + _response = await self._raw_client.upsert_custom_code( + page_id, scripts=scripts, last_updated=last_updated, created_on=created_on, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ScriptApplyList, - parse_obj_as( - type_=ScriptApplyList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def delete_custom_code( self, page_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> None: """ - Delete the custom code block that an app has created for a page + Remove all scripts from a page applied by the App. This endpoint will not remove scripts from the site's registered scripts. - In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered - to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate - `custom_code` endpoints. + To remove individual scripts applied by the App, use the [Add/Update Custom Code](/data/reference/custom-code/custom-code-pages/upsert-custom-code) endpoint. - Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app). Required scope | `custom_code:write` @@ -715,65 +346,5 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"pages/{jsonable_encoder(page_id)}/custom_code", - method="DELETE", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.delete_custom_code(page_id, request_options=request_options) + return _response.data diff --git a/src/webflow/resources/pages/resources/scripts/raw_client.py b/src/webflow/resources/pages/resources/scripts/raw_client.py new file mode 100644 index 0000000..6a71dd8 --- /dev/null +++ b/src/webflow/resources/pages/resources/scripts/raw_client.py @@ -0,0 +1,716 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from .....core.api_error import ApiError +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from .....core.http_response import AsyncHttpResponse, HttpResponse +from .....core.jsonable_encoder import jsonable_encoder +from .....core.parse_error import ParsingError +from .....core.pydantic_utilities import parse_obj_as +from .....core.request_options import RequestOptions +from .....core.serialization import convert_and_respect_annotation_metadata +from .....errors.bad_request_error import BadRequestError +from .....errors.conflict_error import ConflictError +from .....errors.internal_server_error import InternalServerError +from .....errors.not_found_error import NotFoundError +from .....errors.too_many_requests_error import TooManyRequestsError +from .....errors.unauthorized_error import UnauthorizedError +from .....types.error import Error +from .....types.script_apply import ScriptApply +from .....types.script_apply_list import ScriptApplyList +from pydantic import ValidationError + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawScriptsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def get_custom_code( + self, page_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[ScriptApplyList]: + """ + Get all scripts applied to a page. + + Required scope | `custom_code:read` + + Parameters + ---------- + page_id : str + Unique identifier for a Page + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ScriptApplyList] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"pages/{jsonable_encoder(page_id)}/custom_code", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ScriptApplyList, + parse_obj_as( + type_=ScriptApplyList, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def upsert_custom_code( + self, + page_id: str, + *, + scripts: typing.Optional[typing.Sequence[ScriptApply]] = OMIT, + last_updated: typing.Optional[str] = OMIT, + created_on: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[ScriptApplyList]: + """ + Apply registered scripts to a page. If you have multiple scripts your App needs to apply or maintain on a page, ensure they are always included in the request body for this endpoint. To remove individual scripts, simply call this endpoint without the script in the request body. + + + To apply a script to a page, the script must first be registered to a Site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + + + Required scope | `custom_code:write` + + Parameters + ---------- + page_id : str + Unique identifier for a Page + + scripts : typing.Optional[typing.Sequence[ScriptApply]] + A list of scripts applied to a Site or a Page + + last_updated : typing.Optional[str] + Date when the Site's scripts were last updated + + created_on : typing.Optional[str] + Date when the Site's scripts were created + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ScriptApplyList] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"pages/{jsonable_encoder(page_id)}/custom_code", + base_url=self._client_wrapper.get_environment().base, + method="PUT", + json={ + "scripts": convert_and_respect_annotation_metadata( + object_=scripts, annotation=typing.Sequence[ScriptApply], direction="write" + ), + "lastUpdated": last_updated, + "createdOn": created_on, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ScriptApplyList, + parse_obj_as( + type_=ScriptApplyList, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def delete_custom_code( + self, page_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[None]: + """ + Remove all scripts from a page applied by the App. This endpoint will not remove scripts from the site's registered scripts. + + To remove individual scripts applied by the App, use the [Add/Update Custom Code](/data/reference/custom-code/custom-code-pages/upsert-custom-code) endpoint. + + Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app). + + Required scope | `custom_code:write` + + Parameters + ---------- + page_id : str + Unique identifier for a Page + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[None] + """ + _response = self._client_wrapper.httpx_client.request( + f"pages/{jsonable_encoder(page_id)}/custom_code", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return HttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawScriptsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def get_custom_code( + self, page_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[ScriptApplyList]: + """ + Get all scripts applied to a page. + + Required scope | `custom_code:read` + + Parameters + ---------- + page_id : str + Unique identifier for a Page + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ScriptApplyList] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"pages/{jsonable_encoder(page_id)}/custom_code", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ScriptApplyList, + parse_obj_as( + type_=ScriptApplyList, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def upsert_custom_code( + self, + page_id: str, + *, + scripts: typing.Optional[typing.Sequence[ScriptApply]] = OMIT, + last_updated: typing.Optional[str] = OMIT, + created_on: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[ScriptApplyList]: + """ + Apply registered scripts to a page. If you have multiple scripts your App needs to apply or maintain on a page, ensure they are always included in the request body for this endpoint. To remove individual scripts, simply call this endpoint without the script in the request body. + + + To apply a script to a page, the script must first be registered to a Site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + + + Required scope | `custom_code:write` + + Parameters + ---------- + page_id : str + Unique identifier for a Page + + scripts : typing.Optional[typing.Sequence[ScriptApply]] + A list of scripts applied to a Site or a Page + + last_updated : typing.Optional[str] + Date when the Site's scripts were last updated + + created_on : typing.Optional[str] + Date when the Site's scripts were created + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ScriptApplyList] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"pages/{jsonable_encoder(page_id)}/custom_code", + base_url=self._client_wrapper.get_environment().base, + method="PUT", + json={ + "scripts": convert_and_respect_annotation_metadata( + object_=scripts, annotation=typing.Sequence[ScriptApply], direction="write" + ), + "lastUpdated": last_updated, + "createdOn": created_on, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ScriptApplyList, + parse_obj_as( + type_=ScriptApplyList, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def delete_custom_code( + self, page_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[None]: + """ + Remove all scripts from a page applied by the App. This endpoint will not remove scripts from the site's registered scripts. + + To remove individual scripts applied by the App, use the [Add/Update Custom Code](/data/reference/custom-code/custom-code-pages/upsert-custom-code) endpoint. + + Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app). + + Required scope | `custom_code:write` + + Parameters + ---------- + page_id : str + Unique identifier for a Page + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[None] + """ + _response = await self._client_wrapper.httpx_client.request( + f"pages/{jsonable_encoder(page_id)}/custom_code", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return AsyncHttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/pages/types/__init__.py b/src/webflow/resources/pages/types/__init__.py index 08c0325..e606a89 100644 --- a/src/webflow/resources/pages/types/__init__.py +++ b/src/webflow/resources/pages/types/__init__.py @@ -1,6 +1,42 @@ # This file was auto-generated by Fern from our API Definition. -from .page_dom_write_nodes_item import PageDomWriteNodesItem -from .update_static_content_response import UpdateStaticContentResponse +# isort: skip_file -__all__ = ["PageDomWriteNodesItem", "UpdateStaticContentResponse"] +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .page_dom_write_nodes_item import PageDomWriteNodesItem + from .page_metadata_write_open_graph import PageMetadataWriteOpenGraph + from .page_metadata_write_seo import PageMetadataWriteSeo + from .update_static_content_response import UpdateStaticContentResponse +_dynamic_imports: typing.Dict[str, str] = { + "PageDomWriteNodesItem": ".page_dom_write_nodes_item", + "PageMetadataWriteOpenGraph": ".page_metadata_write_open_graph", + "PageMetadataWriteSeo": ".page_metadata_write_seo", + "UpdateStaticContentResponse": ".update_static_content_response", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + + +__all__ = ["PageDomWriteNodesItem", "PageMetadataWriteOpenGraph", "PageMetadataWriteSeo", "UpdateStaticContentResponse"] diff --git a/src/webflow/resources/pages/types/page_dom_write_nodes_item.py b/src/webflow/resources/pages/types/page_dom_write_nodes_item.py index 05d1f3f..8c562cf 100644 --- a/src/webflow/resources/pages/types/page_dom_write_nodes_item.py +++ b/src/webflow/resources/pages/types/page_dom_write_nodes_item.py @@ -1,7 +1,19 @@ # This file was auto-generated by Fern from our API Definition. import typing -from ....types.text_node_write import TextNodeWrite + from ....types.component_instance_node_property_overrides_write import ComponentInstanceNodePropertyOverridesWrite +from ....types.search_button_node_write import SearchButtonNodeWrite +from ....types.select import Select +from ....types.submit_button_node_write import SubmitButtonNodeWrite +from ....types.text_input_node_write import TextInputNodeWrite +from ....types.text_node_write import TextNodeWrite -PageDomWriteNodesItem = typing.Union[TextNodeWrite, ComponentInstanceNodePropertyOverridesWrite] +PageDomWriteNodesItem = typing.Union[ + TextNodeWrite, + ComponentInstanceNodePropertyOverridesWrite, + Select, + TextInputNodeWrite, + SubmitButtonNodeWrite, + SearchButtonNodeWrite, +] diff --git a/src/webflow/resources/pages/types/page_metadata_write_open_graph.py b/src/webflow/resources/pages/types/page_metadata_write_open_graph.py new file mode 100644 index 0000000..0a80301 --- /dev/null +++ b/src/webflow/resources/pages/types/page_metadata_write_open_graph.py @@ -0,0 +1,47 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ....core.serialization import FieldMetadata + + +class PageMetadataWriteOpenGraph(UniversalBaseModel): + """ + Open Graph fields for the Page + """ + + title: typing.Optional[str] = pydantic.Field(default=None) + """ + The title supplied to Open Graph annotations + """ + + title_copied: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="titleCopied"), + pydantic.Field(alias="titleCopied", description="Indicates the Open Graph title was copied from the SEO title"), + ] = None + description: typing.Optional[str] = pydantic.Field(default=None) + """ + The description supplied to Open Graph annotations + """ + + description_copied: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="descriptionCopied"), + pydantic.Field( + alias="descriptionCopied", + description="Indicates the Open Graph description was copied from the SEO description", + ), + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/resources/pages/types/page_metadata_write_seo.py b/src/webflow/resources/pages/types/page_metadata_write_seo.py new file mode 100644 index 0000000..a03a778 --- /dev/null +++ b/src/webflow/resources/pages/types/page_metadata_write_seo.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class PageMetadataWriteSeo(UniversalBaseModel): + """ + SEO-related fields for the Page + """ + + title: typing.Optional[str] = pydantic.Field(default=None) + """ + The Page title shown in search engine results + """ + + description: typing.Optional[str] = pydantic.Field(default=None) + """ + The Page description shown in search engine results + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/resources/pages/types/update_static_content_response.py b/src/webflow/resources/pages/types/update_static_content_response.py index 0bcf93a..99e93aa 100644 --- a/src/webflow/resources/pages/types/update_static_content_response.py +++ b/src/webflow/resources/pages/types/update_static_content_response.py @@ -1,9 +1,9 @@ # This file was auto-generated by Fern from our API Definition. -from ....core.pydantic_utilities import UniversalBaseModel import typing + import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 +from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel class UpdateStaticContentResponse(UniversalBaseModel): diff --git a/src/webflow/resources/products/__init__.py b/src/webflow/resources/products/__init__.py index 9fced2c..fe1618a 100644 --- a/src/webflow/resources/products/__init__.py +++ b/src/webflow/resources/products/__init__.py @@ -1,5 +1,38 @@ # This file was auto-generated by Fern from our API Definition. -from .types import ProductsCreateSkuResponse +# isort: skip_file -__all__ = ["ProductsCreateSkuResponse"] +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .types import ProductSkuCreateProduct, ProductSkuCreateSku, ProductsCreateSkuResponse +_dynamic_imports: typing.Dict[str, str] = { + "ProductSkuCreateProduct": ".types", + "ProductSkuCreateSku": ".types", + "ProductsCreateSkuResponse": ".types", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + + +__all__ = ["ProductSkuCreateProduct", "ProductSkuCreateSku", "ProductsCreateSkuResponse"] diff --git a/src/webflow/resources/products/client.py b/src/webflow/resources/products/client.py index c856fef..c20d5cf 100644 --- a/src/webflow/resources/products/client.py +++ b/src/webflow/resources/products/client.py @@ -1,28 +1,18 @@ # This file was auto-generated by Fern from our API Definition. import typing -from ...core.client_wrapper import SyncClientWrapper + +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ...core.request_options import RequestOptions +from ...types.product import Product +from ...types.product_and_sk_us import ProductAndSkUs from ...types.product_and_sk_us_list import ProductAndSkUsList -from ...core.jsonable_encoder import jsonable_encoder -from ...core.pydantic_utilities import parse_obj_as -from ...errors.bad_request_error import BadRequestError -from ...errors.unauthorized_error import UnauthorizedError -from ...types.error import Error -from ...errors.forbidden_error import ForbiddenError -from ...errors.not_found_error import NotFoundError -from ...errors.conflict_error import ConflictError -from ...errors.too_many_requests_error import TooManyRequestsError -from ...errors.internal_server_error import InternalServerError -from json.decoder import JSONDecodeError -from ...core.api_error import ApiError from ...types.publish_status import PublishStatus -from ...types.product import Product from ...types.sku import Sku -from ...types.product_and_sk_us import ProductAndSkUs -from ...core.serialization import convert_and_respect_annotation_metadata +from .raw_client import AsyncRawProductsClient, RawProductsClient +from .types.product_sku_create_product import ProductSkuCreateProduct +from .types.product_sku_create_sku import ProductSkuCreateSku from .types.products_create_sku_response import ProductsCreateSkuResponse -from ...core.client_wrapper import AsyncClientWrapper # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) @@ -30,14 +20,25 @@ class ProductsClient: def __init__(self, *, client_wrapper: SyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = RawProductsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawProductsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawProductsClient + """ + return self._raw_client def list( self, site_id: str, *, - offset: typing.Optional[float] = None, - limit: typing.Optional[float] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> ProductAndSkUsList: """ @@ -53,10 +54,10 @@ def list( site_id : str Unique identifier for a Site - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records - limit : typing.Optional[float] + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) request_options : typing.Optional[RequestOptions] @@ -76,121 +77,29 @@ def list( ) client.products.list( site_id="580e63e98c9a982ac9b8b741", + offset=1, + limit=1, ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/products", - method="GET", - params={ - "offset": offset, - "limit": limit, - }, - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ProductAndSkUsList, - parse_obj_as( - type_=ProductAndSkUsList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.list(site_id, offset=offset, limit=limit, request_options=request_options) + return _response.data def create( self, site_id: str, *, + product: ProductSkuCreateProduct, + sku: ProductSkuCreateSku, publish_status: typing.Optional[PublishStatus] = OMIT, - product: typing.Optional[Product] = OMIT, - sku: typing.Optional[Sku] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> ProductAndSkUs: """ - Create a new product and SKU. - - When you create a product, you will always create a SKU, since a Product Item must have, at minimum, a single SKU. + Create a new ecommerce product and defaultSKU. A product, at minimum, must have a single SKU. - To create a Product with multiple SKUs - for example a T-shirt in sizes small, medium and large: - - Create parameters in `sku-properties`, also known as [product options and variants.](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants). - - A single `sku-property` would be `color`. Within the `color` property, list the various colors of T-shirts as an array of `enum` values: `royal-blue`, `crimson-red`, and `forrest-green`. - - Once, you've created a Product and its `sku-properties` with `enum` values, Webflow will create a **default SKU**, which will automatically be a combination of the first `sku-properties` you've created. - - In our example, the default SKU will be a Royal Blue T-Shirt, because our first `enum` of our Color `sku-property` is Royal Blue. - - After you've created your product, you can create additional SKUs using the [Create SKU endpoint.](/data/reference/ecommerce/products/create-sku) + To create a product with multiple SKUs: + - First, create a list of `sku-properties`, also known as [product options](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants). For example, a T-shirt product may have a "color" `sku-property`, with a list of enum values: red, yellow, and blue, another `sku-property` may be "size", with a list of enum values: small, medium, and large. + - Once, a product is created with a list of `sku-properties`, Webflow will create a **default SKU**, which is always a combination of the first `enum` values of each `sku-property`. (e.g. Small - Red - T-Shirt) + - After creation, you can create additional SKUs for the product, using the [Create SKUs endpoint.](/data/reference/ecommerce/products/create-sku) Upon creation, the default product type will be `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer. @@ -201,11 +110,11 @@ def create( site_id : str Unique identifier for a Site - publish_status : typing.Optional[PublishStatus] + product : ProductSkuCreateProduct - product : typing.Optional[Product] + sku : ProductSkuCreateSku - sku : typing.Optional[Sku] + publish_status : typing.Optional[PublishStatus] request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -217,114 +126,94 @@ def create( Examples -------- - from webflow import Webflow + from webflow import ( + ProductFieldData, + SkuFieldData, + SkuFieldDataPrice, + SkuPropertyList, + SkuPropertyListEnumItem, + Webflow, + ) + from webflow.resources.products import ( + ProductSkuCreateProduct, + ProductSkuCreateSku, + ) client = Webflow( access_token="YOUR_ACCESS_TOKEN", ) client.products.create( site_id="580e63e98c9a982ac9b8b741", + publish_status="staging", + product=ProductSkuCreateProduct( + field_data=ProductFieldData( + name="Colorful T-shirt", + slug="colorful-t-shirt", + description="Our best-selling t-shirt available in multiple colors and sizes", + sku_properties=[ + SkuPropertyList( + id="color", + name="Color", + enum=[ + SkuPropertyListEnumItem( + id="red", + name="Red", + slug="red", + ), + SkuPropertyListEnumItem( + id="yellow", + name="Yellow", + slug="yellow", + ), + SkuPropertyListEnumItem( + id="blue", + name="Blue", + slug="blue", + ), + ], + ), + SkuPropertyList( + id="size", + name="Size", + enum=[ + SkuPropertyListEnumItem( + id="small", + name="Small", + slug="small", + ), + SkuPropertyListEnumItem( + id="medium", + name="Medium", + slug="medium", + ), + SkuPropertyListEnumItem( + id="large", + name="Large", + slug="large", + ), + ], + ), + ], + ), + ), + sku=ProductSkuCreateSku( + field_data=SkuFieldData( + name="Colorful T-shirt - Red Small", + slug="colorful-t-shirt-red-small", + price=SkuFieldDataPrice( + value=2499.0, + unit="USD", + currency="USD", + ), + main_image="https://rocketamp-sample-store.myshopify.com/cdn/shop/products/Gildan_2000_Antique_Cherry_Red_Front_1024x1024.jpg?v=1527232987", + ), + ), ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/products", - method="POST", - json={ - "publishStatus": publish_status, - "product": convert_and_respect_annotation_metadata( - object_=product, annotation=Product, direction="write" - ), - "sku": convert_and_respect_annotation_metadata(object_=sku, annotation=Sku, direction="write"), - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, + _response = self._raw_client.create( + site_id, product=product, sku=sku, publish_status=publish_status, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ProductAndSkUs, - parse_obj_as( - type_=ProductAndSkUs, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def get( self, site_id: str, product_id: str, *, request_options: typing.Optional[RequestOptions] = None @@ -363,94 +252,8 @@ def get( product_id="580e63fc8c9a982ac9b8b745", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/products/{jsonable_encoder(product_id)}", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ProductAndSkUs, - parse_obj_as( - type_=ProductAndSkUs, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.get(site_id, product_id, request_options=request_options) + return _response.data def update( self, @@ -503,105 +306,15 @@ def update( product_id="580e63fc8c9a982ac9b8b745", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/products/{jsonable_encoder(product_id)}", - method="PATCH", - json={ - "publishStatus": publish_status, - "product": convert_and_respect_annotation_metadata( - object_=product, annotation=Product, direction="write" - ), - "sku": convert_and_respect_annotation_metadata(object_=sku, annotation=Sku, direction="write"), - }, - headers={ - "content-type": "application/json", - }, + _response = self._raw_client.update( + site_id, + product_id, + publish_status=publish_status, + product=product, + sku=sku, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Product, - parse_obj_as( - type_=Product, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def create_sku( self, @@ -642,7 +355,9 @@ def create_sku( Examples -------- - from webflow import Sku, Webflow + import datetime + + from webflow import Sku, SkuFieldData, SkuFieldDataPrice, Webflow client = Webflow( access_token="YOUR_ACCESS_TOKEN", @@ -650,107 +365,36 @@ def create_sku( client.products.create_sku( site_id="580e63e98c9a982ac9b8b741", product_id="580e63fc8c9a982ac9b8b745", - skus=[Sku()], - ) - """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/products/{jsonable_encoder(product_id)}/skus", - method="POST", - json={ - "publishStatus": publish_status, - "skus": convert_and_respect_annotation_metadata( - object_=skus, annotation=typing.Sequence[Sku], direction="write" - ), - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ProductsCreateSkuResponse, - parse_obj_as( - type_=ProductsCreateSkuResponse, # type: ignore - object_=_response.json(), + skus=[ + Sku( + id="66072fb71b89448912e2681c", + cms_locale_id="653ad57de882f528b32e810e", + last_published=datetime.datetime.fromisoformat( + "2023-03-17 18:47:35+00:00", ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), + last_updated=datetime.datetime.fromisoformat( + "2023-03-17 18:47:35+00:00", + ), + created_on=datetime.datetime.fromisoformat( + "2023-03-17 18:47:35+00:00", + ), + field_data=SkuFieldData( + name="Colorful T-shirt - Default", + slug="colorful-t-shirt-default", + price=SkuFieldDataPrice( + value=2499.0, + unit="USD", + currency="USD", ), - ) + ), ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + ], + ) + """ + _response = self._raw_client.create_sku( + site_id, product_id, skus=skus, publish_status=publish_status, request_options=request_options + ) + return _response.data def update_sku( self, @@ -794,7 +438,9 @@ def update_sku( Examples -------- - from webflow import Sku, Webflow + import datetime + + from webflow import Sku, SkuFieldData, SkuFieldDataPrice, Webflow client = Webflow( access_token="YOUR_ACCESS_TOKEN", @@ -803,117 +449,57 @@ def update_sku( site_id="580e63e98c9a982ac9b8b741", product_id="580e63fc8c9a982ac9b8b745", sku_id="5e8518516e147040726cc415", - sku=Sku(), + sku=Sku( + id="66072fb71b89448912e2681c", + cms_locale_id="653ad57de882f528b32e810e", + last_published=datetime.datetime.fromisoformat( + "2023-03-17 18:47:35+00:00", + ), + last_updated=datetime.datetime.fromisoformat( + "2023-03-17 18:47:35+00:00", + ), + created_on=datetime.datetime.fromisoformat( + "2023-03-17 18:47:35+00:00", + ), + field_data=SkuFieldData( + name="Colorful T-shirt - Default", + slug="colorful-t-shirt-default", + price=SkuFieldDataPrice( + value=2499.0, + unit="USD", + currency="USD", + ), + ), + ), ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/products/{jsonable_encoder(product_id)}/skus/{jsonable_encoder(sku_id)}", - method="PATCH", - json={ - "publishStatus": publish_status, - "sku": convert_and_respect_annotation_metadata(object_=sku, annotation=Sku, direction="write"), - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, + _response = self._raw_client.update_sku( + site_id, product_id, sku_id, sku=sku, publish_status=publish_status, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Sku, - parse_obj_as( - type_=Sku, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data class AsyncProductsClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = AsyncRawProductsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawProductsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawProductsClient + """ + return self._raw_client async def list( self, site_id: str, *, - offset: typing.Optional[float] = None, - limit: typing.Optional[float] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> ProductAndSkUsList: """ @@ -929,10 +515,10 @@ async def list( site_id : str Unique identifier for a Site - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records - limit : typing.Optional[float] + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) request_options : typing.Optional[RequestOptions] @@ -957,124 +543,32 @@ async def list( async def main() -> None: await client.products.list( site_id="580e63e98c9a982ac9b8b741", + offset=1, + limit=1, ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/products", - method="GET", - params={ - "offset": offset, - "limit": limit, - }, - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ProductAndSkUsList, - parse_obj_as( - type_=ProductAndSkUsList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.list(site_id, offset=offset, limit=limit, request_options=request_options) + return _response.data async def create( self, site_id: str, *, + product: ProductSkuCreateProduct, + sku: ProductSkuCreateSku, publish_status: typing.Optional[PublishStatus] = OMIT, - product: typing.Optional[Product] = OMIT, - sku: typing.Optional[Sku] = OMIT, request_options: typing.Optional[RequestOptions] = None, ) -> ProductAndSkUs: """ - Create a new product and SKU. - - When you create a product, you will always create a SKU, since a Product Item must have, at minimum, a single SKU. + Create a new ecommerce product and defaultSKU. A product, at minimum, must have a single SKU. - To create a Product with multiple SKUs - for example a T-shirt in sizes small, medium and large: - - Create parameters in `sku-properties`, also known as [product options and variants.](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants). - - A single `sku-property` would be `color`. Within the `color` property, list the various colors of T-shirts as an array of `enum` values: `royal-blue`, `crimson-red`, and `forrest-green`. - - Once, you've created a Product and its `sku-properties` with `enum` values, Webflow will create a **default SKU**, which will automatically be a combination of the first `sku-properties` you've created. - - In our example, the default SKU will be a Royal Blue T-Shirt, because our first `enum` of our Color `sku-property` is Royal Blue. - - After you've created your product, you can create additional SKUs using the [Create SKU endpoint.](/data/reference/ecommerce/products/create-sku) + To create a product with multiple SKUs: + - First, create a list of `sku-properties`, also known as [product options](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants). For example, a T-shirt product may have a "color" `sku-property`, with a list of enum values: red, yellow, and blue, another `sku-property` may be "size", with a list of enum values: small, medium, and large. + - Once, a product is created with a list of `sku-properties`, Webflow will create a **default SKU**, which is always a combination of the first `enum` values of each `sku-property`. (e.g. Small - Red - T-Shirt) + - After creation, you can create additional SKUs for the product, using the [Create SKUs endpoint.](/data/reference/ecommerce/products/create-sku) Upon creation, the default product type will be `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer. @@ -1085,11 +579,11 @@ async def create( site_id : str Unique identifier for a Site - publish_status : typing.Optional[PublishStatus] + product : ProductSkuCreateProduct - product : typing.Optional[Product] + sku : ProductSkuCreateSku - sku : typing.Optional[Sku] + publish_status : typing.Optional[PublishStatus] request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -1103,7 +597,18 @@ async def create( -------- import asyncio - from webflow import AsyncWebflow + from webflow import ( + AsyncWebflow, + ProductFieldData, + SkuFieldData, + SkuFieldDataPrice, + SkuPropertyList, + SkuPropertyListEnumItem, + ) + from webflow.resources.products import ( + ProductSkuCreateProduct, + ProductSkuCreateSku, + ) client = AsyncWebflow( access_token="YOUR_ACCESS_TOKEN", @@ -1113,110 +618,79 @@ async def create( async def main() -> None: await client.products.create( site_id="580e63e98c9a982ac9b8b741", + publish_status="staging", + product=ProductSkuCreateProduct( + field_data=ProductFieldData( + name="Colorful T-shirt", + slug="colorful-t-shirt", + description="Our best-selling t-shirt available in multiple colors and sizes", + sku_properties=[ + SkuPropertyList( + id="color", + name="Color", + enum=[ + SkuPropertyListEnumItem( + id="red", + name="Red", + slug="red", + ), + SkuPropertyListEnumItem( + id="yellow", + name="Yellow", + slug="yellow", + ), + SkuPropertyListEnumItem( + id="blue", + name="Blue", + slug="blue", + ), + ], + ), + SkuPropertyList( + id="size", + name="Size", + enum=[ + SkuPropertyListEnumItem( + id="small", + name="Small", + slug="small", + ), + SkuPropertyListEnumItem( + id="medium", + name="Medium", + slug="medium", + ), + SkuPropertyListEnumItem( + id="large", + name="Large", + slug="large", + ), + ], + ), + ], + ), + ), + sku=ProductSkuCreateSku( + field_data=SkuFieldData( + name="Colorful T-shirt - Red Small", + slug="colorful-t-shirt-red-small", + price=SkuFieldDataPrice( + value=2499.0, + unit="USD", + currency="USD", + ), + main_image="https://rocketamp-sample-store.myshopify.com/cdn/shop/products/Gildan_2000_Antique_Cherry_Red_Front_1024x1024.jpg?v=1527232987", + ), + ), ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/products", - method="POST", - json={ - "publishStatus": publish_status, - "product": convert_and_respect_annotation_metadata( - object_=product, annotation=Product, direction="write" - ), - "sku": convert_and_respect_annotation_metadata(object_=sku, annotation=Sku, direction="write"), - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, + _response = await self._raw_client.create( + site_id, product=product, sku=sku, publish_status=publish_status, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ProductAndSkUs, - parse_obj_as( - type_=ProductAndSkUs, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def get( self, site_id: str, product_id: str, *, request_options: typing.Optional[RequestOptions] = None @@ -1263,94 +737,8 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/products/{jsonable_encoder(product_id)}", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ProductAndSkUs, - parse_obj_as( - type_=ProductAndSkUs, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.get(site_id, product_id, request_options=request_options) + return _response.data async def update( self, @@ -1411,105 +799,15 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/products/{jsonable_encoder(product_id)}", - method="PATCH", - json={ - "publishStatus": publish_status, - "product": convert_and_respect_annotation_metadata( - object_=product, annotation=Product, direction="write" - ), - "sku": convert_and_respect_annotation_metadata(object_=sku, annotation=Sku, direction="write"), - }, - headers={ - "content-type": "application/json", - }, + _response = await self._raw_client.update( + site_id, + product_id, + publish_status=publish_status, + product=product, + sku=sku, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Product, - parse_obj_as( - type_=Product, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def create_sku( self, @@ -1551,8 +849,9 @@ async def create_sku( Examples -------- import asyncio + import datetime - from webflow import AsyncWebflow, Sku + from webflow import AsyncWebflow, Sku, SkuFieldData, SkuFieldDataPrice client = AsyncWebflow( access_token="YOUR_ACCESS_TOKEN", @@ -1563,110 +862,39 @@ async def main() -> None: await client.products.create_sku( site_id="580e63e98c9a982ac9b8b741", product_id="580e63fc8c9a982ac9b8b745", - skus=[Sku()], + skus=[ + Sku( + id="66072fb71b89448912e2681c", + cms_locale_id="653ad57de882f528b32e810e", + last_published=datetime.datetime.fromisoformat( + "2023-03-17 18:47:35+00:00", + ), + last_updated=datetime.datetime.fromisoformat( + "2023-03-17 18:47:35+00:00", + ), + created_on=datetime.datetime.fromisoformat( + "2023-03-17 18:47:35+00:00", + ), + field_data=SkuFieldData( + name="Colorful T-shirt - Default", + slug="colorful-t-shirt-default", + price=SkuFieldDataPrice( + value=2499.0, + unit="USD", + currency="USD", + ), + ), + ) + ], ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/products/{jsonable_encoder(product_id)}/skus", - method="POST", - json={ - "publishStatus": publish_status, - "skus": convert_and_respect_annotation_metadata( - object_=skus, annotation=typing.Sequence[Sku], direction="write" - ), - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, + _response = await self._raw_client.create_sku( + site_id, product_id, skus=skus, publish_status=publish_status, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ProductsCreateSkuResponse, - parse_obj_as( - type_=ProductsCreateSkuResponse, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def update_sku( self, @@ -1711,8 +939,9 @@ async def update_sku( Examples -------- import asyncio + import datetime - from webflow import AsyncWebflow, Sku + from webflow import AsyncWebflow, Sku, SkuFieldData, SkuFieldDataPrice client = AsyncWebflow( access_token="YOUR_ACCESS_TOKEN", @@ -1724,105 +953,34 @@ async def main() -> None: site_id="580e63e98c9a982ac9b8b741", product_id="580e63fc8c9a982ac9b8b745", sku_id="5e8518516e147040726cc415", - sku=Sku(), + sku=Sku( + id="66072fb71b89448912e2681c", + cms_locale_id="653ad57de882f528b32e810e", + last_published=datetime.datetime.fromisoformat( + "2023-03-17 18:47:35+00:00", + ), + last_updated=datetime.datetime.fromisoformat( + "2023-03-17 18:47:35+00:00", + ), + created_on=datetime.datetime.fromisoformat( + "2023-03-17 18:47:35+00:00", + ), + field_data=SkuFieldData( + name="Colorful T-shirt - Default", + slug="colorful-t-shirt-default", + price=SkuFieldDataPrice( + value=2499.0, + unit="USD", + currency="USD", + ), + ), + ), ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/products/{jsonable_encoder(product_id)}/skus/{jsonable_encoder(sku_id)}", - method="PATCH", - json={ - "publishStatus": publish_status, - "sku": convert_and_respect_annotation_metadata(object_=sku, annotation=Sku, direction="write"), - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, + _response = await self._raw_client.update_sku( + site_id, product_id, sku_id, sku=sku, publish_status=publish_status, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Sku, - parse_obj_as( - type_=Sku, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data diff --git a/src/webflow/resources/products/raw_client.py b/src/webflow/resources/products/raw_client.py new file mode 100644 index 0000000..e7b0965 --- /dev/null +++ b/src/webflow/resources/products/raw_client.py @@ -0,0 +1,1791 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from ...core.api_error import ApiError +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from ...core.http_response import AsyncHttpResponse, HttpResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.parse_error import ParsingError +from ...core.pydantic_utilities import parse_obj_as +from ...core.request_options import RequestOptions +from ...core.serialization import convert_and_respect_annotation_metadata +from ...errors.bad_request_error import BadRequestError +from ...errors.conflict_error import ConflictError +from ...errors.forbidden_error import ForbiddenError +from ...errors.internal_server_error import InternalServerError +from ...errors.not_found_error import NotFoundError +from ...errors.too_many_requests_error import TooManyRequestsError +from ...errors.unauthorized_error import UnauthorizedError +from ...types.error import Error +from ...types.product import Product +from ...types.product_and_sk_us import ProductAndSkUs +from ...types.product_and_sk_us_list import ProductAndSkUsList +from ...types.publish_status import PublishStatus +from ...types.sku import Sku +from .types.product_sku_create_product import ProductSkuCreateProduct +from .types.product_sku_create_sku import ProductSkuCreateSku +from .types.products_create_sku_response import ProductsCreateSkuResponse +from pydantic import ValidationError + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawProductsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def list( + self, + site_id: str, + *, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[ProductAndSkUsList]: + """ + Retrieve all products for a site. + + Use `limit` and `offset` to page through all products with subsequent requests. All SKUs for each product + will also be fetched and returned. The `limit`, `offset` and `total` values represent Products only and do not include any SKUs. + + Required scope | `ecommerce:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ProductAndSkUsList] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/products", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "offset": offset, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ProductAndSkUsList, + parse_obj_as( + type_=ProductAndSkUsList, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def create( + self, + site_id: str, + *, + product: ProductSkuCreateProduct, + sku: ProductSkuCreateSku, + publish_status: typing.Optional[PublishStatus] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[ProductAndSkUs]: + """ + Create a new ecommerce product and defaultSKU. A product, at minimum, must have a single SKU. + + To create a product with multiple SKUs: + - First, create a list of `sku-properties`, also known as [product options](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants). For example, a T-shirt product may have a "color" `sku-property`, with a list of enum values: red, yellow, and blue, another `sku-property` may be "size", with a list of enum values: small, medium, and large. + - Once, a product is created with a list of `sku-properties`, Webflow will create a **default SKU**, which is always a combination of the first `enum` values of each `sku-property`. (e.g. Small - Red - T-Shirt) + - After creation, you can create additional SKUs for the product, using the [Create SKUs endpoint.](/data/reference/ecommerce/products/create-sku) + + Upon creation, the default product type will be `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer. + + Required scope | `ecommerce:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + product : ProductSkuCreateProduct + + sku : ProductSkuCreateSku + + publish_status : typing.Optional[PublishStatus] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ProductAndSkUs] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/products", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "publishStatus": publish_status, + "product": convert_and_respect_annotation_metadata( + object_=product, annotation=ProductSkuCreateProduct, direction="write" + ), + "sku": convert_and_respect_annotation_metadata( + object_=sku, annotation=ProductSkuCreateSku, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ProductAndSkUs, + parse_obj_as( + type_=ProductAndSkUs, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def get( + self, site_id: str, product_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[ProductAndSkUs]: + """ + Retrieve a single product by its ID. All of its SKUs will also be + retrieved. + + Required scope | `ecommerce:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + product_id : str + Unique identifier for a Product + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ProductAndSkUs] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/products/{jsonable_encoder(product_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ProductAndSkUs, + parse_obj_as( + type_=ProductAndSkUs, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def update( + self, + site_id: str, + product_id: str, + *, + publish_status: typing.Optional[PublishStatus] = OMIT, + product: typing.Optional[Product] = OMIT, + sku: typing.Optional[Sku] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[Product]: + """ + Update an existing Product. + + Updating an existing Product will set the product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer. + + Required scope | `ecommerce:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + product_id : str + Unique identifier for a Product + + publish_status : typing.Optional[PublishStatus] + + product : typing.Optional[Product] + + sku : typing.Optional[Sku] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Product] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/products/{jsonable_encoder(product_id)}", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + json={ + "publishStatus": publish_status, + "product": convert_and_respect_annotation_metadata( + object_=product, annotation=Product, direction="write" + ), + "sku": convert_and_respect_annotation_metadata(object_=sku, annotation=Sku, direction="write"), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Product, + parse_obj_as( + type_=Product, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def create_sku( + self, + site_id: str, + product_id: str, + *, + skus: typing.Sequence[Sku], + publish_status: typing.Optional[PublishStatus] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[ProductsCreateSkuResponse]: + """ + Create additional SKUs to manage every [option and variant of your Product.](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants) + + Creating SKUs through the API will set the product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer. + + Required scope | `ecommerce:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + product_id : str + Unique identifier for a Product + + skus : typing.Sequence[Sku] + An array of the SKU data your are adding + + publish_status : typing.Optional[PublishStatus] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ProductsCreateSkuResponse] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/products/{jsonable_encoder(product_id)}/skus", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "publishStatus": publish_status, + "skus": convert_and_respect_annotation_metadata( + object_=skus, annotation=typing.Sequence[Sku], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ProductsCreateSkuResponse, + parse_obj_as( + type_=ProductsCreateSkuResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def update_sku( + self, + site_id: str, + product_id: str, + sku_id: str, + *, + sku: Sku, + publish_status: typing.Optional[PublishStatus] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[Sku]: + """ + Update a specified SKU. + + Updating an existing SKU will set the Product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer. + + Required scope | `ecommerce:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + product_id : str + Unique identifier for a Product + + sku_id : str + Unique identifier for a SKU + + sku : Sku + + publish_status : typing.Optional[PublishStatus] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Sku] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/products/{jsonable_encoder(product_id)}/skus/{jsonable_encoder(sku_id)}", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + json={ + "publishStatus": publish_status, + "sku": convert_and_respect_annotation_metadata(object_=sku, annotation=Sku, direction="write"), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Sku, + parse_obj_as( + type_=Sku, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawProductsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def list( + self, + site_id: str, + *, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[ProductAndSkUsList]: + """ + Retrieve all products for a site. + + Use `limit` and `offset` to page through all products with subsequent requests. All SKUs for each product + will also be fetched and returned. The `limit`, `offset` and `total` values represent Products only and do not include any SKUs. + + Required scope | `ecommerce:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ProductAndSkUsList] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/products", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "offset": offset, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ProductAndSkUsList, + parse_obj_as( + type_=ProductAndSkUsList, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def create( + self, + site_id: str, + *, + product: ProductSkuCreateProduct, + sku: ProductSkuCreateSku, + publish_status: typing.Optional[PublishStatus] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[ProductAndSkUs]: + """ + Create a new ecommerce product and defaultSKU. A product, at minimum, must have a single SKU. + + To create a product with multiple SKUs: + - First, create a list of `sku-properties`, also known as [product options](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants). For example, a T-shirt product may have a "color" `sku-property`, with a list of enum values: red, yellow, and blue, another `sku-property` may be "size", with a list of enum values: small, medium, and large. + - Once, a product is created with a list of `sku-properties`, Webflow will create a **default SKU**, which is always a combination of the first `enum` values of each `sku-property`. (e.g. Small - Red - T-Shirt) + - After creation, you can create additional SKUs for the product, using the [Create SKUs endpoint.](/data/reference/ecommerce/products/create-sku) + + Upon creation, the default product type will be `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer. + + Required scope | `ecommerce:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + product : ProductSkuCreateProduct + + sku : ProductSkuCreateSku + + publish_status : typing.Optional[PublishStatus] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ProductAndSkUs] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/products", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "publishStatus": publish_status, + "product": convert_and_respect_annotation_metadata( + object_=product, annotation=ProductSkuCreateProduct, direction="write" + ), + "sku": convert_and_respect_annotation_metadata( + object_=sku, annotation=ProductSkuCreateSku, direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ProductAndSkUs, + parse_obj_as( + type_=ProductAndSkUs, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def get( + self, site_id: str, product_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[ProductAndSkUs]: + """ + Retrieve a single product by its ID. All of its SKUs will also be + retrieved. + + Required scope | `ecommerce:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + product_id : str + Unique identifier for a Product + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ProductAndSkUs] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/products/{jsonable_encoder(product_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ProductAndSkUs, + parse_obj_as( + type_=ProductAndSkUs, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def update( + self, + site_id: str, + product_id: str, + *, + publish_status: typing.Optional[PublishStatus] = OMIT, + product: typing.Optional[Product] = OMIT, + sku: typing.Optional[Sku] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[Product]: + """ + Update an existing Product. + + Updating an existing Product will set the product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer. + + Required scope | `ecommerce:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + product_id : str + Unique identifier for a Product + + publish_status : typing.Optional[PublishStatus] + + product : typing.Optional[Product] + + sku : typing.Optional[Sku] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Product] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/products/{jsonable_encoder(product_id)}", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + json={ + "publishStatus": publish_status, + "product": convert_and_respect_annotation_metadata( + object_=product, annotation=Product, direction="write" + ), + "sku": convert_and_respect_annotation_metadata(object_=sku, annotation=Sku, direction="write"), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Product, + parse_obj_as( + type_=Product, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def create_sku( + self, + site_id: str, + product_id: str, + *, + skus: typing.Sequence[Sku], + publish_status: typing.Optional[PublishStatus] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[ProductsCreateSkuResponse]: + """ + Create additional SKUs to manage every [option and variant of your Product.](https://help.webflow.com/hc/en-us/articles/33961334531347-Create-product-options-and-variants) + + Creating SKUs through the API will set the product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer. + + Required scope | `ecommerce:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + product_id : str + Unique identifier for a Product + + skus : typing.Sequence[Sku] + An array of the SKU data your are adding + + publish_status : typing.Optional[PublishStatus] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ProductsCreateSkuResponse] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/products/{jsonable_encoder(product_id)}/skus", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "publishStatus": publish_status, + "skus": convert_and_respect_annotation_metadata( + object_=skus, annotation=typing.Sequence[Sku], direction="write" + ), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ProductsCreateSkuResponse, + parse_obj_as( + type_=ProductsCreateSkuResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def update_sku( + self, + site_id: str, + product_id: str, + sku_id: str, + *, + sku: Sku, + publish_status: typing.Optional[PublishStatus] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[Sku]: + """ + Update a specified SKU. + + Updating an existing SKU will set the Product type to `Advanced`, which ensures all Product and SKU fields will be shown to users in the Designer. + + Required scope | `ecommerce:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + product_id : str + Unique identifier for a Product + + sku_id : str + Unique identifier for a SKU + + sku : Sku + + publish_status : typing.Optional[PublishStatus] + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Sku] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/products/{jsonable_encoder(product_id)}/skus/{jsonable_encoder(sku_id)}", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + json={ + "publishStatus": publish_status, + "sku": convert_and_respect_annotation_metadata(object_=sku, annotation=Sku, direction="write"), + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Sku, + parse_obj_as( + type_=Sku, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/products/types/__init__.py b/src/webflow/resources/products/types/__init__.py index b078afe..909ffe5 100644 --- a/src/webflow/resources/products/types/__init__.py +++ b/src/webflow/resources/products/types/__init__.py @@ -1,5 +1,40 @@ # This file was auto-generated by Fern from our API Definition. -from .products_create_sku_response import ProductsCreateSkuResponse +# isort: skip_file -__all__ = ["ProductsCreateSkuResponse"] +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .product_sku_create_product import ProductSkuCreateProduct + from .product_sku_create_sku import ProductSkuCreateSku + from .products_create_sku_response import ProductsCreateSkuResponse +_dynamic_imports: typing.Dict[str, str] = { + "ProductSkuCreateProduct": ".product_sku_create_product", + "ProductSkuCreateSku": ".product_sku_create_sku", + "ProductsCreateSkuResponse": ".products_create_sku_response", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + + +__all__ = ["ProductSkuCreateProduct", "ProductSkuCreateSku", "ProductsCreateSkuResponse"] diff --git a/src/webflow/resources/products/types/product_sku_create_product.py b/src/webflow/resources/products/types/product_sku_create_product.py new file mode 100644 index 0000000..d35d712 --- /dev/null +++ b/src/webflow/resources/products/types/product_sku_create_product.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ....core.serialization import FieldMetadata +from ....types.product_field_data import ProductFieldData + + +class ProductSkuCreateProduct(UniversalBaseModel): + field_data: typing_extensions.Annotated[ + typing.Optional[ProductFieldData], FieldMetadata(alias="fieldData"), pydantic.Field(alias="fieldData") + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/resources/products/types/product_sku_create_sku.py b/src/webflow/resources/products/types/product_sku_create_sku.py new file mode 100644 index 0000000..838e778 --- /dev/null +++ b/src/webflow/resources/products/types/product_sku_create_sku.py @@ -0,0 +1,24 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ....core.serialization import FieldMetadata +from ....types.sku_field_data import SkuFieldData + + +class ProductSkuCreateSku(UniversalBaseModel): + field_data: typing_extensions.Annotated[ + typing.Optional[SkuFieldData], FieldMetadata(alias="fieldData"), pydantic.Field(alias="fieldData") + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/resources/products/types/products_create_sku_response.py b/src/webflow/resources/products/types/products_create_sku_response.py index e694930..a498e9f 100644 --- a/src/webflow/resources/products/types/products_create_sku_response.py +++ b/src/webflow/resources/products/types/products_create_sku_response.py @@ -1,14 +1,14 @@ # This file was auto-generated by Fern from our API Definition. -from ....core.pydantic_utilities import UniversalBaseModel import typing -from ....types.sku import Sku -from ....core.pydantic_utilities import IS_PYDANTIC_V2 + import pydantic +from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ....types.sku import Sku class ProductsCreateSkuResponse(UniversalBaseModel): - skus: typing.Optional[typing.List[Sku]] = None + skus: typing.List[Sku] if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/resources/scripts/__init__.py b/src/webflow/resources/scripts/__init__.py index f3ea265..5cde020 100644 --- a/src/webflow/resources/scripts/__init__.py +++ b/src/webflow/resources/scripts/__init__.py @@ -1,2 +1,4 @@ # This file was auto-generated by Fern from our API Definition. +# isort: skip_file + diff --git a/src/webflow/resources/scripts/client.py b/src/webflow/resources/scripts/client.py index e9112fb..f8a540e 100644 --- a/src/webflow/resources/scripts/client.py +++ b/src/webflow/resources/scripts/client.py @@ -1,22 +1,13 @@ # This file was auto-generated by Fern from our API Definition. import typing -from ...core.client_wrapper import SyncClientWrapper + +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ...core.request_options import RequestOptions -from ...types.registered_script_list import RegisteredScriptList -from ...core.jsonable_encoder import jsonable_encoder -from ...core.pydantic_utilities import parse_obj_as -from ...errors.bad_request_error import BadRequestError -from ...errors.unauthorized_error import UnauthorizedError -from ...types.error import Error -from ...errors.not_found_error import NotFoundError -from ...errors.too_many_requests_error import TooManyRequestsError -from ...errors.internal_server_error import InternalServerError -from json.decoder import JSONDecodeError -from ...core.api_error import ApiError from ...types.custom_code_hosted_response import CustomCodeHostedResponse from ...types.custom_code_inline_response import CustomCodeInlineResponse -from ...core.client_wrapper import AsyncClientWrapper +from ...types.registered_script_list import RegisteredScriptList +from .raw_client import AsyncRawScriptsClient, RawScriptsClient # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) @@ -24,18 +15,26 @@ class ScriptsClient: def __init__(self, *, client_wrapper: SyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = RawScriptsClient(client_wrapper=client_wrapper) - def list(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> RegisteredScriptList: + @property + def with_raw_response(self) -> RawScriptsClient: """ - List of scripts registered to a Site. + Retrieves a raw implementation of this client that returns raw responses. - In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered - to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate - `custom_code` endpoints. - Additionally, Scripts can be remotely hosted, or registered as inline snippets. + Returns + ------- + RawScriptsClient + """ + return self._raw_client - Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + def list(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> RegisteredScriptList: + """ + Get a list of scripts that have been registered to a site. A site can have a maximum of 800 registered scripts. + + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + Required scope | `custom_code:read` @@ -63,74 +62,8 @@ def list(self, site_id: str, *, request_options: typing.Optional[RequestOptions] site_id="580e63e98c9a982ac9b8b741", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/registered_scripts", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - RegisteredScriptList, - parse_obj_as( - type_=RegisteredScriptList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.list(site_id, request_options=request_options) + return _response.data def register_hosted( self, @@ -144,14 +77,11 @@ def register_hosted( request_options: typing.Optional[RequestOptions] = None, ) -> CustomCodeHostedResponse: """ - Add a script to a Site's Custom Code registry. - - In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered - to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate - `custom_code` endpoints. - Additionally, Scripts can be remotely hosted, or registered as inline snippets. + Register a hosted script to a site. - Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + Required scope | `custom_code:write` @@ -198,85 +128,16 @@ def register_hosted( display_name="displayName", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/registered_scripts/hosted", - method="POST", - json={ - "hostedLocation": hosted_location, - "integrityHash": integrity_hash, - "canCopy": can_copy, - "version": version, - "displayName": display_name, - }, - headers={ - "content-type": "application/json", - }, + _response = self._raw_client.register_hosted( + site_id, + hosted_location=hosted_location, + integrity_hash=integrity_hash, + version=version, + display_name=display_name, + can_copy=can_copy, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CustomCodeHostedResponse, - parse_obj_as( - type_=CustomCodeHostedResponse, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def register_inline( self, @@ -290,13 +151,11 @@ def register_inline( request_options: typing.Optional[RequestOptions] = None, ) -> CustomCodeInlineResponse: """ - Add a script to a Site's Custom Code registry. Inline scripts can be between 1 and 2000 characters. + Register an inline script to a site. Inline scripts are limited to 2000 characters. - In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered - to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate - `custom_code` endpoints. - - Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + Required scope | `custom_code:write` @@ -342,103 +201,42 @@ def register_inline( display_name="Alert", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/registered_scripts/inline", - method="POST", - json={ - "sourceCode": source_code, - "integrityHash": integrity_hash, - "canCopy": can_copy, - "version": version, - "displayName": display_name, - }, - headers={ - "content-type": "application/json", - }, + _response = self._raw_client.register_inline( + site_id, + source_code=source_code, + version=version, + display_name=display_name, + integrity_hash=integrity_hash, + can_copy=can_copy, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CustomCodeInlineResponse, - parse_obj_as( - type_=CustomCodeInlineResponse, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data class AsyncScriptsClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = AsyncRawScriptsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawScriptsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawScriptsClient + """ + return self._raw_client async def list( self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> RegisteredScriptList: """ - List of scripts registered to a Site. - - In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered - to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate - `custom_code` endpoints. - Additionally, Scripts can be remotely hosted, or registered as inline snippets. + Get a list of scripts that have been registered to a site. A site can have a maximum of 800 registered scripts. - Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + Required scope | `custom_code:read` @@ -474,74 +272,8 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/registered_scripts", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - RegisteredScriptList, - parse_obj_as( - type_=RegisteredScriptList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.list(site_id, request_options=request_options) + return _response.data async def register_hosted( self, @@ -555,14 +287,11 @@ async def register_hosted( request_options: typing.Optional[RequestOptions] = None, ) -> CustomCodeHostedResponse: """ - Add a script to a Site's Custom Code registry. - - In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered - to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate - `custom_code` endpoints. - Additionally, Scripts can be remotely hosted, or registered as inline snippets. + Register a hosted script to a site. - Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + Required scope | `custom_code:write` @@ -617,85 +346,16 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/registered_scripts/hosted", - method="POST", - json={ - "hostedLocation": hosted_location, - "integrityHash": integrity_hash, - "canCopy": can_copy, - "version": version, - "displayName": display_name, - }, - headers={ - "content-type": "application/json", - }, + _response = await self._raw_client.register_hosted( + site_id, + hosted_location=hosted_location, + integrity_hash=integrity_hash, + version=version, + display_name=display_name, + can_copy=can_copy, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CustomCodeHostedResponse, - parse_obj_as( - type_=CustomCodeHostedResponse, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def register_inline( self, @@ -709,13 +369,11 @@ async def register_inline( request_options: typing.Optional[RequestOptions] = None, ) -> CustomCodeInlineResponse: """ - Add a script to a Site's Custom Code registry. Inline scripts can be between 1 and 2000 characters. - - In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered - to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate - `custom_code` endpoints. + Register an inline script to a site. Inline scripts are limited to 2000 characters. - Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + Required scope | `custom_code:write` @@ -769,82 +427,13 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/registered_scripts/inline", - method="POST", - json={ - "sourceCode": source_code, - "integrityHash": integrity_hash, - "canCopy": can_copy, - "version": version, - "displayName": display_name, - }, - headers={ - "content-type": "application/json", - }, + _response = await self._raw_client.register_inline( + site_id, + source_code=source_code, + version=version, + display_name=display_name, + integrity_hash=integrity_hash, + can_copy=can_copy, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - CustomCodeInlineResponse, - parse_obj_as( - type_=CustomCodeInlineResponse, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data diff --git a/src/webflow/resources/scripts/raw_client.py b/src/webflow/resources/scripts/raw_client.py new file mode 100644 index 0000000..0828f55 --- /dev/null +++ b/src/webflow/resources/scripts/raw_client.py @@ -0,0 +1,801 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from ...core.api_error import ApiError +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from ...core.http_response import AsyncHttpResponse, HttpResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.parse_error import ParsingError +from ...core.pydantic_utilities import parse_obj_as +from ...core.request_options import RequestOptions +from ...errors.bad_request_error import BadRequestError +from ...errors.internal_server_error import InternalServerError +from ...errors.not_found_error import NotFoundError +from ...errors.too_many_requests_error import TooManyRequestsError +from ...errors.unauthorized_error import UnauthorizedError +from ...types.custom_code_hosted_response import CustomCodeHostedResponse +from ...types.custom_code_inline_response import CustomCodeInlineResponse +from ...types.error import Error +from ...types.registered_script_list import RegisteredScriptList +from pydantic import ValidationError + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawScriptsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def list( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[RegisteredScriptList]: + """ + Get a list of scripts that have been registered to a site. A site can have a maximum of 800 registered scripts. + + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + + + Required scope | `custom_code:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[RegisteredScriptList] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/registered_scripts", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RegisteredScriptList, + parse_obj_as( + type_=RegisteredScriptList, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def register_hosted( + self, + site_id: str, + *, + hosted_location: str, + integrity_hash: str, + version: str, + display_name: str, + can_copy: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CustomCodeHostedResponse]: + """ + Register a hosted script to a site. + + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + + + Required scope | `custom_code:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + hosted_location : str + URI for an externally hosted script location + + integrity_hash : str + Sub-Resource Integrity Hash + + version : str + A Semantic Version (SemVer) string, denoting the version of the script + + display_name : str + User-facing name for the script. Must be between 1 and 50 alphanumeric characters + + can_copy : typing.Optional[bool] + Define whether the script can be copied on site duplication and transfer + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CustomCodeHostedResponse] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/registered_scripts/hosted", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "hostedLocation": hosted_location, + "integrityHash": integrity_hash, + "canCopy": can_copy, + "version": version, + "displayName": display_name, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CustomCodeHostedResponse, + parse_obj_as( + type_=CustomCodeHostedResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def register_inline( + self, + site_id: str, + *, + source_code: str, + version: str, + display_name: str, + integrity_hash: typing.Optional[str] = OMIT, + can_copy: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CustomCodeInlineResponse]: + """ + Register an inline script to a site. Inline scripts are limited to 2000 characters. + + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + + + Required scope | `custom_code:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + source_code : str + The code to be added to the site (to be hosted by Webflow). + + version : str + A Semantic Version (SemVer) string, denoting the version of the script + + display_name : str + User-facing name for the script. Must be between 1 and 50 alphanumeric characters + + integrity_hash : typing.Optional[str] + Sub-Resource Integrity Hash. Only required for externally hosted scripts (passed via hostedLocation) + + can_copy : typing.Optional[bool] + Define whether the script can be copied on site duplication and transfer + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CustomCodeInlineResponse] + Created + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/registered_scripts/inline", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "sourceCode": source_code, + "integrityHash": integrity_hash, + "canCopy": can_copy, + "version": version, + "displayName": display_name, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CustomCodeInlineResponse, + parse_obj_as( + type_=CustomCodeInlineResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawScriptsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def list( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[RegisteredScriptList]: + """ + Get a list of scripts that have been registered to a site. A site can have a maximum of 800 registered scripts. + + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + + + Required scope | `custom_code:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[RegisteredScriptList] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/registered_scripts", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + RegisteredScriptList, + parse_obj_as( + type_=RegisteredScriptList, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def register_hosted( + self, + site_id: str, + *, + hosted_location: str, + integrity_hash: str, + version: str, + display_name: str, + can_copy: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CustomCodeHostedResponse]: + """ + Register a hosted script to a site. + + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + + + Required scope | `custom_code:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + hosted_location : str + URI for an externally hosted script location + + integrity_hash : str + Sub-Resource Integrity Hash + + version : str + A Semantic Version (SemVer) string, denoting the version of the script + + display_name : str + User-facing name for the script. Must be between 1 and 50 alphanumeric characters + + can_copy : typing.Optional[bool] + Define whether the script can be copied on site duplication and transfer + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CustomCodeHostedResponse] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/registered_scripts/hosted", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "hostedLocation": hosted_location, + "integrityHash": integrity_hash, + "canCopy": can_copy, + "version": version, + "displayName": display_name, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CustomCodeHostedResponse, + parse_obj_as( + type_=CustomCodeHostedResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def register_inline( + self, + site_id: str, + *, + source_code: str, + version: str, + display_name: str, + integrity_hash: typing.Optional[str] = OMIT, + can_copy: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CustomCodeInlineResponse]: + """ + Register an inline script to a site. Inline scripts are limited to 2000 characters. + + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + + + Required scope | `custom_code:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + source_code : str + The code to be added to the site (to be hosted by Webflow). + + version : str + A Semantic Version (SemVer) string, denoting the version of the script + + display_name : str + User-facing name for the script. Must be between 1 and 50 alphanumeric characters + + integrity_hash : typing.Optional[str] + Sub-Resource Integrity Hash. Only required for externally hosted scripts (passed via hostedLocation) + + can_copy : typing.Optional[bool] + Define whether the script can be copied on site duplication and transfer + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CustomCodeInlineResponse] + Created + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/registered_scripts/inline", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "sourceCode": source_code, + "integrityHash": integrity_hash, + "canCopy": can_copy, + "version": version, + "displayName": display_name, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CustomCodeInlineResponse, + parse_obj_as( + type_=CustomCodeInlineResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/sites/__init__.py b/src/webflow/resources/sites/__init__.py index 3ec19db..fb81115 100644 --- a/src/webflow/resources/sites/__init__.py +++ b/src/webflow/resources/sites/__init__.py @@ -1,6 +1,85 @@ # This file was auto-generated by Fern from our API Definition. -from .types import SitesPublishResponse -from .resources import activity_logs, plans, redirects, scripts +# isort: skip_file -__all__ = ["SitesPublishResponse", "activity_logs", "plans", "redirects", "scripts"] +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .types import SitesPublishResponse + from .resources import ( + CommentsGetCommentThreadRequestSortBy, + CommentsGetCommentThreadRequestSortOrder, + CommentsListCommentRepliesRequestSortBy, + CommentsListCommentRepliesRequestSortOrder, + CommentsListCommentThreadsRequestSortBy, + CommentsListCommentThreadsRequestSortOrder, + WellKnownFileContentType, + activity_logs, + comments, + forms, + plans, + redirects, + robots_txt, + scripts, + well_known, + ) +_dynamic_imports: typing.Dict[str, str] = { + "CommentsGetCommentThreadRequestSortBy": ".resources", + "CommentsGetCommentThreadRequestSortOrder": ".resources", + "CommentsListCommentRepliesRequestSortBy": ".resources", + "CommentsListCommentRepliesRequestSortOrder": ".resources", + "CommentsListCommentThreadsRequestSortBy": ".resources", + "CommentsListCommentThreadsRequestSortOrder": ".resources", + "SitesPublishResponse": ".types", + "WellKnownFileContentType": ".resources", + "activity_logs": ".resources", + "comments": ".resources", + "forms": ".resources", + "plans": ".resources", + "redirects": ".resources", + "robots_txt": ".resources", + "scripts": ".resources", + "well_known": ".resources", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + + +__all__ = [ + "CommentsGetCommentThreadRequestSortBy", + "CommentsGetCommentThreadRequestSortOrder", + "CommentsListCommentRepliesRequestSortBy", + "CommentsListCommentRepliesRequestSortOrder", + "CommentsListCommentThreadsRequestSortBy", + "CommentsListCommentThreadsRequestSortOrder", + "SitesPublishResponse", + "WellKnownFileContentType", + "activity_logs", + "comments", + "forms", + "plans", + "redirects", + "robots_txt", + "scripts", + "well_known", +] diff --git a/src/webflow/resources/sites/client.py b/src/webflow/resources/sites/client.py index c2a4468..30b9ca2 100644 --- a/src/webflow/resources/sites/client.py +++ b/src/webflow/resources/sites/client.py @@ -1,44 +1,53 @@ # This file was auto-generated by Fern from our API Definition. +from __future__ import annotations + import typing -from ...core.client_wrapper import SyncClientWrapper -from .resources.redirects.client import RedirectsClient -from .resources.plans.client import PlansClient -from .resources.activity_logs.client import ActivityLogsClient -from .resources.scripts.client import ScriptsClient + +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ...core.request_options import RequestOptions +from ...types.domains import Domains from ...types.site import Site -from ...core.jsonable_encoder import jsonable_encoder -from ...core.pydantic_utilities import parse_obj_as -from ...errors.bad_request_error import BadRequestError -from ...errors.unauthorized_error import UnauthorizedError -from ...types.error import Error -from ...errors.forbidden_error import ForbiddenError -from ...errors.not_found_error import NotFoundError -from ...errors.too_many_requests_error import TooManyRequestsError -from ...errors.internal_server_error import InternalServerError -from json.decoder import JSONDecodeError -from ...core.api_error import ApiError from ...types.sites import Sites -from ...types.domains import Domains +from .raw_client import AsyncRawSitesClient, RawSitesClient from .types.sites_publish_response import SitesPublishResponse -from ...core.client_wrapper import AsyncClientWrapper -from .resources.redirects.client import AsyncRedirectsClient -from .resources.plans.client import AsyncPlansClient -from .resources.activity_logs.client import AsyncActivityLogsClient -from .resources.scripts.client import AsyncScriptsClient +if typing.TYPE_CHECKING: + from .resources.activity_logs.client import ActivityLogsClient, AsyncActivityLogsClient + from .resources.comments.client import AsyncCommentsClient, CommentsClient + from .resources.forms.client import AsyncFormsClient, FormsClient + from .resources.plans.client import AsyncPlansClient, PlansClient + from .resources.redirects.client import AsyncRedirectsClient, RedirectsClient + from .resources.robots_txt.client import AsyncRobotsTxtClient, RobotsTxtClient + from .resources.scripts.client import AsyncScriptsClient, ScriptsClient + from .resources.well_known.client import AsyncWellKnownClient, WellKnownClient # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) class SitesClient: def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawSitesClient(client_wrapper=client_wrapper) self._client_wrapper = client_wrapper - self.redirects = RedirectsClient(client_wrapper=self._client_wrapper) - self.plans = PlansClient(client_wrapper=self._client_wrapper) - self.activity_logs = ActivityLogsClient(client_wrapper=self._client_wrapper) - self.scripts = ScriptsClient(client_wrapper=self._client_wrapper) + self._redirects: typing.Optional[RedirectsClient] = None + self._plans: typing.Optional[PlansClient] = None + self._robots_txt: typing.Optional[RobotsTxtClient] = None + self._well_known: typing.Optional[WellKnownClient] = None + self._activity_logs: typing.Optional[ActivityLogsClient] = None + self._comments: typing.Optional[CommentsClient] = None + self._scripts: typing.Optional[ScriptsClient] = None + self._forms: typing.Optional[FormsClient] = None + + @property + def with_raw_response(self) -> RawSitesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawSitesClient + """ + return self._raw_client def create( self, @@ -50,7 +59,9 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> Site: """ - Create a site. This endpoint requires an Enterprise workspace. + Create a site. + + This endpoint requires an Enterprise workspace. Required scope | `workspace:write` @@ -88,93 +99,14 @@ def create( name="The Hitchhiker's Guide to the Galaxy", ) """ - _response = self._client_wrapper.httpx_client.request( - f"workspaces/{jsonable_encoder(workspace_id)}/sites", - method="POST", - json={ - "name": name, - "templateName": template_name, - "parentFolderId": parent_folder_id, - }, - headers={ - "content-type": "application/json", - }, + _response = self._raw_client.create( + workspace_id, + name=name, + template_name=template_name, + parent_folder_id=parent_folder_id, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Site, - parse_obj_as( - type_=Site, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> Sites: """ @@ -201,54 +133,8 @@ def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> Si ) client.sites.list() """ - _response = self._client_wrapper.httpx_client.request( - "sites", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Sites, - parse_obj_as( - type_=Sites, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.list(request_options=request_options) + return _response.data def get(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Site: """ @@ -280,78 +166,14 @@ def get(self, site_id: str, *, request_options: typing.Optional[RequestOptions] site_id="580e63e98c9a982ac9b8b741", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Site, - parse_obj_as( - type_=Site, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.get(site_id, request_options=request_options) + return _response.data def delete(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ - Delete a site. This endpoint requires an Enterprise workspace. + Delete a site. + + This endpoint requires an Enterprise workspace. Required scope | `sites:write` @@ -378,78 +200,8 @@ def delete(self, site_id: str, *, request_options: typing.Optional[RequestOption site_id="580e63e98c9a982ac9b8b741", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}", - method="DELETE", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.delete(site_id, request_options=request_options) + return _response.data def update( self, @@ -460,7 +212,9 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> Site: """ - Update a site. This endpoint requires an Enterprise workspace. + Update a site. + + This endpoint requires an Enterprise workspace. Required scope | `sites:write` @@ -494,92 +248,10 @@ def update( site_id="580e63e98c9a982ac9b8b741", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}", - method="PATCH", - json={ - "name": name, - "parentFolderId": parent_folder_id, - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, + _response = self._raw_client.update( + site_id, name=name, parent_folder_id=parent_folder_id, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Site, - parse_obj_as( - type_=Site, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def get_custom_domain(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Domains: """ @@ -611,74 +283,8 @@ def get_custom_domain(self, site_id: str, *, request_options: typing.Optional[Re site_id="580e63e98c9a982ac9b8b741", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/custom_domains", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Domains, - parse_obj_as( - type_=Domains, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.get_custom_domain(site_id, request_options=request_options) + return _response.data def publish( self, @@ -691,7 +297,9 @@ def publish( """ Publishes a site to one or more more domains. - This endpoint has a limit of one successful publish queue per minute. + To publish to a specific custom domain, use the domain IDs from the [Get Custom Domains](/data/reference/sites/get-custom-domain) endpoint. + + This endpoint has a specific rate limit of one successful publish queue per minute. Required scope | `sites:write` @@ -723,93 +331,106 @@ def publish( ) client.sites.publish( site_id="580e63e98c9a982ac9b8b741", + custom_domains=["660c6449dd97ebc7346ac629", "660c6449dd97ebc7346ac62f"], + publish_to_webflow_subdomain=False, ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/publish", - method="POST", - json={ - "customDomains": custom_domains, - "publishToWebflowSubdomain": publish_to_webflow_subdomain, - }, - headers={ - "content-type": "application/json", - }, + _response = self._raw_client.publish( + site_id, + custom_domains=custom_domains, + publish_to_webflow_subdomain=publish_to_webflow_subdomain, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - SitesPublishResponse, - parse_obj_as( - type_=SitesPublishResponse, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data + + @property + def redirects(self): + if self._redirects is None: + from .resources.redirects.client import RedirectsClient # noqa: E402 + + self._redirects = RedirectsClient(client_wrapper=self._client_wrapper) + return self._redirects + + @property + def plans(self): + if self._plans is None: + from .resources.plans.client import PlansClient # noqa: E402 + + self._plans = PlansClient(client_wrapper=self._client_wrapper) + return self._plans + + @property + def robots_txt(self): + if self._robots_txt is None: + from .resources.robots_txt.client import RobotsTxtClient # noqa: E402 + + self._robots_txt = RobotsTxtClient(client_wrapper=self._client_wrapper) + return self._robots_txt + + @property + def well_known(self): + if self._well_known is None: + from .resources.well_known.client import WellKnownClient # noqa: E402 + + self._well_known = WellKnownClient(client_wrapper=self._client_wrapper) + return self._well_known + + @property + def activity_logs(self): + if self._activity_logs is None: + from .resources.activity_logs.client import ActivityLogsClient # noqa: E402 + + self._activity_logs = ActivityLogsClient(client_wrapper=self._client_wrapper) + return self._activity_logs + + @property + def comments(self): + if self._comments is None: + from .resources.comments.client import CommentsClient # noqa: E402 + + self._comments = CommentsClient(client_wrapper=self._client_wrapper) + return self._comments + + @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 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 class AsyncSitesClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawSitesClient(client_wrapper=client_wrapper) self._client_wrapper = client_wrapper - self.redirects = AsyncRedirectsClient(client_wrapper=self._client_wrapper) - self.plans = AsyncPlansClient(client_wrapper=self._client_wrapper) - self.activity_logs = AsyncActivityLogsClient(client_wrapper=self._client_wrapper) - self.scripts = AsyncScriptsClient(client_wrapper=self._client_wrapper) + self._redirects: typing.Optional[AsyncRedirectsClient] = None + self._plans: typing.Optional[AsyncPlansClient] = None + self._robots_txt: typing.Optional[AsyncRobotsTxtClient] = None + self._well_known: typing.Optional[AsyncWellKnownClient] = None + self._activity_logs: typing.Optional[AsyncActivityLogsClient] = None + self._comments: typing.Optional[AsyncCommentsClient] = None + self._scripts: typing.Optional[AsyncScriptsClient] = None + self._forms: typing.Optional[AsyncFormsClient] = None + + @property + def with_raw_response(self) -> AsyncRawSitesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawSitesClient + """ + return self._raw_client async def create( self, @@ -821,7 +442,9 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> Site: """ - Create a site. This endpoint requires an Enterprise workspace. + Create a site. + + This endpoint requires an Enterprise workspace. Required scope | `workspace:write` @@ -867,93 +490,14 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"workspaces/{jsonable_encoder(workspace_id)}/sites", - method="POST", - json={ - "name": name, - "templateName": template_name, - "parentFolderId": parent_folder_id, - }, - headers={ - "content-type": "application/json", - }, + _response = await self._raw_client.create( + workspace_id, + name=name, + template_name=template_name, + parent_folder_id=parent_folder_id, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Site, - parse_obj_as( - type_=Site, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> Sites: """ @@ -988,54 +532,8 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - "sites", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Sites, - parse_obj_as( - type_=Sites, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.list(request_options=request_options) + return _response.data async def get(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Site: """ @@ -1075,78 +573,14 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Site, - parse_obj_as( - type_=Site, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.get(site_id, request_options=request_options) + return _response.data async def delete(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ - Delete a site. This endpoint requires an Enterprise workspace. + Delete a site. + + This endpoint requires an Enterprise workspace. Required scope | `sites:write` @@ -1181,78 +615,8 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}", - method="DELETE", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.delete(site_id, request_options=request_options) + return _response.data async def update( self, @@ -1263,7 +627,9 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> Site: """ - Update a site. This endpoint requires an Enterprise workspace. + Update a site. + + This endpoint requires an Enterprise workspace. Required scope | `sites:write` @@ -1305,92 +671,10 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}", - method="PATCH", - json={ - "name": name, - "parentFolderId": parent_folder_id, - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, + _response = await self._raw_client.update( + site_id, name=name, parent_folder_id=parent_folder_id, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Site, - parse_obj_as( - type_=Site, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def get_custom_domain( self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None @@ -1432,74 +716,8 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/custom_domains", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Domains, - parse_obj_as( - type_=Domains, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.get_custom_domain(site_id, request_options=request_options) + return _response.data async def publish( self, @@ -1512,7 +730,9 @@ async def publish( """ Publishes a site to one or more more domains. - This endpoint has a limit of one successful publish queue per minute. + To publish to a specific custom domain, use the domain IDs from the [Get Custom Domains](/data/reference/sites/get-custom-domain) endpoint. + + This endpoint has a specific rate limit of one successful publish queue per minute. Required scope | `sites:write` @@ -1549,84 +769,81 @@ async def publish( async def main() -> None: await client.sites.publish( site_id="580e63e98c9a982ac9b8b741", + custom_domains=["660c6449dd97ebc7346ac629", "660c6449dd97ebc7346ac62f"], + publish_to_webflow_subdomain=False, ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/publish", - method="POST", - json={ - "customDomains": custom_domains, - "publishToWebflowSubdomain": publish_to_webflow_subdomain, - }, - headers={ - "content-type": "application/json", - }, + _response = await self._raw_client.publish( + site_id, + custom_domains=custom_domains, + publish_to_webflow_subdomain=publish_to_webflow_subdomain, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - SitesPublishResponse, - parse_obj_as( - type_=SitesPublishResponse, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data + + @property + def redirects(self): + if self._redirects is None: + from .resources.redirects.client import AsyncRedirectsClient # noqa: E402 + + self._redirects = AsyncRedirectsClient(client_wrapper=self._client_wrapper) + return self._redirects + + @property + def plans(self): + if self._plans is None: + from .resources.plans.client import AsyncPlansClient # noqa: E402 + + self._plans = AsyncPlansClient(client_wrapper=self._client_wrapper) + return self._plans + + @property + def robots_txt(self): + if self._robots_txt is None: + from .resources.robots_txt.client import AsyncRobotsTxtClient # noqa: E402 + + self._robots_txt = AsyncRobotsTxtClient(client_wrapper=self._client_wrapper) + return self._robots_txt + + @property + def well_known(self): + if self._well_known is None: + from .resources.well_known.client import AsyncWellKnownClient # noqa: E402 + + self._well_known = AsyncWellKnownClient(client_wrapper=self._client_wrapper) + return self._well_known + + @property + def activity_logs(self): + if self._activity_logs is None: + from .resources.activity_logs.client import AsyncActivityLogsClient # noqa: E402 + + self._activity_logs = AsyncActivityLogsClient(client_wrapper=self._client_wrapper) + return self._activity_logs + + @property + def comments(self): + if self._comments is None: + from .resources.comments.client import AsyncCommentsClient # noqa: E402 + + self._comments = AsyncCommentsClient(client_wrapper=self._client_wrapper) + return self._comments + + @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 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 diff --git a/src/webflow/resources/sites/raw_client.py b/src/webflow/resources/sites/raw_client.py new file mode 100644 index 0000000..cc08250 --- /dev/null +++ b/src/webflow/resources/sites/raw_client.py @@ -0,0 +1,1587 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from ...core.api_error import ApiError +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from ...core.http_response import AsyncHttpResponse, HttpResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.parse_error import ParsingError +from ...core.pydantic_utilities import parse_obj_as +from ...core.request_options import RequestOptions +from ...errors.bad_request_error import BadRequestError +from ...errors.forbidden_error import ForbiddenError +from ...errors.internal_server_error import InternalServerError +from ...errors.not_found_error import NotFoundError +from ...errors.too_many_requests_error import TooManyRequestsError +from ...errors.unauthorized_error import UnauthorizedError +from ...types.domains import Domains +from ...types.error import Error +from ...types.site import Site +from ...types.sites import Sites +from .types.sites_publish_response import SitesPublishResponse +from pydantic import ValidationError + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawSitesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def create( + self, + workspace_id: str, + *, + name: str, + template_name: typing.Optional[str] = OMIT, + parent_folder_id: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[Site]: + """ + Create a site. + + This endpoint requires an Enterprise workspace. + + Required scope | `workspace:write` + + Parameters + ---------- + workspace_id : str + Unique identifier for a Workspace + + name : str + The name of the site + + template_name : typing.Optional[str] + The workspace or marketplace template to use + + parent_folder_id : typing.Optional[str] + MegaDodo Publications - Potential Book Ideas + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Site] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"workspaces/{jsonable_encoder(workspace_id)}/sites", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "name": name, + "templateName": template_name, + "parentFolderId": parent_folder_id, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Site, + parse_obj_as( + type_=Site, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[Sites]: + """ + List of all sites the provided access token is able to access. + + Required scope | `sites:read` + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Sites] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + "sites", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Sites, + parse_obj_as( + type_=Sites, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def get(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[Site]: + """ + Get details of a site. + + Required scope | `sites:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Site] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Site, + parse_obj_as( + type_=Site, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def delete(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[None]: + """ + Delete a site. + + This endpoint requires an Enterprise workspace. + + Required scope | `sites:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[None] + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return HttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def update( + self, + site_id: str, + *, + name: typing.Optional[str] = OMIT, + parent_folder_id: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[Site]: + """ + Update a site. + + This endpoint requires an Enterprise workspace. + + Required scope | `sites:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + name : typing.Optional[str] + The name of the site + + parent_folder_id : typing.Optional[str] + The parent folder ID of the site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Site] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + json={ + "name": name, + "parentFolderId": parent_folder_id, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Site, + parse_obj_as( + type_=Site, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def get_custom_domain( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[Domains]: + """ + Get a list of all custom domains related to site. + + Required scope | `sites:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Domains] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/custom_domains", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Domains, + parse_obj_as( + type_=Domains, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def publish( + self, + site_id: str, + *, + custom_domains: typing.Optional[typing.Sequence[str]] = OMIT, + publish_to_webflow_subdomain: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[SitesPublishResponse]: + """ + Publishes a site to one or more more domains. + + To publish to a specific custom domain, use the domain IDs from the [Get Custom Domains](/data/reference/sites/get-custom-domain) endpoint. + + This endpoint has a specific rate limit of one successful publish queue per minute. + + Required scope | `sites:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + custom_domains : typing.Optional[typing.Sequence[str]] + Array of Custom Domain IDs to publish + + publish_to_webflow_subdomain : typing.Optional[bool] + Choice of whether to publish to the default Webflow Subdomain + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[SitesPublishResponse] + Request accepted + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/publish", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "customDomains": custom_domains, + "publishToWebflowSubdomain": publish_to_webflow_subdomain, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SitesPublishResponse, + parse_obj_as( + type_=SitesPublishResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawSitesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def create( + self, + workspace_id: str, + *, + name: str, + template_name: typing.Optional[str] = OMIT, + parent_folder_id: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[Site]: + """ + Create a site. + + This endpoint requires an Enterprise workspace. + + Required scope | `workspace:write` + + Parameters + ---------- + workspace_id : str + Unique identifier for a Workspace + + name : str + The name of the site + + template_name : typing.Optional[str] + The workspace or marketplace template to use + + parent_folder_id : typing.Optional[str] + MegaDodo Publications - Potential Book Ideas + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Site] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"workspaces/{jsonable_encoder(workspace_id)}/sites", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "name": name, + "templateName": template_name, + "parentFolderId": parent_folder_id, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Site, + parse_obj_as( + type_=Site, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def list(self, *, request_options: typing.Optional[RequestOptions] = None) -> AsyncHttpResponse[Sites]: + """ + List of all sites the provided access token is able to access. + + Required scope | `sites:read` + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Sites] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + "sites", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Sites, + parse_obj_as( + type_=Sites, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def get( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[Site]: + """ + Get details of a site. + + Required scope | `sites:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Site] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Site, + parse_obj_as( + type_=Site, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def delete( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[None]: + """ + Delete a site. + + This endpoint requires an Enterprise workspace. + + Required scope | `sites:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[None] + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return AsyncHttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def update( + self, + site_id: str, + *, + name: typing.Optional[str] = OMIT, + parent_folder_id: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[Site]: + """ + Update a site. + + This endpoint requires an Enterprise workspace. + + Required scope | `sites:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + name : typing.Optional[str] + The name of the site + + parent_folder_id : typing.Optional[str] + The parent folder ID of the site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Site] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + json={ + "name": name, + "parentFolderId": parent_folder_id, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Site, + parse_obj_as( + type_=Site, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def get_custom_domain( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[Domains]: + """ + Get a list of all custom domains related to site. + + Required scope | `sites:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Domains] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/custom_domains", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Domains, + parse_obj_as( + type_=Domains, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def publish( + self, + site_id: str, + *, + custom_domains: typing.Optional[typing.Sequence[str]] = OMIT, + publish_to_webflow_subdomain: typing.Optional[bool] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[SitesPublishResponse]: + """ + Publishes a site to one or more more domains. + + To publish to a specific custom domain, use the domain IDs from the [Get Custom Domains](/data/reference/sites/get-custom-domain) endpoint. + + This endpoint has a specific rate limit of one successful publish queue per minute. + + Required scope | `sites:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + custom_domains : typing.Optional[typing.Sequence[str]] + Array of Custom Domain IDs to publish + + publish_to_webflow_subdomain : typing.Optional[bool] + Choice of whether to publish to the default Webflow Subdomain + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[SitesPublishResponse] + Request accepted + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/publish", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "customDomains": custom_domains, + "publishToWebflowSubdomain": publish_to_webflow_subdomain, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SitesPublishResponse, + parse_obj_as( + type_=SitesPublishResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/sites/resources/__init__.py b/src/webflow/resources/sites/resources/__init__.py index 1197a83..529b1de 100644 --- a/src/webflow/resources/sites/resources/__init__.py +++ b/src/webflow/resources/sites/resources/__init__.py @@ -1,5 +1,75 @@ # This file was auto-generated by Fern from our API Definition. -from . import activity_logs, plans, redirects, scripts +# isort: skip_file -__all__ = ["activity_logs", "plans", "redirects", "scripts"] +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from . import activity_logs, comments, forms, plans, redirects, robots_txt, scripts, well_known + from .comments import ( + CommentsGetCommentThreadRequestSortBy, + CommentsGetCommentThreadRequestSortOrder, + CommentsListCommentRepliesRequestSortBy, + CommentsListCommentRepliesRequestSortOrder, + CommentsListCommentThreadsRequestSortBy, + CommentsListCommentThreadsRequestSortOrder, + ) + from .well_known import WellKnownFileContentType +_dynamic_imports: typing.Dict[str, str] = { + "CommentsGetCommentThreadRequestSortBy": ".comments", + "CommentsGetCommentThreadRequestSortOrder": ".comments", + "CommentsListCommentRepliesRequestSortBy": ".comments", + "CommentsListCommentRepliesRequestSortOrder": ".comments", + "CommentsListCommentThreadsRequestSortBy": ".comments", + "CommentsListCommentThreadsRequestSortOrder": ".comments", + "WellKnownFileContentType": ".well_known", + "activity_logs": ".activity_logs", + "comments": ".comments", + "forms": ".forms", + "plans": ".plans", + "redirects": ".redirects", + "robots_txt": ".robots_txt", + "scripts": ".scripts", + "well_known": ".well_known", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + + +__all__ = [ + "CommentsGetCommentThreadRequestSortBy", + "CommentsGetCommentThreadRequestSortOrder", + "CommentsListCommentRepliesRequestSortBy", + "CommentsListCommentRepliesRequestSortOrder", + "CommentsListCommentThreadsRequestSortBy", + "CommentsListCommentThreadsRequestSortOrder", + "WellKnownFileContentType", + "activity_logs", + "comments", + "forms", + "plans", + "redirects", + "robots_txt", + "scripts", + "well_known", +] diff --git a/src/webflow/resources/sites/resources/activity_logs/__init__.py b/src/webflow/resources/sites/resources/activity_logs/__init__.py index f3ea265..5cde020 100644 --- a/src/webflow/resources/sites/resources/activity_logs/__init__.py +++ b/src/webflow/resources/sites/resources/activity_logs/__init__.py @@ -1,2 +1,4 @@ # This file was auto-generated by Fern from our API Definition. +# isort: skip_file + diff --git a/src/webflow/resources/sites/resources/activity_logs/client.py b/src/webflow/resources/sites/resources/activity_logs/client.py index cf4e1b3..1e999f7 100644 --- a/src/webflow/resources/sites/resources/activity_logs/client.py +++ b/src/webflow/resources/sites/resources/activity_logs/client.py @@ -1,45 +1,52 @@ # This file was auto-generated by Fern from our API Definition. -from .....core.client_wrapper import SyncClientWrapper import typing + +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from .....core.request_options import RequestOptions from .....types.site_activity_log_response import SiteActivityLogResponse -from .....core.jsonable_encoder import jsonable_encoder -from .....core.pydantic_utilities import parse_obj_as -from .....errors.forbidden_error import ForbiddenError -from .....errors.not_found_error import NotFoundError -from .....types.error import Error -from .....errors.too_many_requests_error import TooManyRequestsError -from .....errors.internal_server_error import InternalServerError -from json.decoder import JSONDecodeError -from .....core.api_error import ApiError -from .....core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawActivityLogsClient, RawActivityLogsClient class ActivityLogsClient: def __init__(self, *, client_wrapper: SyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = RawActivityLogsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawActivityLogsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawActivityLogsClient + """ + return self._raw_client def list( self, site_id: str, *, - limit: typing.Optional[float] = None, - offset: typing.Optional[float] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> SiteActivityLogResponse: """ - Retrieve Activity Logs for a specific Site. Requires Site to be on an Enterprise plan.

Required scope | `site_activity:read` + Retrieve Activity Logs for a specific Site. + + This endpoint requires an Enterprise workspace. + + Required scope: `site_activity:read` Parameters ---------- site_id : str Unique identifier for a Site - limit : typing.Optional[float] + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records request_options : typing.Optional[RequestOptions] @@ -59,96 +66,53 @@ def list( ) client.sites.activity_logs.list( site_id="580e63e98c9a982ac9b8b741", + limit=1, + offset=1, ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/activity_logs", - method="GET", - params={ - "limit": limit, - "offset": offset, - }, - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - SiteActivityLogResponse, - parse_obj_as( - type_=SiteActivityLogResponse, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.list(site_id, limit=limit, offset=offset, request_options=request_options) + return _response.data class AsyncActivityLogsClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = AsyncRawActivityLogsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawActivityLogsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawActivityLogsClient + """ + return self._raw_client async def list( self, site_id: str, *, - limit: typing.Optional[float] = None, - offset: typing.Optional[float] = None, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> SiteActivityLogResponse: """ - Retrieve Activity Logs for a specific Site. Requires Site to be on an Enterprise plan.

Required scope | `site_activity:read` + Retrieve Activity Logs for a specific Site. + + This endpoint requires an Enterprise workspace. + + Required scope: `site_activity:read` Parameters ---------- site_id : str Unique identifier for a Site - limit : typing.Optional[float] + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records request_options : typing.Optional[RequestOptions] @@ -173,70 +137,12 @@ async def list( async def main() -> None: await client.sites.activity_logs.list( site_id="580e63e98c9a982ac9b8b741", + limit=1, + offset=1, ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/activity_logs", - method="GET", - params={ - "limit": limit, - "offset": offset, - }, - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - SiteActivityLogResponse, - parse_obj_as( - type_=SiteActivityLogResponse, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.list(site_id, limit=limit, offset=offset, request_options=request_options) + return _response.data diff --git a/src/webflow/resources/sites/resources/activity_logs/raw_client.py b/src/webflow/resources/sites/resources/activity_logs/raw_client.py new file mode 100644 index 0000000..4c6453a --- /dev/null +++ b/src/webflow/resources/sites/resources/activity_logs/raw_client.py @@ -0,0 +1,243 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from .....core.api_error import ApiError +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from .....core.http_response import AsyncHttpResponse, HttpResponse +from .....core.jsonable_encoder import jsonable_encoder +from .....core.parse_error import ParsingError +from .....core.pydantic_utilities import parse_obj_as +from .....core.request_options import RequestOptions +from .....errors.forbidden_error import ForbiddenError +from .....errors.internal_server_error import InternalServerError +from .....errors.not_found_error import NotFoundError +from .....errors.too_many_requests_error import TooManyRequestsError +from .....types.error import Error +from .....types.site_activity_log_response import SiteActivityLogResponse +from pydantic import ValidationError + + +class RawActivityLogsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def list( + self, + site_id: str, + *, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[SiteActivityLogResponse]: + """ + Retrieve Activity Logs for a specific Site. + + This endpoint requires an Enterprise workspace. + + Required scope: `site_activity:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[SiteActivityLogResponse] + A list of site activity logs + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/activity_logs", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "limit": limit, + "offset": offset, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SiteActivityLogResponse, + parse_obj_as( + type_=SiteActivityLogResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawActivityLogsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def list( + self, + site_id: str, + *, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[SiteActivityLogResponse]: + """ + Retrieve Activity Logs for a specific Site. + + This endpoint requires an Enterprise workspace. + + Required scope: `site_activity:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[SiteActivityLogResponse] + A list of site activity logs + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/activity_logs", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "limit": limit, + "offset": offset, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SiteActivityLogResponse, + parse_obj_as( + type_=SiteActivityLogResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/sites/resources/comments/__init__.py b/src/webflow/resources/sites/resources/comments/__init__.py new file mode 100644 index 0000000..91af2b0 --- /dev/null +++ b/src/webflow/resources/sites/resources/comments/__init__.py @@ -0,0 +1,55 @@ +# This file was auto-generated by Fern from our API Definition. + +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .types import ( + CommentsGetCommentThreadRequestSortBy, + CommentsGetCommentThreadRequestSortOrder, + CommentsListCommentRepliesRequestSortBy, + CommentsListCommentRepliesRequestSortOrder, + CommentsListCommentThreadsRequestSortBy, + CommentsListCommentThreadsRequestSortOrder, + ) +_dynamic_imports: typing.Dict[str, str] = { + "CommentsGetCommentThreadRequestSortBy": ".types", + "CommentsGetCommentThreadRequestSortOrder": ".types", + "CommentsListCommentRepliesRequestSortBy": ".types", + "CommentsListCommentRepliesRequestSortOrder": ".types", + "CommentsListCommentThreadsRequestSortBy": ".types", + "CommentsListCommentThreadsRequestSortOrder": ".types", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + + +__all__ = [ + "CommentsGetCommentThreadRequestSortBy", + "CommentsGetCommentThreadRequestSortOrder", + "CommentsListCommentRepliesRequestSortBy", + "CommentsListCommentRepliesRequestSortOrder", + "CommentsListCommentThreadsRequestSortBy", + "CommentsListCommentThreadsRequestSortOrder", +] diff --git a/src/webflow/resources/sites/resources/comments/client.py b/src/webflow/resources/sites/resources/comments/client.py new file mode 100644 index 0000000..8fbae1e --- /dev/null +++ b/src/webflow/resources/sites/resources/comments/client.py @@ -0,0 +1,558 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from .....core.request_options import RequestOptions +from .....types.comment_reply_list import CommentReplyList +from .....types.comment_thread import CommentThread +from .....types.comment_thread_list import CommentThreadList +from .raw_client import AsyncRawCommentsClient, RawCommentsClient +from .types.comments_get_comment_thread_request_sort_by import CommentsGetCommentThreadRequestSortBy +from .types.comments_get_comment_thread_request_sort_order import CommentsGetCommentThreadRequestSortOrder +from .types.comments_list_comment_replies_request_sort_by import CommentsListCommentRepliesRequestSortBy +from .types.comments_list_comment_replies_request_sort_order import CommentsListCommentRepliesRequestSortOrder +from .types.comments_list_comment_threads_request_sort_by import CommentsListCommentThreadsRequestSortBy +from .types.comments_list_comment_threads_request_sort_order import CommentsListCommentThreadsRequestSortOrder + + +class CommentsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawCommentsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawCommentsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawCommentsClient + """ + return self._raw_client + + def list_comment_threads( + self, + site_id: str, + *, + locale_id: typing.Optional[str] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + sort_by: typing.Optional[CommentsListCommentThreadsRequestSortBy] = None, + sort_order: typing.Optional[CommentsListCommentThreadsRequestSortOrder] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> CommentThreadList: + """ + List all comment threads for a site. + + + There may be a delay of up to 5 minutes before new comments appear in the system. + + + Required scope | `comments:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + sort_by : typing.Optional[CommentsListCommentThreadsRequestSortBy] + Sort results by the provided value. Only allowed when sortOrder is provided. + + sort_order : typing.Optional[CommentsListCommentThreadsRequestSortOrder] + Sorts the results by asc or desc + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CommentThreadList + Request was successful + + Examples + -------- + from webflow import Webflow + + client = Webflow( + access_token="YOUR_ACCESS_TOKEN", + ) + client.sites.comments.list_comment_threads( + site_id="580e63e98c9a982ac9b8b741", + locale_id="65427cf400e02b306eaa04a0", + offset=1, + limit=1, + sort_by="createdOn", + sort_order="asc", + ) + """ + _response = self._raw_client.list_comment_threads( + site_id, + locale_id=locale_id, + offset=offset, + limit=limit, + sort_by=sort_by, + sort_order=sort_order, + request_options=request_options, + ) + return _response.data + + def get_comment_thread( + self, + site_id: str, + comment_thread_id: str, + *, + locale_id: typing.Optional[str] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + sort_by: typing.Optional[CommentsGetCommentThreadRequestSortBy] = None, + sort_order: typing.Optional[CommentsGetCommentThreadRequestSortOrder] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> CommentThread: + """ + Get details of a specific comment thread. + + + There may be a delay of up to 5 minutes before new comments appear in the system. + + + Required scope | `comments:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + comment_thread_id : str + Unique identifier for a Comment Thread + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + sort_by : typing.Optional[CommentsGetCommentThreadRequestSortBy] + Sort results by the provided value. Only allowed when sortOrder is provided. + + sort_order : typing.Optional[CommentsGetCommentThreadRequestSortOrder] + Sorts the results by asc or desc + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CommentThread + Request was successful + + Examples + -------- + from webflow import Webflow + + client = Webflow( + access_token="YOUR_ACCESS_TOKEN", + ) + client.sites.comments.get_comment_thread( + site_id="580e63e98c9a982ac9b8b741", + comment_thread_id="580e63e98c9a982ac9b8b741", + locale_id="65427cf400e02b306eaa04a0", + offset=1, + limit=1, + sort_by="createdOn", + sort_order="asc", + ) + """ + _response = self._raw_client.get_comment_thread( + site_id, + comment_thread_id, + locale_id=locale_id, + offset=offset, + limit=limit, + sort_by=sort_by, + sort_order=sort_order, + request_options=request_options, + ) + return _response.data + + def list_comment_replies( + self, + site_id: str, + comment_thread_id: str, + *, + locale_id: typing.Optional[str] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + sort_by: typing.Optional[CommentsListCommentRepliesRequestSortBy] = None, + sort_order: typing.Optional[CommentsListCommentRepliesRequestSortOrder] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> CommentReplyList: + """ + List all replies to a specific comment thread. + + + There may be a delay of up to 5 minutes before new comments appear in the system. + + + Required scope | `comments:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + comment_thread_id : str + Unique identifier for a Comment Thread + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + sort_by : typing.Optional[CommentsListCommentRepliesRequestSortBy] + Sort results by the provided value. Only allowed when sortOrder is provided. + + sort_order : typing.Optional[CommentsListCommentRepliesRequestSortOrder] + Sorts the results by asc or desc + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CommentReplyList + Request was successful + + Examples + -------- + from webflow import Webflow + + client = Webflow( + access_token="YOUR_ACCESS_TOKEN", + ) + client.sites.comments.list_comment_replies( + site_id="580e63e98c9a982ac9b8b741", + comment_thread_id="580e63e98c9a982ac9b8b741", + locale_id="65427cf400e02b306eaa04a0", + offset=1, + limit=1, + sort_by="createdOn", + sort_order="asc", + ) + """ + _response = self._raw_client.list_comment_replies( + site_id, + comment_thread_id, + locale_id=locale_id, + offset=offset, + limit=limit, + sort_by=sort_by, + sort_order=sort_order, + request_options=request_options, + ) + return _response.data + + +class AsyncCommentsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawCommentsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawCommentsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawCommentsClient + """ + return self._raw_client + + async def list_comment_threads( + self, + site_id: str, + *, + locale_id: typing.Optional[str] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + sort_by: typing.Optional[CommentsListCommentThreadsRequestSortBy] = None, + sort_order: typing.Optional[CommentsListCommentThreadsRequestSortOrder] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> CommentThreadList: + """ + List all comment threads for a site. + + + There may be a delay of up to 5 minutes before new comments appear in the system. + + + Required scope | `comments:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + sort_by : typing.Optional[CommentsListCommentThreadsRequestSortBy] + Sort results by the provided value. Only allowed when sortOrder is provided. + + sort_order : typing.Optional[CommentsListCommentThreadsRequestSortOrder] + Sorts the results by asc or desc + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CommentThreadList + Request was successful + + Examples + -------- + import asyncio + + from webflow import AsyncWebflow + + client = AsyncWebflow( + access_token="YOUR_ACCESS_TOKEN", + ) + + + async def main() -> None: + await client.sites.comments.list_comment_threads( + site_id="580e63e98c9a982ac9b8b741", + locale_id="65427cf400e02b306eaa04a0", + offset=1, + limit=1, + sort_by="createdOn", + sort_order="asc", + ) + + + asyncio.run(main()) + """ + _response = await self._raw_client.list_comment_threads( + site_id, + locale_id=locale_id, + offset=offset, + limit=limit, + sort_by=sort_by, + sort_order=sort_order, + request_options=request_options, + ) + return _response.data + + async def get_comment_thread( + self, + site_id: str, + comment_thread_id: str, + *, + locale_id: typing.Optional[str] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + sort_by: typing.Optional[CommentsGetCommentThreadRequestSortBy] = None, + sort_order: typing.Optional[CommentsGetCommentThreadRequestSortOrder] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> CommentThread: + """ + Get details of a specific comment thread. + + + There may be a delay of up to 5 minutes before new comments appear in the system. + + + Required scope | `comments:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + comment_thread_id : str + Unique identifier for a Comment Thread + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + sort_by : typing.Optional[CommentsGetCommentThreadRequestSortBy] + Sort results by the provided value. Only allowed when sortOrder is provided. + + sort_order : typing.Optional[CommentsGetCommentThreadRequestSortOrder] + Sorts the results by asc or desc + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CommentThread + Request was successful + + Examples + -------- + import asyncio + + from webflow import AsyncWebflow + + client = AsyncWebflow( + access_token="YOUR_ACCESS_TOKEN", + ) + + + async def main() -> None: + await client.sites.comments.get_comment_thread( + site_id="580e63e98c9a982ac9b8b741", + comment_thread_id="580e63e98c9a982ac9b8b741", + locale_id="65427cf400e02b306eaa04a0", + offset=1, + limit=1, + sort_by="createdOn", + sort_order="asc", + ) + + + asyncio.run(main()) + """ + _response = await self._raw_client.get_comment_thread( + site_id, + comment_thread_id, + locale_id=locale_id, + offset=offset, + limit=limit, + sort_by=sort_by, + sort_order=sort_order, + request_options=request_options, + ) + return _response.data + + async def list_comment_replies( + self, + site_id: str, + comment_thread_id: str, + *, + locale_id: typing.Optional[str] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + sort_by: typing.Optional[CommentsListCommentRepliesRequestSortBy] = None, + sort_order: typing.Optional[CommentsListCommentRepliesRequestSortOrder] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> CommentReplyList: + """ + List all replies to a specific comment thread. + + + There may be a delay of up to 5 minutes before new comments appear in the system. + + + Required scope | `comments:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + comment_thread_id : str + Unique identifier for a Comment Thread + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + sort_by : typing.Optional[CommentsListCommentRepliesRequestSortBy] + Sort results by the provided value. Only allowed when sortOrder is provided. + + sort_order : typing.Optional[CommentsListCommentRepliesRequestSortOrder] + Sorts the results by asc or desc + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + CommentReplyList + Request was successful + + Examples + -------- + import asyncio + + from webflow import AsyncWebflow + + client = AsyncWebflow( + access_token="YOUR_ACCESS_TOKEN", + ) + + + async def main() -> None: + await client.sites.comments.list_comment_replies( + site_id="580e63e98c9a982ac9b8b741", + comment_thread_id="580e63e98c9a982ac9b8b741", + locale_id="65427cf400e02b306eaa04a0", + offset=1, + limit=1, + sort_by="createdOn", + sort_order="asc", + ) + + + asyncio.run(main()) + """ + _response = await self._raw_client.list_comment_replies( + site_id, + comment_thread_id, + locale_id=locale_id, + offset=offset, + limit=limit, + sort_by=sort_by, + sort_order=sort_order, + request_options=request_options, + ) + return _response.data diff --git a/src/webflow/resources/sites/resources/comments/raw_client.py b/src/webflow/resources/sites/resources/comments/raw_client.py new file mode 100644 index 0000000..9502f35 --- /dev/null +++ b/src/webflow/resources/sites/resources/comments/raw_client.py @@ -0,0 +1,876 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from .....core.api_error import ApiError +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from .....core.http_response import AsyncHttpResponse, HttpResponse +from .....core.jsonable_encoder import jsonable_encoder +from .....core.parse_error import ParsingError +from .....core.pydantic_utilities import parse_obj_as +from .....core.request_options import RequestOptions +from .....errors.bad_request_error import BadRequestError +from .....errors.internal_server_error import InternalServerError +from .....errors.not_found_error import NotFoundError +from .....errors.too_many_requests_error import TooManyRequestsError +from .....errors.unauthorized_error import UnauthorizedError +from .....types.comment_reply_list import CommentReplyList +from .....types.comment_thread import CommentThread +from .....types.comment_thread_list import CommentThreadList +from .....types.error import Error +from .types.comments_get_comment_thread_request_sort_by import CommentsGetCommentThreadRequestSortBy +from .types.comments_get_comment_thread_request_sort_order import CommentsGetCommentThreadRequestSortOrder +from .types.comments_list_comment_replies_request_sort_by import CommentsListCommentRepliesRequestSortBy +from .types.comments_list_comment_replies_request_sort_order import CommentsListCommentRepliesRequestSortOrder +from .types.comments_list_comment_threads_request_sort_by import CommentsListCommentThreadsRequestSortBy +from .types.comments_list_comment_threads_request_sort_order import CommentsListCommentThreadsRequestSortOrder +from pydantic import ValidationError + + +class RawCommentsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def list_comment_threads( + self, + site_id: str, + *, + locale_id: typing.Optional[str] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + sort_by: typing.Optional[CommentsListCommentThreadsRequestSortBy] = None, + sort_order: typing.Optional[CommentsListCommentThreadsRequestSortOrder] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CommentThreadList]: + """ + List all comment threads for a site. + + + There may be a delay of up to 5 minutes before new comments appear in the system. + + + Required scope | `comments:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + sort_by : typing.Optional[CommentsListCommentThreadsRequestSortBy] + Sort results by the provided value. Only allowed when sortOrder is provided. + + sort_order : typing.Optional[CommentsListCommentThreadsRequestSortOrder] + Sorts the results by asc or desc + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CommentThreadList] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/comments", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "localeId": locale_id, + "offset": offset, + "limit": limit, + "sortBy": sort_by, + "sortOrder": sort_order, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CommentThreadList, + parse_obj_as( + type_=CommentThreadList, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def get_comment_thread( + self, + site_id: str, + comment_thread_id: str, + *, + locale_id: typing.Optional[str] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + sort_by: typing.Optional[CommentsGetCommentThreadRequestSortBy] = None, + sort_order: typing.Optional[CommentsGetCommentThreadRequestSortOrder] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CommentThread]: + """ + Get details of a specific comment thread. + + + There may be a delay of up to 5 minutes before new comments appear in the system. + + + Required scope | `comments:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + comment_thread_id : str + Unique identifier for a Comment Thread + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + sort_by : typing.Optional[CommentsGetCommentThreadRequestSortBy] + Sort results by the provided value. Only allowed when sortOrder is provided. + + sort_order : typing.Optional[CommentsGetCommentThreadRequestSortOrder] + Sorts the results by asc or desc + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CommentThread] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/comments/{jsonable_encoder(comment_thread_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "localeId": locale_id, + "offset": offset, + "limit": limit, + "sortBy": sort_by, + "sortOrder": sort_order, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CommentThread, + parse_obj_as( + type_=CommentThread, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def list_comment_replies( + self, + site_id: str, + comment_thread_id: str, + *, + locale_id: typing.Optional[str] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + sort_by: typing.Optional[CommentsListCommentRepliesRequestSortBy] = None, + sort_order: typing.Optional[CommentsListCommentRepliesRequestSortOrder] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[CommentReplyList]: + """ + List all replies to a specific comment thread. + + + There may be a delay of up to 5 minutes before new comments appear in the system. + + + Required scope | `comments:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + comment_thread_id : str + Unique identifier for a Comment Thread + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + sort_by : typing.Optional[CommentsListCommentRepliesRequestSortBy] + Sort results by the provided value. Only allowed when sortOrder is provided. + + sort_order : typing.Optional[CommentsListCommentRepliesRequestSortOrder] + Sorts the results by asc or desc + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[CommentReplyList] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/comments/{jsonable_encoder(comment_thread_id)}/replies", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "localeId": locale_id, + "offset": offset, + "limit": limit, + "sortBy": sort_by, + "sortOrder": sort_order, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CommentReplyList, + parse_obj_as( + type_=CommentReplyList, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawCommentsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def list_comment_threads( + self, + site_id: str, + *, + locale_id: typing.Optional[str] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + sort_by: typing.Optional[CommentsListCommentThreadsRequestSortBy] = None, + sort_order: typing.Optional[CommentsListCommentThreadsRequestSortOrder] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CommentThreadList]: + """ + List all comment threads for a site. + + + There may be a delay of up to 5 minutes before new comments appear in the system. + + + Required scope | `comments:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + sort_by : typing.Optional[CommentsListCommentThreadsRequestSortBy] + Sort results by the provided value. Only allowed when sortOrder is provided. + + sort_order : typing.Optional[CommentsListCommentThreadsRequestSortOrder] + Sorts the results by asc or desc + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CommentThreadList] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/comments", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "localeId": locale_id, + "offset": offset, + "limit": limit, + "sortBy": sort_by, + "sortOrder": sort_order, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CommentThreadList, + parse_obj_as( + type_=CommentThreadList, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def get_comment_thread( + self, + site_id: str, + comment_thread_id: str, + *, + locale_id: typing.Optional[str] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + sort_by: typing.Optional[CommentsGetCommentThreadRequestSortBy] = None, + sort_order: typing.Optional[CommentsGetCommentThreadRequestSortOrder] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CommentThread]: + """ + Get details of a specific comment thread. + + + There may be a delay of up to 5 minutes before new comments appear in the system. + + + Required scope | `comments:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + comment_thread_id : str + Unique identifier for a Comment Thread + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + sort_by : typing.Optional[CommentsGetCommentThreadRequestSortBy] + Sort results by the provided value. Only allowed when sortOrder is provided. + + sort_order : typing.Optional[CommentsGetCommentThreadRequestSortOrder] + Sorts the results by asc or desc + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CommentThread] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/comments/{jsonable_encoder(comment_thread_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "localeId": locale_id, + "offset": offset, + "limit": limit, + "sortBy": sort_by, + "sortOrder": sort_order, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CommentThread, + parse_obj_as( + type_=CommentThread, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def list_comment_replies( + self, + site_id: str, + comment_thread_id: str, + *, + locale_id: typing.Optional[str] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + sort_by: typing.Optional[CommentsListCommentRepliesRequestSortBy] = None, + sort_order: typing.Optional[CommentsListCommentRepliesRequestSortOrder] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[CommentReplyList]: + """ + List all replies to a specific comment thread. + + + There may be a delay of up to 5 minutes before new comments appear in the system. + + + Required scope | `comments:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + comment_thread_id : str + Unique identifier for a Comment Thread + + locale_id : typing.Optional[str] + Unique identifier for a specific Locale. + + [Lear more about localization.](/data/v2.0.0/docs/working-with-localization) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + sort_by : typing.Optional[CommentsListCommentRepliesRequestSortBy] + Sort results by the provided value. Only allowed when sortOrder is provided. + + sort_order : typing.Optional[CommentsListCommentRepliesRequestSortOrder] + Sorts the results by asc or desc + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[CommentReplyList] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/comments/{jsonable_encoder(comment_thread_id)}/replies", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "localeId": locale_id, + "offset": offset, + "limit": limit, + "sortBy": sort_by, + "sortOrder": sort_order, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + CommentReplyList, + parse_obj_as( + type_=CommentReplyList, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/sites/resources/comments/types/__init__.py b/src/webflow/resources/sites/resources/comments/types/__init__.py new file mode 100644 index 0000000..47e7b8b --- /dev/null +++ b/src/webflow/resources/sites/resources/comments/types/__init__.py @@ -0,0 +1,53 @@ +# This file was auto-generated by Fern from our API Definition. + +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .comments_get_comment_thread_request_sort_by import CommentsGetCommentThreadRequestSortBy + from .comments_get_comment_thread_request_sort_order import CommentsGetCommentThreadRequestSortOrder + from .comments_list_comment_replies_request_sort_by import CommentsListCommentRepliesRequestSortBy + from .comments_list_comment_replies_request_sort_order import CommentsListCommentRepliesRequestSortOrder + from .comments_list_comment_threads_request_sort_by import CommentsListCommentThreadsRequestSortBy + from .comments_list_comment_threads_request_sort_order import CommentsListCommentThreadsRequestSortOrder +_dynamic_imports: typing.Dict[str, str] = { + "CommentsGetCommentThreadRequestSortBy": ".comments_get_comment_thread_request_sort_by", + "CommentsGetCommentThreadRequestSortOrder": ".comments_get_comment_thread_request_sort_order", + "CommentsListCommentRepliesRequestSortBy": ".comments_list_comment_replies_request_sort_by", + "CommentsListCommentRepliesRequestSortOrder": ".comments_list_comment_replies_request_sort_order", + "CommentsListCommentThreadsRequestSortBy": ".comments_list_comment_threads_request_sort_by", + "CommentsListCommentThreadsRequestSortOrder": ".comments_list_comment_threads_request_sort_order", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + + +__all__ = [ + "CommentsGetCommentThreadRequestSortBy", + "CommentsGetCommentThreadRequestSortOrder", + "CommentsListCommentRepliesRequestSortBy", + "CommentsListCommentRepliesRequestSortOrder", + "CommentsListCommentThreadsRequestSortBy", + "CommentsListCommentThreadsRequestSortOrder", +] diff --git a/src/webflow/resources/sites/resources/comments/types/comments_get_comment_thread_request_sort_by.py b/src/webflow/resources/sites/resources/comments/types/comments_get_comment_thread_request_sort_by.py new file mode 100644 index 0000000..14daabb --- /dev/null +++ b/src/webflow/resources/sites/resources/comments/types/comments_get_comment_thread_request_sort_by.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CommentsGetCommentThreadRequestSortBy = typing.Union[typing.Literal["createdOn", "lastUpdated"], typing.Any] diff --git a/src/webflow/resources/sites/resources/comments/types/comments_get_comment_thread_request_sort_order.py b/src/webflow/resources/sites/resources/comments/types/comments_get_comment_thread_request_sort_order.py new file mode 100644 index 0000000..3da3ffc --- /dev/null +++ b/src/webflow/resources/sites/resources/comments/types/comments_get_comment_thread_request_sort_order.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CommentsGetCommentThreadRequestSortOrder = typing.Union[typing.Literal["asc", "desc"], typing.Any] diff --git a/src/webflow/resources/sites/resources/comments/types/comments_list_comment_replies_request_sort_by.py b/src/webflow/resources/sites/resources/comments/types/comments_list_comment_replies_request_sort_by.py new file mode 100644 index 0000000..67fcb98 --- /dev/null +++ b/src/webflow/resources/sites/resources/comments/types/comments_list_comment_replies_request_sort_by.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CommentsListCommentRepliesRequestSortBy = typing.Union[typing.Literal["createdOn", "lastUpdated"], typing.Any] diff --git a/src/webflow/resources/sites/resources/comments/types/comments_list_comment_replies_request_sort_order.py b/src/webflow/resources/sites/resources/comments/types/comments_list_comment_replies_request_sort_order.py new file mode 100644 index 0000000..03c42c3 --- /dev/null +++ b/src/webflow/resources/sites/resources/comments/types/comments_list_comment_replies_request_sort_order.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CommentsListCommentRepliesRequestSortOrder = typing.Union[typing.Literal["asc", "desc"], typing.Any] diff --git a/src/webflow/resources/sites/resources/comments/types/comments_list_comment_threads_request_sort_by.py b/src/webflow/resources/sites/resources/comments/types/comments_list_comment_threads_request_sort_by.py new file mode 100644 index 0000000..1d541ce --- /dev/null +++ b/src/webflow/resources/sites/resources/comments/types/comments_list_comment_threads_request_sort_by.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CommentsListCommentThreadsRequestSortBy = typing.Union[typing.Literal["createdOn", "lastUpdated"], typing.Any] diff --git a/src/webflow/resources/sites/resources/comments/types/comments_list_comment_threads_request_sort_order.py b/src/webflow/resources/sites/resources/comments/types/comments_list_comment_threads_request_sort_order.py new file mode 100644 index 0000000..d2c2606 --- /dev/null +++ b/src/webflow/resources/sites/resources/comments/types/comments_list_comment_threads_request_sort_order.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CommentsListCommentThreadsRequestSortOrder = typing.Union[typing.Literal["asc", "desc"], typing.Any] diff --git a/tests/sites/__init__.py b/src/webflow/resources/sites/resources/forms/__init__.py similarity index 76% rename from tests/sites/__init__.py rename to src/webflow/resources/sites/resources/forms/__init__.py index f3ea265..5cde020 100644 --- a/tests/sites/__init__.py +++ b/src/webflow/resources/sites/resources/forms/__init__.py @@ -1,2 +1,4 @@ # This file was auto-generated by Fern from our API Definition. +# isort: skip_file + diff --git a/src/webflow/resources/sites/resources/forms/client.py b/src/webflow/resources/sites/resources/forms/client.py new file mode 100644 index 0000000..c165d82 --- /dev/null +++ b/src/webflow/resources/sites/resources/forms/client.py @@ -0,0 +1,578 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from .....core.request_options import RequestOptions +from .....types.form_submission import FormSubmission +from .....types.form_submission_list import FormSubmissionList +from .raw_client import AsyncRawFormsClient, RawFormsClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class FormsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawFormsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawFormsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawFormsClient + """ + return self._raw_client + + def list_submissions_by_site( + self, + site_id: str, + *, + element_id: typing.Optional[str] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> FormSubmissionList: + """ + List all form submissions for a given site with the ability to filter submissions by a centralized `elementId`. + + Add `elementId` when you want to filter form submissions to a specific form in a site. You can get the `elementId` from the [List forms endpoint](/data/reference/forms/forms/list) (displayed as `formElementId` in the response). + + + When a form is used in a Webflow component definition, each instance of the component will yield a unique form. Adding the `elementId` in this request ensures this API response includes all submissions from that core form, wherever that form is used in instantiated components. + + + Use the [List Form Submissions endpoint](/data/reference/forms/form-submissions/list-submissions) to list form submissions for a given form ID. + + Required scope | `forms:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + element_id : typing.Optional[str] + Identifier for an element + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + FormSubmissionList + Request was successful + + Examples + -------- + from webflow import Webflow + + client = Webflow( + access_token="YOUR_ACCESS_TOKEN", + ) + client.sites.forms.list_submissions_by_site( + site_id="580e63e98c9a982ac9b8b741", + element_id="18259716-3e5a-646a-5f41-5dc4b9405aa0", + offset=1, + limit=1, + ) + """ + _response = self._raw_client.list_submissions_by_site( + site_id, element_id=element_id, offset=offset, limit=limit, request_options=request_options + ) + return _response.data + + def list_submissions( + self, + site_id: str, + form_id: str, + *, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> FormSubmissionList: + """ + List form submissions for a given form ID within a specific site. + + Use the [List Form Submissions by Site endpoint](/data/reference/forms/form-submissions/list-submissions-by-site) to list form submissions for a given site with the ability to filter by a `formElementId`. + + Required scope | `forms:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + form_id : str + Unique identifier for a Form + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + FormSubmissionList + Request was successful + + Examples + -------- + from webflow import Webflow + + client = Webflow( + access_token="YOUR_ACCESS_TOKEN", + ) + client.sites.forms.list_submissions( + site_id="580e63e98c9a982ac9b8b741", + form_id="580e63e98c9a982ac9b8b741", + offset=1, + limit=1, + ) + """ + _response = self._raw_client.list_submissions( + site_id, form_id, offset=offset, limit=limit, request_options=request_options + ) + return _response.data + + def get_submission( + self, site_id: str, form_submission_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> FormSubmission: + """ + Get information about a form submission within a specific site. + + Required scope | `forms:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + form_submission_id : str + Unique identifier for a Form Submission + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + FormSubmission + Request was successful + + Examples + -------- + from webflow import Webflow + + client = Webflow( + access_token="YOUR_ACCESS_TOKEN", + ) + client.sites.forms.get_submission( + site_id="580e63e98c9a982ac9b8b741", + form_submission_id="580e63e98c9a982ac9b8b741", + ) + """ + _response = self._raw_client.get_submission(site_id, form_submission_id, request_options=request_options) + return _response.data + + def delete_submission( + self, site_id: str, form_submission_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> None: + """ + Delete a form submission within a specific site. + + Required scope | `forms:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + form_submission_id : str + Unique identifier for a Form Submission + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + None + + Examples + -------- + from webflow import Webflow + + client = Webflow( + access_token="YOUR_ACCESS_TOKEN", + ) + client.sites.forms.delete_submission( + site_id="580e63e98c9a982ac9b8b741", + form_submission_id="580e63e98c9a982ac9b8b741", + ) + """ + _response = self._raw_client.delete_submission(site_id, form_submission_id, request_options=request_options) + return _response.data + + def update_submission( + self, + site_id: str, + form_submission_id: str, + *, + form_submission_data: typing.Optional[typing.Dict[str, typing.Any]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> FormSubmission: + """ + Update hidden fields on a form submission within a specific site. + + Required scope | `forms:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + form_submission_id : str + Unique identifier for a Form Submission + + form_submission_data : typing.Optional[typing.Dict[str, typing.Any]] + An existing **hidden field** defined on the form schema, and the corresponding value to set + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + FormSubmission + Request was successful + + Examples + -------- + from webflow import Webflow + + client = Webflow( + access_token="YOUR_ACCESS_TOKEN", + ) + client.sites.forms.update_submission( + site_id="580e63e98c9a982ac9b8b741", + form_submission_id="580e63e98c9a982ac9b8b741", + ) + """ + _response = self._raw_client.update_submission( + site_id, form_submission_id, form_submission_data=form_submission_data, request_options=request_options + ) + return _response.data + + +class AsyncFormsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawFormsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawFormsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawFormsClient + """ + return self._raw_client + + async def list_submissions_by_site( + self, + site_id: str, + *, + element_id: typing.Optional[str] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> FormSubmissionList: + """ + List all form submissions for a given site with the ability to filter submissions by a centralized `elementId`. + + Add `elementId` when you want to filter form submissions to a specific form in a site. You can get the `elementId` from the [List forms endpoint](/data/reference/forms/forms/list) (displayed as `formElementId` in the response). + + + When a form is used in a Webflow component definition, each instance of the component will yield a unique form. Adding the `elementId` in this request ensures this API response includes all submissions from that core form, wherever that form is used in instantiated components. + + + Use the [List Form Submissions endpoint](/data/reference/forms/form-submissions/list-submissions) to list form submissions for a given form ID. + + Required scope | `forms:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + element_id : typing.Optional[str] + Identifier for an element + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + FormSubmissionList + Request was successful + + Examples + -------- + import asyncio + + from webflow import AsyncWebflow + + client = AsyncWebflow( + access_token="YOUR_ACCESS_TOKEN", + ) + + + async def main() -> None: + await client.sites.forms.list_submissions_by_site( + site_id="580e63e98c9a982ac9b8b741", + element_id="18259716-3e5a-646a-5f41-5dc4b9405aa0", + offset=1, + limit=1, + ) + + + asyncio.run(main()) + """ + _response = await self._raw_client.list_submissions_by_site( + site_id, element_id=element_id, offset=offset, limit=limit, request_options=request_options + ) + return _response.data + + async def list_submissions( + self, + site_id: str, + form_id: str, + *, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> FormSubmissionList: + """ + List form submissions for a given form ID within a specific site. + + Use the [List Form Submissions by Site endpoint](/data/reference/forms/form-submissions/list-submissions-by-site) to list form submissions for a given site with the ability to filter by a `formElementId`. + + Required scope | `forms:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + form_id : str + Unique identifier for a Form + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + FormSubmissionList + Request was successful + + Examples + -------- + import asyncio + + from webflow import AsyncWebflow + + client = AsyncWebflow( + access_token="YOUR_ACCESS_TOKEN", + ) + + + async def main() -> None: + await client.sites.forms.list_submissions( + site_id="580e63e98c9a982ac9b8b741", + form_id="580e63e98c9a982ac9b8b741", + offset=1, + limit=1, + ) + + + asyncio.run(main()) + """ + _response = await self._raw_client.list_submissions( + site_id, form_id, offset=offset, limit=limit, request_options=request_options + ) + return _response.data + + async def get_submission( + self, site_id: str, form_submission_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> FormSubmission: + """ + Get information about a form submission within a specific site. + + Required scope | `forms:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + form_submission_id : str + Unique identifier for a Form Submission + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + FormSubmission + Request was successful + + Examples + -------- + import asyncio + + from webflow import AsyncWebflow + + client = AsyncWebflow( + access_token="YOUR_ACCESS_TOKEN", + ) + + + async def main() -> None: + await client.sites.forms.get_submission( + site_id="580e63e98c9a982ac9b8b741", + form_submission_id="580e63e98c9a982ac9b8b741", + ) + + + asyncio.run(main()) + """ + _response = await self._raw_client.get_submission(site_id, form_submission_id, request_options=request_options) + return _response.data + + async def delete_submission( + self, site_id: str, form_submission_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> None: + """ + Delete a form submission within a specific site. + + Required scope | `forms:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + form_submission_id : str + Unique identifier for a Form Submission + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + None + + Examples + -------- + import asyncio + + from webflow import AsyncWebflow + + client = AsyncWebflow( + access_token="YOUR_ACCESS_TOKEN", + ) + + + async def main() -> None: + await client.sites.forms.delete_submission( + site_id="580e63e98c9a982ac9b8b741", + form_submission_id="580e63e98c9a982ac9b8b741", + ) + + + asyncio.run(main()) + """ + _response = await self._raw_client.delete_submission( + site_id, form_submission_id, request_options=request_options + ) + return _response.data + + async def update_submission( + self, + site_id: str, + form_submission_id: str, + *, + form_submission_data: typing.Optional[typing.Dict[str, typing.Any]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> FormSubmission: + """ + Update hidden fields on a form submission within a specific site. + + Required scope | `forms:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + form_submission_id : str + Unique identifier for a Form Submission + + form_submission_data : typing.Optional[typing.Dict[str, typing.Any]] + An existing **hidden field** defined on the form schema, and the corresponding value to set + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + FormSubmission + Request was successful + + Examples + -------- + import asyncio + + from webflow import AsyncWebflow + + client = AsyncWebflow( + access_token="YOUR_ACCESS_TOKEN", + ) + + + async def main() -> None: + await client.sites.forms.update_submission( + site_id="580e63e98c9a982ac9b8b741", + form_submission_id="580e63e98c9a982ac9b8b741", + ) + + + asyncio.run(main()) + """ + _response = await self._raw_client.update_submission( + site_id, form_submission_id, form_submission_data=form_submission_data, request_options=request_options + ) + return _response.data diff --git a/src/webflow/resources/sites/resources/forms/raw_client.py b/src/webflow/resources/sites/resources/forms/raw_client.py new file mode 100644 index 0000000..c295236 --- /dev/null +++ b/src/webflow/resources/sites/resources/forms/raw_client.py @@ -0,0 +1,1330 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from .....core.api_error import ApiError +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from .....core.http_response import AsyncHttpResponse, HttpResponse +from .....core.jsonable_encoder import jsonable_encoder +from .....core.parse_error import ParsingError +from .....core.pydantic_utilities import parse_obj_as +from .....core.request_options import RequestOptions +from .....errors.bad_request_error import BadRequestError +from .....errors.conflict_error import ConflictError +from .....errors.forbidden_error import ForbiddenError +from .....errors.internal_server_error import InternalServerError +from .....errors.not_found_error import NotFoundError +from .....errors.too_many_requests_error import TooManyRequestsError +from .....errors.unauthorized_error import UnauthorizedError +from .....types.error import Error +from .....types.form_submission import FormSubmission +from .....types.form_submission_list import FormSubmissionList +from pydantic import ValidationError + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawFormsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def list_submissions_by_site( + self, + site_id: str, + *, + element_id: typing.Optional[str] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[FormSubmissionList]: + """ + List all form submissions for a given site with the ability to filter submissions by a centralized `elementId`. + + Add `elementId` when you want to filter form submissions to a specific form in a site. You can get the `elementId` from the [List forms endpoint](/data/reference/forms/forms/list) (displayed as `formElementId` in the response). + + + When a form is used in a Webflow component definition, each instance of the component will yield a unique form. Adding the `elementId` in this request ensures this API response includes all submissions from that core form, wherever that form is used in instantiated components. + + + Use the [List Form Submissions endpoint](/data/reference/forms/form-submissions/list-submissions) to list form submissions for a given form ID. + + Required scope | `forms:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + element_id : typing.Optional[str] + Identifier for an element + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[FormSubmissionList] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/form_submissions", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "elementId": element_id, + "offset": offset, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + FormSubmissionList, + parse_obj_as( + type_=FormSubmissionList, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def list_submissions( + self, + site_id: str, + form_id: str, + *, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[FormSubmissionList]: + """ + List form submissions for a given form ID within a specific site. + + Use the [List Form Submissions by Site endpoint](/data/reference/forms/form-submissions/list-submissions-by-site) to list form submissions for a given site with the ability to filter by a `formElementId`. + + Required scope | `forms:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + form_id : str + Unique identifier for a Form + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[FormSubmissionList] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/forms/{jsonable_encoder(form_id)}/submissions", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "offset": offset, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + FormSubmissionList, + parse_obj_as( + type_=FormSubmissionList, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def get_submission( + self, site_id: str, form_submission_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[FormSubmission]: + """ + Get information about a form submission within a specific site. + + Required scope | `forms:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + form_submission_id : str + Unique identifier for a Form Submission + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[FormSubmission] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/form_submissions/{jsonable_encoder(form_submission_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + FormSubmission, + parse_obj_as( + type_=FormSubmission, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def delete_submission( + self, site_id: str, form_submission_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[None]: + """ + Delete a form submission within a specific site. + + Required scope | `forms:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + form_submission_id : str + Unique identifier for a Form Submission + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[None] + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/form_submissions/{jsonable_encoder(form_submission_id)}", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return HttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def update_submission( + self, + site_id: str, + form_submission_id: str, + *, + form_submission_data: typing.Optional[typing.Dict[str, typing.Any]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[FormSubmission]: + """ + Update hidden fields on a form submission within a specific site. + + Required scope | `forms:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + form_submission_id : str + Unique identifier for a Form Submission + + form_submission_data : typing.Optional[typing.Dict[str, typing.Any]] + An existing **hidden field** defined on the form schema, and the corresponding value to set + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[FormSubmission] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/form_submissions/{jsonable_encoder(form_submission_id)}", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + json={ + "formSubmissionData": form_submission_data, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + FormSubmission, + parse_obj_as( + type_=FormSubmission, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawFormsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def list_submissions_by_site( + self, + site_id: str, + *, + element_id: typing.Optional[str] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[FormSubmissionList]: + """ + List all form submissions for a given site with the ability to filter submissions by a centralized `elementId`. + + Add `elementId` when you want to filter form submissions to a specific form in a site. You can get the `elementId` from the [List forms endpoint](/data/reference/forms/forms/list) (displayed as `formElementId` in the response). + + + When a form is used in a Webflow component definition, each instance of the component will yield a unique form. Adding the `elementId` in this request ensures this API response includes all submissions from that core form, wherever that form is used in instantiated components. + + + Use the [List Form Submissions endpoint](/data/reference/forms/form-submissions/list-submissions) to list form submissions for a given form ID. + + Required scope | `forms:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + element_id : typing.Optional[str] + Identifier for an element + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[FormSubmissionList] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/form_submissions", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "elementId": element_id, + "offset": offset, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + FormSubmissionList, + parse_obj_as( + type_=FormSubmissionList, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def list_submissions( + self, + site_id: str, + form_id: str, + *, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[FormSubmissionList]: + """ + List form submissions for a given form ID within a specific site. + + Use the [List Form Submissions by Site endpoint](/data/reference/forms/form-submissions/list-submissions-by-site) to list form submissions for a given site with the ability to filter by a `formElementId`. + + Required scope | `forms:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + form_id : str + Unique identifier for a Form + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[FormSubmissionList] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/forms/{jsonable_encoder(form_id)}/submissions", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "offset": offset, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + FormSubmissionList, + parse_obj_as( + type_=FormSubmissionList, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def get_submission( + self, site_id: str, form_submission_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[FormSubmission]: + """ + Get information about a form submission within a specific site. + + Required scope | `forms:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + form_submission_id : str + Unique identifier for a Form Submission + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[FormSubmission] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/form_submissions/{jsonable_encoder(form_submission_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + FormSubmission, + parse_obj_as( + type_=FormSubmission, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def delete_submission( + self, site_id: str, form_submission_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[None]: + """ + Delete a form submission within a specific site. + + Required scope | `forms:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + form_submission_id : str + Unique identifier for a Form Submission + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[None] + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/form_submissions/{jsonable_encoder(form_submission_id)}", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return AsyncHttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def update_submission( + self, + site_id: str, + form_submission_id: str, + *, + form_submission_data: typing.Optional[typing.Dict[str, typing.Any]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[FormSubmission]: + """ + Update hidden fields on a form submission within a specific site. + + Required scope | `forms:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + form_submission_id : str + Unique identifier for a Form Submission + + form_submission_data : typing.Optional[typing.Dict[str, typing.Any]] + An existing **hidden field** defined on the form schema, and the corresponding value to set + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[FormSubmission] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/form_submissions/{jsonable_encoder(form_submission_id)}", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + json={ + "formSubmissionData": form_submission_data, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + FormSubmission, + parse_obj_as( + type_=FormSubmission, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 409: + raise ConflictError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/sites/resources/plans/__init__.py b/src/webflow/resources/sites/resources/plans/__init__.py index f3ea265..5cde020 100644 --- a/src/webflow/resources/sites/resources/plans/__init__.py +++ b/src/webflow/resources/sites/resources/plans/__init__.py @@ -1,2 +1,4 @@ # This file was auto-generated by Fern from our API Definition. +# isort: skip_file + diff --git a/src/webflow/resources/sites/resources/plans/client.py b/src/webflow/resources/sites/resources/plans/client.py index 291231a..b9b9d0a 100644 --- a/src/webflow/resources/sites/resources/plans/client.py +++ b/src/webflow/resources/sites/resources/plans/client.py @@ -1,30 +1,34 @@ # This file was auto-generated by Fern from our API Definition. -from .....core.client_wrapper import SyncClientWrapper import typing + +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from .....core.request_options import RequestOptions from .....types.site_plan import SitePlan -from .....core.jsonable_encoder import jsonable_encoder -from .....core.pydantic_utilities import parse_obj_as -from .....errors.bad_request_error import BadRequestError -from .....errors.unauthorized_error import UnauthorizedError -from .....types.error import Error -from .....errors.not_found_error import NotFoundError -from .....errors.too_many_requests_error import TooManyRequestsError -from .....errors.internal_server_error import InternalServerError -from json.decoder import JSONDecodeError -from .....core.api_error import ApiError -from .....core.client_wrapper import AsyncClientWrapper +from .raw_client import AsyncRawPlansClient, RawPlansClient class PlansClient: def __init__(self, *, client_wrapper: SyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = RawPlansClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawPlansClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawPlansClient + """ + return self._raw_client def get_site_plan(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> SitePlan: """ Get site plan details for the specified Site. + This endpoint requires an Enterprise workspace. + Required scope | `sites:read` Parameters @@ -51,84 +55,31 @@ def get_site_plan(self, site_id: str, *, request_options: typing.Optional[Reques site_id="580e63e98c9a982ac9b8b741", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/plan", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - SitePlan, - parse_obj_as( - type_=SitePlan, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.get_site_plan(site_id, request_options=request_options) + return _response.data class AsyncPlansClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = AsyncRawPlansClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawPlansClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawPlansClient + """ + return self._raw_client async def get_site_plan(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> SitePlan: """ Get site plan details for the specified Site. + This endpoint requires an Enterprise workspace. + Required scope | `sites:read` Parameters @@ -163,71 +114,5 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/plan", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - SitePlan, - parse_obj_as( - type_=SitePlan, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.get_site_plan(site_id, request_options=request_options) + return _response.data diff --git a/src/webflow/resources/sites/resources/plans/raw_client.py b/src/webflow/resources/sites/resources/plans/raw_client.py new file mode 100644 index 0000000..c6f7bad --- /dev/null +++ b/src/webflow/resources/sites/resources/plans/raw_client.py @@ -0,0 +1,236 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from .....core.api_error import ApiError +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from .....core.http_response import AsyncHttpResponse, HttpResponse +from .....core.jsonable_encoder import jsonable_encoder +from .....core.parse_error import ParsingError +from .....core.pydantic_utilities import parse_obj_as +from .....core.request_options import RequestOptions +from .....errors.bad_request_error import BadRequestError +from .....errors.internal_server_error import InternalServerError +from .....errors.not_found_error import NotFoundError +from .....errors.too_many_requests_error import TooManyRequestsError +from .....errors.unauthorized_error import UnauthorizedError +from .....types.error import Error +from .....types.site_plan import SitePlan +from pydantic import ValidationError + + +class RawPlansClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def get_site_plan( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[SitePlan]: + """ + Get site plan details for the specified Site. + + This endpoint requires an Enterprise workspace. + + Required scope | `sites:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[SitePlan] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/plan", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SitePlan, + parse_obj_as( + type_=SitePlan, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawPlansClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def get_site_plan( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[SitePlan]: + """ + Get site plan details for the specified Site. + + This endpoint requires an Enterprise workspace. + + Required scope | `sites:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[SitePlan] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/plan", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + SitePlan, + parse_obj_as( + type_=SitePlan, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/sites/resources/redirects/__init__.py b/src/webflow/resources/sites/resources/redirects/__init__.py index f3ea265..5cde020 100644 --- a/src/webflow/resources/sites/resources/redirects/__init__.py +++ b/src/webflow/resources/sites/resources/redirects/__init__.py @@ -1,2 +1,4 @@ # This file was auto-generated by Fern from our API Definition. +# isort: skip_file + diff --git a/src/webflow/resources/sites/resources/redirects/client.py b/src/webflow/resources/sites/resources/redirects/client.py index 4bc0e7b..c2e1f7d 100644 --- a/src/webflow/resources/sites/resources/redirects/client.py +++ b/src/webflow/resources/sites/resources/redirects/client.py @@ -1,21 +1,12 @@ # This file was auto-generated by Fern from our API Definition. import typing -from .....core.client_wrapper import SyncClientWrapper + +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from .....core.request_options import RequestOptions -from .....types.redirects import Redirects -from .....core.jsonable_encoder import jsonable_encoder -from .....core.pydantic_utilities import parse_obj_as -from .....errors.bad_request_error import BadRequestError -from .....errors.unauthorized_error import UnauthorizedError -from .....types.error import Error -from .....errors.not_found_error import NotFoundError -from .....errors.too_many_requests_error import TooManyRequestsError -from .....errors.internal_server_error import InternalServerError -from json.decoder import JSONDecodeError -from .....core.api_error import ApiError from .....types.redirect import Redirect -from .....core.client_wrapper import AsyncClientWrapper +from .....types.redirects import Redirects +from .raw_client import AsyncRawRedirectsClient, RawRedirectsClient # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) @@ -23,14 +14,26 @@ class RedirectsClient: def __init__(self, *, client_wrapper: SyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = RawRedirectsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawRedirectsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawRedirectsClient + """ + return self._raw_client def list(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Redirects: """ - Fetch a list of all URL redirect rules configured for a specific site. + Fetch a list of all 301 redirect rules configured for a specific site. Use this endpoint to review, audit, or manage the redirection rules that control how traffic is rerouted on your site. + This endpoint requires an Enterprise workspace. Required scope: `sites:read` @@ -58,74 +61,8 @@ def list(self, site_id: str, *, request_options: typing.Optional[RequestOptions] site_id="580e63e98c9a982ac9b8b741", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/redirects", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Redirects, - parse_obj_as( - type_=Redirects, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.list(site_id, request_options=request_options) + return _response.data def create( self, @@ -137,10 +74,12 @@ def create( request_options: typing.Optional[RequestOptions] = None, ) -> Redirect: """ - Add a new URL redirection rule to a site. + Add a new 301 redirection rule to a site. This endpoint allows you to define a source path (`fromUrl`) and its corresponding destination path (`toUrl`), which will dictate how traffic is rerouted on your site. This is useful for managing site changes, restructuring URLs, or handling outdated links. + This endpoint requires an Enterprise workspace. + Required scope: `sites:write` Parameters @@ -179,87 +118,21 @@ def create( to_url="/earth", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/redirects", - method="POST", - json={ - "id": id, - "fromUrl": from_url, - "toUrl": to_url, - }, - request_options=request_options, - omit=OMIT, + _response = self._raw_client.create( + site_id, id=id, from_url=from_url, to_url=to_url, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Redirect, - parse_obj_as( - type_=Redirect, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def delete( self, site_id: str, redirect_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> Redirects: """ - Remove a URL redirection rule from a site. + Remove a 301 redirection rule from a site. + This is useful for cleaning up outdated or unnecessary redirects, ensuring that your site's routing behavior remains efficient and up-to-date. + + This endpoint requires an Enterprise workspace. + Required scope: `sites:write` Parameters @@ -268,7 +141,7 @@ def delete( Unique identifier for a Site redirect_id : str - Unique identifier site rediect + Unique identifier site redirect request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -290,74 +163,8 @@ def delete( redirect_id="66c4cb9a20cac35ed19500e6", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/redirects/{jsonable_encoder(redirect_id)}", - method="DELETE", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Redirects, - parse_obj_as( - type_=Redirects, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.delete(site_id, redirect_id, request_options=request_options) + return _response.data def update( self, @@ -370,7 +177,10 @@ def update( request_options: typing.Optional[RequestOptions] = None, ) -> Redirect: """ - Update a URL redirection rule from a site. + Update a 301 redirection rule from a site. + + This endpoint requires an Enterprise workspace. + Required scope: `sites:write` Parameters @@ -379,7 +189,7 @@ def update( Unique identifier for a Site redirect_id : str - Unique identifier site rediect + Unique identifier site redirect id : typing.Optional[str] The ID of the specific redirect rule @@ -413,92 +223,34 @@ def update( to_url="/earth", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/redirects/{jsonable_encoder(redirect_id)}", - method="PATCH", - json={ - "id": id, - "fromUrl": from_url, - "toUrl": to_url, - }, - request_options=request_options, - omit=OMIT, + _response = self._raw_client.update( + site_id, redirect_id, id=id, from_url=from_url, to_url=to_url, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Redirect, - parse_obj_as( - type_=Redirect, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data class AsyncRedirectsClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = AsyncRawRedirectsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawRedirectsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawRedirectsClient + """ + return self._raw_client async def list(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Redirects: """ - Fetch a list of all URL redirect rules configured for a specific site. + Fetch a list of all 301 redirect rules configured for a specific site. Use this endpoint to review, audit, or manage the redirection rules that control how traffic is rerouted on your site. + This endpoint requires an Enterprise workspace. Required scope: `sites:read` @@ -534,74 +286,8 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/redirects", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Redirects, - parse_obj_as( - type_=Redirects, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.list(site_id, request_options=request_options) + return _response.data async def create( self, @@ -613,10 +299,12 @@ async def create( request_options: typing.Optional[RequestOptions] = None, ) -> Redirect: """ - Add a new URL redirection rule to a site. + Add a new 301 redirection rule to a site. This endpoint allows you to define a source path (`fromUrl`) and its corresponding destination path (`toUrl`), which will dictate how traffic is rerouted on your site. This is useful for managing site changes, restructuring URLs, or handling outdated links. + This endpoint requires an Enterprise workspace. + Required scope: `sites:write` Parameters @@ -663,87 +351,21 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/redirects", - method="POST", - json={ - "id": id, - "fromUrl": from_url, - "toUrl": to_url, - }, - request_options=request_options, - omit=OMIT, + _response = await self._raw_client.create( + site_id, id=id, from_url=from_url, to_url=to_url, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Redirect, - parse_obj_as( - type_=Redirect, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def delete( self, site_id: str, redirect_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> Redirects: """ - Remove a URL redirection rule from a site. + Remove a 301 redirection rule from a site. + This is useful for cleaning up outdated or unnecessary redirects, ensuring that your site's routing behavior remains efficient and up-to-date. + + This endpoint requires an Enterprise workspace. + Required scope: `sites:write` Parameters @@ -752,7 +374,7 @@ async def delete( Unique identifier for a Site redirect_id : str - Unique identifier site rediect + Unique identifier site redirect request_options : typing.Optional[RequestOptions] Request-specific configuration. @@ -782,74 +404,8 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/redirects/{jsonable_encoder(redirect_id)}", - method="DELETE", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Redirects, - parse_obj_as( - type_=Redirects, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.delete(site_id, redirect_id, request_options=request_options) + return _response.data async def update( self, @@ -862,7 +418,10 @@ async def update( request_options: typing.Optional[RequestOptions] = None, ) -> Redirect: """ - Update a URL redirection rule from a site. + Update a 301 redirection rule from a site. + + This endpoint requires an Enterprise workspace. + Required scope: `sites:write` Parameters @@ -871,7 +430,7 @@ async def update( Unique identifier for a Site redirect_id : str - Unique identifier site rediect + Unique identifier site redirect id : typing.Optional[str] The ID of the specific redirect rule @@ -913,77 +472,7 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/redirects/{jsonable_encoder(redirect_id)}", - method="PATCH", - json={ - "id": id, - "fromUrl": from_url, - "toUrl": to_url, - }, - request_options=request_options, - omit=OMIT, + _response = await self._raw_client.update( + site_id, redirect_id, id=id, from_url=from_url, to_url=to_url, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Redirect, - parse_obj_as( - type_=Redirect, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data diff --git a/src/webflow/resources/sites/resources/redirects/raw_client.py b/src/webflow/resources/sites/resources/redirects/raw_client.py new file mode 100644 index 0000000..d5abafe --- /dev/null +++ b/src/webflow/resources/sites/resources/redirects/raw_client.py @@ -0,0 +1,978 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from .....core.api_error import ApiError +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from .....core.http_response import AsyncHttpResponse, HttpResponse +from .....core.jsonable_encoder import jsonable_encoder +from .....core.parse_error import ParsingError +from .....core.pydantic_utilities import parse_obj_as +from .....core.request_options import RequestOptions +from .....errors.bad_request_error import BadRequestError +from .....errors.internal_server_error import InternalServerError +from .....errors.not_found_error import NotFoundError +from .....errors.too_many_requests_error import TooManyRequestsError +from .....errors.unauthorized_error import UnauthorizedError +from .....types.error import Error +from .....types.redirect import Redirect +from .....types.redirects import Redirects +from pydantic import ValidationError + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawRedirectsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def list(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[Redirects]: + """ + Fetch a list of all 301 redirect rules configured for a specific site. + + Use this endpoint to review, audit, or manage the redirection rules that control how traffic is rerouted on your site. + + This endpoint requires an Enterprise workspace. + + Required scope: `sites:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Redirects] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/redirects", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Redirects, + parse_obj_as( + type_=Redirects, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def create( + self, + site_id: str, + *, + id: typing.Optional[str] = OMIT, + from_url: typing.Optional[str] = OMIT, + to_url: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[Redirect]: + """ + Add a new 301 redirection rule to a site. + + This endpoint allows you to define a source path (`fromUrl`) and its corresponding destination path (`toUrl`), which will dictate how traffic is rerouted on your site. This is useful for managing site changes, restructuring URLs, or handling outdated links. + + This endpoint requires an Enterprise workspace. + + Required scope: `sites:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + id : typing.Optional[str] + The ID of the specific redirect rule + + from_url : typing.Optional[str] + The source URL path that will be redirected. + + to_url : typing.Optional[str] + The target URL path where the user or client will be redirected. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Redirect] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/redirects", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "id": id, + "fromUrl": from_url, + "toUrl": to_url, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Redirect, + parse_obj_as( + type_=Redirect, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def delete( + self, site_id: str, redirect_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[Redirects]: + """ + Remove a 301 redirection rule from a site. + + This is useful for cleaning up outdated or unnecessary redirects, ensuring that your site's routing behavior remains efficient and up-to-date. + + This endpoint requires an Enterprise workspace. + + Required scope: `sites:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + redirect_id : str + Unique identifier site redirect + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Redirects] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/redirects/{jsonable_encoder(redirect_id)}", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Redirects, + parse_obj_as( + type_=Redirects, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def update( + self, + site_id: str, + redirect_id: str, + *, + id: typing.Optional[str] = OMIT, + from_url: typing.Optional[str] = OMIT, + to_url: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[Redirect]: + """ + Update a 301 redirection rule from a site. + + This endpoint requires an Enterprise workspace. + + Required scope: `sites:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + redirect_id : str + Unique identifier site redirect + + id : typing.Optional[str] + The ID of the specific redirect rule + + from_url : typing.Optional[str] + The source URL path that will be redirected. + + to_url : typing.Optional[str] + The target URL path where the user or client will be redirected. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Redirect] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/redirects/{jsonable_encoder(redirect_id)}", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + json={ + "id": id, + "fromUrl": from_url, + "toUrl": to_url, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Redirect, + parse_obj_as( + type_=Redirect, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawRedirectsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def list( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[Redirects]: + """ + Fetch a list of all 301 redirect rules configured for a specific site. + + Use this endpoint to review, audit, or manage the redirection rules that control how traffic is rerouted on your site. + + This endpoint requires an Enterprise workspace. + + Required scope: `sites:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Redirects] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/redirects", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Redirects, + parse_obj_as( + type_=Redirects, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def create( + self, + site_id: str, + *, + id: typing.Optional[str] = OMIT, + from_url: typing.Optional[str] = OMIT, + to_url: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[Redirect]: + """ + Add a new 301 redirection rule to a site. + + This endpoint allows you to define a source path (`fromUrl`) and its corresponding destination path (`toUrl`), which will dictate how traffic is rerouted on your site. This is useful for managing site changes, restructuring URLs, or handling outdated links. + + This endpoint requires an Enterprise workspace. + + Required scope: `sites:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + id : typing.Optional[str] + The ID of the specific redirect rule + + from_url : typing.Optional[str] + The source URL path that will be redirected. + + to_url : typing.Optional[str] + The target URL path where the user or client will be redirected. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Redirect] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/redirects", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "id": id, + "fromUrl": from_url, + "toUrl": to_url, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Redirect, + parse_obj_as( + type_=Redirect, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def delete( + self, site_id: str, redirect_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[Redirects]: + """ + Remove a 301 redirection rule from a site. + + This is useful for cleaning up outdated or unnecessary redirects, ensuring that your site's routing behavior remains efficient and up-to-date. + + This endpoint requires an Enterprise workspace. + + Required scope: `sites:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + redirect_id : str + Unique identifier site redirect + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Redirects] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/redirects/{jsonable_encoder(redirect_id)}", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Redirects, + parse_obj_as( + type_=Redirects, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def update( + self, + site_id: str, + redirect_id: str, + *, + id: typing.Optional[str] = OMIT, + from_url: typing.Optional[str] = OMIT, + to_url: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[Redirect]: + """ + Update a 301 redirection rule from a site. + + This endpoint requires an Enterprise workspace. + + Required scope: `sites:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + redirect_id : str + Unique identifier site redirect + + id : typing.Optional[str] + The ID of the specific redirect rule + + from_url : typing.Optional[str] + The source URL path that will be redirected. + + to_url : typing.Optional[str] + The target URL path where the user or client will be redirected. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Redirect] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/redirects/{jsonable_encoder(redirect_id)}", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + json={ + "id": id, + "fromUrl": from_url, + "toUrl": to_url, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Redirect, + parse_obj_as( + type_=Redirect, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/tests/collections/__init__.py b/src/webflow/resources/sites/resources/robots_txt/__init__.py similarity index 76% rename from tests/collections/__init__.py rename to src/webflow/resources/sites/resources/robots_txt/__init__.py index f3ea265..5cde020 100644 --- a/tests/collections/__init__.py +++ b/src/webflow/resources/sites/resources/robots_txt/__init__.py @@ -1,2 +1,4 @@ # This file was auto-generated by Fern from our API Definition. +# isort: skip_file + diff --git a/src/webflow/resources/sites/resources/robots_txt/client.py b/src/webflow/resources/sites/resources/robots_txt/client.py new file mode 100644 index 0000000..af74b37 --- /dev/null +++ b/src/webflow/resources/sites/resources/robots_txt/client.py @@ -0,0 +1,486 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from .....core.request_options import RequestOptions +from .....types.robots import Robots +from .....types.robots_rules_item import RobotsRulesItem +from .raw_client import AsyncRawRobotsTxtClient, RawRobotsTxtClient + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RobotsTxtClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawRobotsTxtClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawRobotsTxtClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawRobotsTxtClient + """ + return self._raw_client + + def get(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Robots: + """ + Retrieve the robots.txt configuration for various user agents. + + This endpoint requires an Enterprise workspace. + + Required scope: `site_config:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + Robots + Request was successful + + Examples + -------- + from webflow import Webflow + + client = Webflow( + access_token="YOUR_ACCESS_TOKEN", + ) + client.sites.robots_txt.get( + site_id="580e63e98c9a982ac9b8b741", + ) + """ + _response = self._raw_client.get(site_id, request_options=request_options) + return _response.data + + def put( + self, + site_id: str, + *, + rules: typing.Optional[typing.Sequence[RobotsRulesItem]] = OMIT, + sitemap: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> Robots: + """ + Replace the `robots.txt` configuration for various user agents. + + This endpoint requires an Enterprise workspace. + + Required scope | `site_config:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + rules : typing.Optional[typing.Sequence[RobotsRulesItem]] + List of rules for user agents. + + sitemap : typing.Optional[str] + URL to the sitemap. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + Robots + Request was successful + + Examples + -------- + from webflow import RobotsRulesItem, Webflow + + client = Webflow( + access_token="YOUR_ACCESS_TOKEN", + ) + client.sites.robots_txt.put( + site_id="580e63e98c9a982ac9b8b741", + rules=[ + RobotsRulesItem( + user_agent="googlebot", + allows=["/public"], + disallows=["/vogon-poetry", "/total-perspective-vortex"], + ) + ], + sitemap="https://heartofgold.ship/sitemap.xml", + ) + """ + _response = self._raw_client.put(site_id, rules=rules, sitemap=sitemap, request_options=request_options) + return _response.data + + def delete( + self, + site_id: str, + *, + rules: typing.Optional[typing.Sequence[RobotsRulesItem]] = OMIT, + sitemap: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> Robots: + """ + Remove specific rules for a user-agent in your `robots.txt` file. To delete all rules for a user-agent, provide an empty rule set. This will remove the user-agent's entry entirely, leaving it subject to your site's default crawling behavior. + + **Note:** Deleting a user-agent with no rules will make the user-agent's access unrestricted unless other directives apply. + + This endpoint requires an Enterprise workspace. + + Required scope: `site_config:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + rules : typing.Optional[typing.Sequence[RobotsRulesItem]] + List of rules for user agents. + + sitemap : typing.Optional[str] + URL to the sitemap. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + Robots + Request was successful + + Examples + -------- + from webflow import RobotsRulesItem, Webflow + + client = Webflow( + access_token="YOUR_ACCESS_TOKEN", + ) + client.sites.robots_txt.delete( + site_id="580e63e98c9a982ac9b8b741", + rules=[ + RobotsRulesItem( + user_agent="*", + allows=["/public"], + disallows=["/bubbles"], + ) + ], + ) + """ + _response = self._raw_client.delete(site_id, rules=rules, sitemap=sitemap, request_options=request_options) + return _response.data + + def patch( + self, + site_id: str, + *, + rules: typing.Optional[typing.Sequence[RobotsRulesItem]] = OMIT, + sitemap: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> Robots: + """ + Update the `robots.txt` configuration for various user agents. + + This endpoint requires an Enterprise workspace. + + Required scope | `site_config:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + rules : typing.Optional[typing.Sequence[RobotsRulesItem]] + List of rules for user agents. + + sitemap : typing.Optional[str] + URL to the sitemap. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + Robots + Request was successful + + Examples + -------- + from webflow import RobotsRulesItem, Webflow + + client = Webflow( + access_token="YOUR_ACCESS_TOKEN", + ) + client.sites.robots_txt.patch( + site_id="580e63e98c9a982ac9b8b741", + rules=[ + RobotsRulesItem( + user_agent="googlebot", + allows=["/public"], + disallows=["/vogon-poetry", "/total-perspective-vortex"], + ) + ], + sitemap="https://heartofgold.ship/sitemap.xml", + ) + """ + _response = self._raw_client.patch(site_id, rules=rules, sitemap=sitemap, request_options=request_options) + return _response.data + + +class AsyncRobotsTxtClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawRobotsTxtClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawRobotsTxtClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawRobotsTxtClient + """ + return self._raw_client + + async def get(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Robots: + """ + Retrieve the robots.txt configuration for various user agents. + + This endpoint requires an Enterprise workspace. + + Required scope: `site_config:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + Robots + Request was successful + + Examples + -------- + import asyncio + + from webflow import AsyncWebflow + + client = AsyncWebflow( + access_token="YOUR_ACCESS_TOKEN", + ) + + + async def main() -> None: + await client.sites.robots_txt.get( + site_id="580e63e98c9a982ac9b8b741", + ) + + + asyncio.run(main()) + """ + _response = await self._raw_client.get(site_id, request_options=request_options) + return _response.data + + async def put( + self, + site_id: str, + *, + rules: typing.Optional[typing.Sequence[RobotsRulesItem]] = OMIT, + sitemap: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> Robots: + """ + Replace the `robots.txt` configuration for various user agents. + + This endpoint requires an Enterprise workspace. + + Required scope | `site_config:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + rules : typing.Optional[typing.Sequence[RobotsRulesItem]] + List of rules for user agents. + + sitemap : typing.Optional[str] + URL to the sitemap. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + Robots + Request was successful + + Examples + -------- + import asyncio + + from webflow import AsyncWebflow, RobotsRulesItem + + client = AsyncWebflow( + access_token="YOUR_ACCESS_TOKEN", + ) + + + async def main() -> None: + await client.sites.robots_txt.put( + site_id="580e63e98c9a982ac9b8b741", + rules=[ + RobotsRulesItem( + user_agent="googlebot", + allows=["/public"], + disallows=["/vogon-poetry", "/total-perspective-vortex"], + ) + ], + sitemap="https://heartofgold.ship/sitemap.xml", + ) + + + asyncio.run(main()) + """ + _response = await self._raw_client.put(site_id, rules=rules, sitemap=sitemap, request_options=request_options) + return _response.data + + async def delete( + self, + site_id: str, + *, + rules: typing.Optional[typing.Sequence[RobotsRulesItem]] = OMIT, + sitemap: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> Robots: + """ + Remove specific rules for a user-agent in your `robots.txt` file. To delete all rules for a user-agent, provide an empty rule set. This will remove the user-agent's entry entirely, leaving it subject to your site's default crawling behavior. + + **Note:** Deleting a user-agent with no rules will make the user-agent's access unrestricted unless other directives apply. + + This endpoint requires an Enterprise workspace. + + Required scope: `site_config:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + rules : typing.Optional[typing.Sequence[RobotsRulesItem]] + List of rules for user agents. + + sitemap : typing.Optional[str] + URL to the sitemap. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + Robots + Request was successful + + Examples + -------- + import asyncio + + from webflow import AsyncWebflow, RobotsRulesItem + + client = AsyncWebflow( + access_token="YOUR_ACCESS_TOKEN", + ) + + + async def main() -> None: + await client.sites.robots_txt.delete( + site_id="580e63e98c9a982ac9b8b741", + rules=[ + RobotsRulesItem( + user_agent="*", + allows=["/public"], + disallows=["/bubbles"], + ) + ], + ) + + + asyncio.run(main()) + """ + _response = await self._raw_client.delete( + site_id, rules=rules, sitemap=sitemap, request_options=request_options + ) + return _response.data + + async def patch( + self, + site_id: str, + *, + rules: typing.Optional[typing.Sequence[RobotsRulesItem]] = OMIT, + sitemap: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> Robots: + """ + Update the `robots.txt` configuration for various user agents. + + This endpoint requires an Enterprise workspace. + + Required scope | `site_config:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + rules : typing.Optional[typing.Sequence[RobotsRulesItem]] + List of rules for user agents. + + sitemap : typing.Optional[str] + URL to the sitemap. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + Robots + Request was successful + + Examples + -------- + import asyncio + + from webflow import AsyncWebflow, RobotsRulesItem + + client = AsyncWebflow( + access_token="YOUR_ACCESS_TOKEN", + ) + + + async def main() -> None: + await client.sites.robots_txt.patch( + site_id="580e63e98c9a982ac9b8b741", + rules=[ + RobotsRulesItem( + user_agent="googlebot", + allows=["/public"], + disallows=["/vogon-poetry", "/total-perspective-vortex"], + ) + ], + sitemap="https://heartofgold.ship/sitemap.xml", + ) + + + asyncio.run(main()) + """ + _response = await self._raw_client.patch(site_id, rules=rules, sitemap=sitemap, request_options=request_options) + return _response.data diff --git a/src/webflow/resources/sites/resources/robots_txt/raw_client.py b/src/webflow/resources/sites/resources/robots_txt/raw_client.py new file mode 100644 index 0000000..ac8d1fe --- /dev/null +++ b/src/webflow/resources/sites/resources/robots_txt/raw_client.py @@ -0,0 +1,987 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from .....core.api_error import ApiError +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from .....core.http_response import AsyncHttpResponse, HttpResponse +from .....core.jsonable_encoder import jsonable_encoder +from .....core.parse_error import ParsingError +from .....core.pydantic_utilities import parse_obj_as +from .....core.request_options import RequestOptions +from .....core.serialization import convert_and_respect_annotation_metadata +from .....errors.bad_request_error import BadRequestError +from .....errors.internal_server_error import InternalServerError +from .....errors.not_found_error import NotFoundError +from .....errors.too_many_requests_error import TooManyRequestsError +from .....errors.unauthorized_error import UnauthorizedError +from .....types.error import Error +from .....types.robots import Robots +from .....types.robots_rules_item import RobotsRulesItem +from pydantic import ValidationError + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawRobotsTxtClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def get(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[Robots]: + """ + Retrieve the robots.txt configuration for various user agents. + + This endpoint requires an Enterprise workspace. + + Required scope: `site_config:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Robots] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/robots_txt", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Robots, + parse_obj_as( + type_=Robots, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def put( + self, + site_id: str, + *, + rules: typing.Optional[typing.Sequence[RobotsRulesItem]] = OMIT, + sitemap: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[Robots]: + """ + Replace the `robots.txt` configuration for various user agents. + + This endpoint requires an Enterprise workspace. + + Required scope | `site_config:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + rules : typing.Optional[typing.Sequence[RobotsRulesItem]] + List of rules for user agents. + + sitemap : typing.Optional[str] + URL to the sitemap. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Robots] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/robots_txt", + base_url=self._client_wrapper.get_environment().base, + method="PUT", + json={ + "rules": convert_and_respect_annotation_metadata( + object_=rules, annotation=typing.Sequence[RobotsRulesItem], direction="write" + ), + "sitemap": sitemap, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Robots, + parse_obj_as( + type_=Robots, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def delete( + self, + site_id: str, + *, + rules: typing.Optional[typing.Sequence[RobotsRulesItem]] = OMIT, + sitemap: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[Robots]: + """ + Remove specific rules for a user-agent in your `robots.txt` file. To delete all rules for a user-agent, provide an empty rule set. This will remove the user-agent's entry entirely, leaving it subject to your site's default crawling behavior. + + **Note:** Deleting a user-agent with no rules will make the user-agent's access unrestricted unless other directives apply. + + This endpoint requires an Enterprise workspace. + + Required scope: `site_config:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + rules : typing.Optional[typing.Sequence[RobotsRulesItem]] + List of rules for user agents. + + sitemap : typing.Optional[str] + URL to the sitemap. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Robots] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/robots_txt", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + json={ + "rules": convert_and_respect_annotation_metadata( + object_=rules, annotation=typing.Sequence[RobotsRulesItem], direction="write" + ), + "sitemap": sitemap, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Robots, + parse_obj_as( + type_=Robots, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def patch( + self, + site_id: str, + *, + rules: typing.Optional[typing.Sequence[RobotsRulesItem]] = OMIT, + sitemap: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[Robots]: + """ + Update the `robots.txt` configuration for various user agents. + + This endpoint requires an Enterprise workspace. + + Required scope | `site_config:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + rules : typing.Optional[typing.Sequence[RobotsRulesItem]] + List of rules for user agents. + + sitemap : typing.Optional[str] + URL to the sitemap. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Robots] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/robots_txt", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + json={ + "rules": convert_and_respect_annotation_metadata( + object_=rules, annotation=typing.Sequence[RobotsRulesItem], direction="write" + ), + "sitemap": sitemap, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Robots, + parse_obj_as( + type_=Robots, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawRobotsTxtClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def get( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[Robots]: + """ + Retrieve the robots.txt configuration for various user agents. + + This endpoint requires an Enterprise workspace. + + Required scope: `site_config:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Robots] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/robots_txt", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Robots, + parse_obj_as( + type_=Robots, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def put( + self, + site_id: str, + *, + rules: typing.Optional[typing.Sequence[RobotsRulesItem]] = OMIT, + sitemap: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[Robots]: + """ + Replace the `robots.txt` configuration for various user agents. + + This endpoint requires an Enterprise workspace. + + Required scope | `site_config:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + rules : typing.Optional[typing.Sequence[RobotsRulesItem]] + List of rules for user agents. + + sitemap : typing.Optional[str] + URL to the sitemap. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Robots] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/robots_txt", + base_url=self._client_wrapper.get_environment().base, + method="PUT", + json={ + "rules": convert_and_respect_annotation_metadata( + object_=rules, annotation=typing.Sequence[RobotsRulesItem], direction="write" + ), + "sitemap": sitemap, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Robots, + parse_obj_as( + type_=Robots, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def delete( + self, + site_id: str, + *, + rules: typing.Optional[typing.Sequence[RobotsRulesItem]] = OMIT, + sitemap: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[Robots]: + """ + Remove specific rules for a user-agent in your `robots.txt` file. To delete all rules for a user-agent, provide an empty rule set. This will remove the user-agent's entry entirely, leaving it subject to your site's default crawling behavior. + + **Note:** Deleting a user-agent with no rules will make the user-agent's access unrestricted unless other directives apply. + + This endpoint requires an Enterprise workspace. + + Required scope: `site_config:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + rules : typing.Optional[typing.Sequence[RobotsRulesItem]] + List of rules for user agents. + + sitemap : typing.Optional[str] + URL to the sitemap. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Robots] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/robots_txt", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + json={ + "rules": convert_and_respect_annotation_metadata( + object_=rules, annotation=typing.Sequence[RobotsRulesItem], direction="write" + ), + "sitemap": sitemap, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Robots, + parse_obj_as( + type_=Robots, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def patch( + self, + site_id: str, + *, + rules: typing.Optional[typing.Sequence[RobotsRulesItem]] = OMIT, + sitemap: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[Robots]: + """ + Update the `robots.txt` configuration for various user agents. + + This endpoint requires an Enterprise workspace. + + Required scope | `site_config:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + rules : typing.Optional[typing.Sequence[RobotsRulesItem]] + List of rules for user agents. + + sitemap : typing.Optional[str] + URL to the sitemap. + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Robots] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/robots_txt", + base_url=self._client_wrapper.get_environment().base, + method="PATCH", + json={ + "rules": convert_and_respect_annotation_metadata( + object_=rules, annotation=typing.Sequence[RobotsRulesItem], direction="write" + ), + "sitemap": sitemap, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Robots, + parse_obj_as( + type_=Robots, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/sites/resources/scripts/__init__.py b/src/webflow/resources/sites/resources/scripts/__init__.py index f3ea265..5cde020 100644 --- a/src/webflow/resources/sites/resources/scripts/__init__.py +++ b/src/webflow/resources/sites/resources/scripts/__init__.py @@ -1,2 +1,4 @@ # This file was auto-generated by Fern from our API Definition. +# isort: skip_file + diff --git a/src/webflow/resources/sites/resources/scripts/client.py b/src/webflow/resources/sites/resources/scripts/client.py index 1954842..f7cddec 100644 --- a/src/webflow/resources/sites/resources/scripts/client.py +++ b/src/webflow/resources/sites/resources/scripts/client.py @@ -1,23 +1,13 @@ # This file was auto-generated by Fern from our API Definition. import typing -from .....core.client_wrapper import SyncClientWrapper + +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from .....core.request_options import RequestOptions -from .....types.script_apply_list import ScriptApplyList -from .....core.jsonable_encoder import jsonable_encoder -from .....core.pydantic_utilities import parse_obj_as -from .....errors.bad_request_error import BadRequestError -from .....errors.unauthorized_error import UnauthorizedError -from .....types.error import Error -from .....errors.not_found_error import NotFoundError -from .....errors.too_many_requests_error import TooManyRequestsError -from .....errors.internal_server_error import InternalServerError -from json.decoder import JSONDecodeError -from .....core.api_error import ApiError -from .....types.script_apply import ScriptApply -from .....core.serialization import convert_and_respect_annotation_metadata from .....types.list_custom_code_blocks import ListCustomCodeBlocks -from .....core.client_wrapper import AsyncClientWrapper +from .....types.script_apply import ScriptApply +from .....types.script_apply_list import ScriptApplyList +from .raw_client import AsyncRawScriptsClient, RawScriptsClient # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) @@ -25,15 +15,28 @@ class ScriptsClient: def __init__(self, *, client_wrapper: SyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = RawScriptsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawScriptsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawScriptsClient + """ + return self._raw_client def get_custom_code( self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> ScriptApplyList: """ - Get all registered scripts that have been applied to a specific Site. + Get all scripts applied to a site by the App. - Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + Required scope | `custom_code:read` @@ -61,74 +64,8 @@ def get_custom_code( site_id="580e63e98c9a982ac9b8b741", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/custom_code", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ScriptApplyList, - parse_obj_as( - type_=ScriptApplyList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.get_custom_code(site_id, request_options=request_options) + return _response.data def upsert_custom_code( self, @@ -140,13 +77,11 @@ def upsert_custom_code( request_options: typing.Optional[RequestOptions] = None, ) -> ScriptApplyList: """ - Add a registered script to a Site. - - In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered - to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate - `custom_code` endpoints. + Apply registered scripts to a site. If you have multiple scripts your App needs to apply or maintain on a site, ensure they are always included in the request body for this endpoint. To remove individual scripts, simply call this endpoint without the script in the request body. - Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + Required scope | `custom_code:write` @@ -196,88 +131,18 @@ def upsert_custom_code( ], ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/custom_code", - method="PUT", - json={ - "scripts": convert_and_respect_annotation_metadata( - object_=scripts, annotation=typing.Sequence[ScriptApply], direction="write" - ), - "lastUpdated": last_updated, - "createdOn": created_on, - }, - request_options=request_options, - omit=OMIT, + _response = self._raw_client.upsert_custom_code( + site_id, scripts=scripts, last_updated=last_updated, created_on=created_on, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ScriptApplyList, - parse_obj_as( - type_=ScriptApplyList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def delete_custom_code(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ - Delete the custom code block that an app created for a Site + Remove all scripts from a site applied by the App. This endpoint will not remove scripts from the site's registered scripts. - Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + To remove individual scripts applied by the App, use the [Add/Update Custom Code](/data/reference/custom-code/custom-code-sites/upsert-custom-code) endpoint. + + Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app). Required scope | `custom_code:write` @@ -304,81 +169,25 @@ def delete_custom_code(self, site_id: str, *, request_options: typing.Optional[R site_id="580e63e98c9a982ac9b8b741", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/custom_code", - method="DELETE", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.delete_custom_code(site_id, request_options=request_options) + return _response.data def list_custom_code_blocks( self, site_id: str, *, - offset: typing.Optional[float] = None, - limit: typing.Optional[float] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> ListCustomCodeBlocks: """ - Get all instances of Custom Code applied to a Site or Pages. + Get a list of scripts that have been applied to a site and/or individual pages. - Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. + + See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + Required scope | `custom_code:read` @@ -387,10 +196,10 @@ def list_custom_code_blocks( site_id : str Unique identifier for a Site - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records - limit : typing.Optional[float] + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) request_options : typing.Optional[RequestOptions] @@ -410,93 +219,40 @@ def list_custom_code_blocks( ) client.sites.scripts.list_custom_code_blocks( site_id="580e63e98c9a982ac9b8b741", + offset=1, + limit=1, ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/custom_code/blocks", - method="GET", - params={ - "offset": offset, - "limit": limit, - }, - request_options=request_options, + _response = self._raw_client.list_custom_code_blocks( + site_id, offset=offset, limit=limit, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ListCustomCodeBlocks, - parse_obj_as( - type_=ListCustomCodeBlocks, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data class AsyncScriptsClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = AsyncRawScriptsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawScriptsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawScriptsClient + """ + return self._raw_client async def get_custom_code( self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> ScriptApplyList: """ - Get all registered scripts that have been applied to a specific Site. + Get all scripts applied to a site by the App. - Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + Required scope | `custom_code:read` @@ -532,74 +288,8 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/custom_code", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ScriptApplyList, - parse_obj_as( - type_=ScriptApplyList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.get_custom_code(site_id, request_options=request_options) + return _response.data async def upsert_custom_code( self, @@ -611,13 +301,11 @@ async def upsert_custom_code( request_options: typing.Optional[RequestOptions] = None, ) -> ScriptApplyList: """ - Add a registered script to a Site. - - In order to use the Custom Code APIs for Sites and Pages, Custom Code Scripts must first be registered - to a Site via the `registered_scripts` endpoints, and then applied to a Site or Page using the appropriate - `custom_code` endpoints. + Apply registered scripts to a site. If you have multiple scripts your App needs to apply or maintain on a site, ensure they are always included in the request body for this endpoint. To remove individual scripts, simply call this endpoint without the script in the request body. - Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + Required scope | `custom_code:write` @@ -675,90 +363,20 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/custom_code", - method="PUT", - json={ - "scripts": convert_and_respect_annotation_metadata( - object_=scripts, annotation=typing.Sequence[ScriptApply], direction="write" - ), - "lastUpdated": last_updated, - "createdOn": created_on, - }, - request_options=request_options, - omit=OMIT, + _response = await self._raw_client.upsert_custom_code( + site_id, scripts=scripts, last_updated=last_updated, created_on=created_on, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ScriptApplyList, - parse_obj_as( - type_=ScriptApplyList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def delete_custom_code( self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None ) -> None: """ - Delete the custom code block that an app created for a Site + Remove all scripts from a site applied by the App. This endpoint will not remove scripts from the site's registered scripts. - Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + To remove individual scripts applied by the App, use the [Add/Update Custom Code](/data/reference/custom-code/custom-code-sites/upsert-custom-code) endpoint. + + Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app). Required scope | `custom_code:write` @@ -793,81 +411,25 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/custom_code", - method="DELETE", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.delete_custom_code(site_id, request_options=request_options) + return _response.data async def list_custom_code_blocks( self, site_id: str, *, - offset: typing.Optional[float] = None, - limit: typing.Optional[float] = None, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, request_options: typing.Optional[RequestOptions] = None, ) -> ListCustomCodeBlocks: """ - Get all instances of Custom Code applied to a Site or Pages. + Get a list of scripts that have been applied to a site and/or individual pages. - Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. + + See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + Required scope | `custom_code:read` @@ -876,10 +438,10 @@ async def list_custom_code_blocks( site_id : str Unique identifier for a Site - offset : typing.Optional[float] + offset : typing.Optional[int] Offset used for pagination if the results have more than limit records - limit : typing.Optional[float] + limit : typing.Optional[int] Maximum number of records to be returned (max limit: 100) request_options : typing.Optional[RequestOptions] @@ -904,80 +466,14 @@ async def list_custom_code_blocks( async def main() -> None: await client.sites.scripts.list_custom_code_blocks( site_id="580e63e98c9a982ac9b8b741", + offset=1, + limit=1, ) asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/custom_code/blocks", - method="GET", - params={ - "offset": offset, - "limit": limit, - }, - request_options=request_options, + _response = await self._raw_client.list_custom_code_blocks( + site_id, offset=offset, limit=limit, request_options=request_options ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - ListCustomCodeBlocks, - parse_obj_as( - type_=ListCustomCodeBlocks, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data diff --git a/src/webflow/resources/sites/resources/scripts/raw_client.py b/src/webflow/resources/sites/resources/scripts/raw_client.py new file mode 100644 index 0000000..a5e6bb6 --- /dev/null +++ b/src/webflow/resources/sites/resources/scripts/raw_client.py @@ -0,0 +1,946 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from .....core.api_error import ApiError +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from .....core.http_response import AsyncHttpResponse, HttpResponse +from .....core.jsonable_encoder import jsonable_encoder +from .....core.parse_error import ParsingError +from .....core.pydantic_utilities import parse_obj_as +from .....core.request_options import RequestOptions +from .....core.serialization import convert_and_respect_annotation_metadata +from .....errors.bad_request_error import BadRequestError +from .....errors.internal_server_error import InternalServerError +from .....errors.not_found_error import NotFoundError +from .....errors.too_many_requests_error import TooManyRequestsError +from .....errors.unauthorized_error import UnauthorizedError +from .....types.error import Error +from .....types.list_custom_code_blocks import ListCustomCodeBlocks +from .....types.script_apply import ScriptApply +from .....types.script_apply_list import ScriptApplyList +from pydantic import ValidationError + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawScriptsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def get_custom_code( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[ScriptApplyList]: + """ + Get all scripts applied to a site by the App. + + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + + + Required scope | `custom_code:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ScriptApplyList] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/custom_code", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ScriptApplyList, + parse_obj_as( + type_=ScriptApplyList, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def upsert_custom_code( + self, + site_id: str, + *, + scripts: typing.Optional[typing.Sequence[ScriptApply]] = OMIT, + last_updated: typing.Optional[str] = OMIT, + created_on: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[ScriptApplyList]: + """ + Apply registered scripts to a site. If you have multiple scripts your App needs to apply or maintain on a site, ensure they are always included in the request body for this endpoint. To remove individual scripts, simply call this endpoint without the script in the request body. + + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + + + Required scope | `custom_code:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + scripts : typing.Optional[typing.Sequence[ScriptApply]] + A list of scripts applied to a Site or a Page + + last_updated : typing.Optional[str] + Date when the Site's scripts were last updated + + created_on : typing.Optional[str] + Date when the Site's scripts were created + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ScriptApplyList] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/custom_code", + base_url=self._client_wrapper.get_environment().base, + method="PUT", + json={ + "scripts": convert_and_respect_annotation_metadata( + object_=scripts, annotation=typing.Sequence[ScriptApply], direction="write" + ), + "lastUpdated": last_updated, + "createdOn": created_on, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ScriptApplyList, + parse_obj_as( + type_=ScriptApplyList, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def delete_custom_code( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[None]: + """ + Remove all scripts from a site applied by the App. This endpoint will not remove scripts from the site's registered scripts. + + To remove individual scripts applied by the App, use the [Add/Update Custom Code](/data/reference/custom-code/custom-code-sites/upsert-custom-code) endpoint. + + Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app). + + Required scope | `custom_code:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[None] + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/custom_code", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return HttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def list_custom_code_blocks( + self, + site_id: str, + *, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[ListCustomCodeBlocks]: + """ + Get a list of scripts that have been applied to a site and/or individual pages. + + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. + + See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + + + Required scope | `custom_code:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[ListCustomCodeBlocks] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/custom_code/blocks", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "offset": offset, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ListCustomCodeBlocks, + parse_obj_as( + type_=ListCustomCodeBlocks, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawScriptsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def get_custom_code( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[ScriptApplyList]: + """ + Get all scripts applied to a site by the App. + + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + + + Required scope | `custom_code:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ScriptApplyList] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/custom_code", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ScriptApplyList, + parse_obj_as( + type_=ScriptApplyList, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def upsert_custom_code( + self, + site_id: str, + *, + scripts: typing.Optional[typing.Sequence[ScriptApply]] = OMIT, + last_updated: typing.Optional[str] = OMIT, + created_on: typing.Optional[str] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[ScriptApplyList]: + """ + Apply registered scripts to a site. If you have multiple scripts your App needs to apply or maintain on a site, ensure they are always included in the request body for this endpoint. To remove individual scripts, simply call this endpoint without the script in the request body. + + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + + + Required scope | `custom_code:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + scripts : typing.Optional[typing.Sequence[ScriptApply]] + A list of scripts applied to a Site or a Page + + last_updated : typing.Optional[str] + Date when the Site's scripts were last updated + + created_on : typing.Optional[str] + Date when the Site's scripts were created + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ScriptApplyList] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/custom_code", + base_url=self._client_wrapper.get_environment().base, + method="PUT", + json={ + "scripts": convert_and_respect_annotation_metadata( + object_=scripts, annotation=typing.Sequence[ScriptApply], direction="write" + ), + "lastUpdated": last_updated, + "createdOn": created_on, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ScriptApplyList, + parse_obj_as( + type_=ScriptApplyList, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def delete_custom_code( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[None]: + """ + Remove all scripts from a site applied by the App. This endpoint will not remove scripts from the site's registered scripts. + + To remove individual scripts applied by the App, use the [Add/Update Custom Code](/data/reference/custom-code/custom-code-sites/upsert-custom-code) endpoint. + + Access to this endpoint requires a bearer token obtained from an [OAuth Code Grant Flow](/data/reference/oauth-app). + + Required scope | `custom_code:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[None] + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/custom_code", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return AsyncHttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def list_custom_code_blocks( + self, + site_id: str, + *, + offset: typing.Optional[int] = None, + limit: typing.Optional[int] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[ListCustomCodeBlocks]: + """ + Get a list of scripts that have been applied to a site and/or individual pages. + + + To apply a script to a site or page, the script must first be registered to a site via the [Register Script](/data/reference/custom-code/custom-code/register-hosted) endpoints. Once registered, the script can be applied to a Site or Page using the appropriate endpoints. + + See the documentation on [working with Custom Code](/data/docs/custom-code) for more information. + + + Required scope | `custom_code:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[ListCustomCodeBlocks] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/custom_code/blocks", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "offset": offset, + "limit": limit, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + ListCustomCodeBlocks, + parse_obj_as( + type_=ListCustomCodeBlocks, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/sites/resources/well_known/__init__.py b/src/webflow/resources/sites/resources/well_known/__init__.py new file mode 100644 index 0000000..34fc810 --- /dev/null +++ b/src/webflow/resources/sites/resources/well_known/__init__.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .types import WellKnownFileContentType +_dynamic_imports: typing.Dict[str, str] = {"WellKnownFileContentType": ".types"} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + + +__all__ = ["WellKnownFileContentType"] diff --git a/src/webflow/resources/sites/resources/well_known/client.py b/src/webflow/resources/sites/resources/well_known/client.py new file mode 100644 index 0000000..14c76ae --- /dev/null +++ b/src/webflow/resources/sites/resources/well_known/client.py @@ -0,0 +1,283 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from .....core.request_options import RequestOptions +from .raw_client import AsyncRawWellKnownClient, RawWellKnownClient +from .types.well_known_file_content_type import WellKnownFileContentType + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class WellKnownClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawWellKnownClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawWellKnownClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawWellKnownClient + """ + return self._raw_client + + def put( + self, + site_id: str, + *, + file_name: str, + file_data: str, + content_type: typing.Optional[WellKnownFileContentType] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> None: + """ + Upload a supported well-known file to a site. + + The current restrictions on well-known files are as follows: + - Each file must be smaller than 100kb + - Less than 30 total files + - Have one of the following file extensions (or no extension): `.txt`, `.json`, `.noext` + + + `.noext` is a special file extension that removes other extensions. For example, `apple-app-site-association.noext.txt` will be uploaded as `apple-app-site-association`. Use this extension for tools that have trouble uploading extensionless files. + + + This endpoint requires an Enterprise workspace. + + Required scope: `site_config:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + file_name : str + The name of the file + + file_data : str + The contents of the file + + content_type : typing.Optional[WellKnownFileContentType] + The content type of the file. Defaults to application/json + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + None + + Examples + -------- + from webflow import Webflow + + client = Webflow( + access_token="YOUR_ACCESS_TOKEN", + ) + client.sites.well_known.put( + site_id="580e63e98c9a982ac9b8b741", + file_name="apple-app-site-association.txt", + file_data='{\n "applinks": {\n "apps": [],\n "details": [\n {\n "appID": "ABCDE12345.com.example.app",\n "paths": [ "/*", "/some/path/*" ]\n }\n ]\n }\n}\n', + content_type="application/json", + ) + """ + _response = self._raw_client.put( + site_id, + file_name=file_name, + file_data=file_data, + content_type=content_type, + request_options=request_options, + ) + return _response.data + + def delete( + self, + site_id: str, + *, + file_names: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> None: + """ + Delete existing well-known files from a site. + + This endpoint requires an Enterprise workspace. + + Required scope: `site_config:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + file_names : typing.Optional[typing.Sequence[str]] + A list of file names to delete + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + None + + Examples + -------- + from webflow import Webflow + + client = Webflow( + access_token="YOUR_ACCESS_TOKEN", + ) + client.sites.well_known.delete( + site_id="580e63e98c9a982ac9b8b741", + ) + """ + _response = self._raw_client.delete(site_id, file_names=file_names, request_options=request_options) + return _response.data + + +class AsyncWellKnownClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawWellKnownClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawWellKnownClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawWellKnownClient + """ + return self._raw_client + + async def put( + self, + site_id: str, + *, + file_name: str, + file_data: str, + content_type: typing.Optional[WellKnownFileContentType] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> None: + """ + Upload a supported well-known file to a site. + + The current restrictions on well-known files are as follows: + - Each file must be smaller than 100kb + - Less than 30 total files + - Have one of the following file extensions (or no extension): `.txt`, `.json`, `.noext` + + + `.noext` is a special file extension that removes other extensions. For example, `apple-app-site-association.noext.txt` will be uploaded as `apple-app-site-association`. Use this extension for tools that have trouble uploading extensionless files. + + + This endpoint requires an Enterprise workspace. + + Required scope: `site_config:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + file_name : str + The name of the file + + file_data : str + The contents of the file + + content_type : typing.Optional[WellKnownFileContentType] + The content type of the file. Defaults to application/json + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + None + + Examples + -------- + import asyncio + + from webflow import AsyncWebflow + + client = AsyncWebflow( + access_token="YOUR_ACCESS_TOKEN", + ) + + + async def main() -> None: + await client.sites.well_known.put( + site_id="580e63e98c9a982ac9b8b741", + file_name="apple-app-site-association.txt", + file_data='{\n "applinks": {\n "apps": [],\n "details": [\n {\n "appID": "ABCDE12345.com.example.app",\n "paths": [ "/*", "/some/path/*" ]\n }\n ]\n }\n}\n', + content_type="application/json", + ) + + + asyncio.run(main()) + """ + _response = await self._raw_client.put( + site_id, + file_name=file_name, + file_data=file_data, + content_type=content_type, + request_options=request_options, + ) + return _response.data + + async def delete( + self, + site_id: str, + *, + file_names: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> None: + """ + Delete existing well-known files from a site. + + This endpoint requires an Enterprise workspace. + + Required scope: `site_config:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + file_names : typing.Optional[typing.Sequence[str]] + A list of file names to delete + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + None + + Examples + -------- + import asyncio + + from webflow import AsyncWebflow + + client = AsyncWebflow( + access_token="YOUR_ACCESS_TOKEN", + ) + + + async def main() -> None: + await client.sites.well_known.delete( + site_id="580e63e98c9a982ac9b8b741", + ) + + + asyncio.run(main()) + """ + _response = await self._raw_client.delete(site_id, file_names=file_names, request_options=request_options) + return _response.data diff --git a/src/webflow/resources/sites/resources/well_known/raw_client.py b/src/webflow/resources/sites/resources/well_known/raw_client.py new file mode 100644 index 0000000..7125705 --- /dev/null +++ b/src/webflow/resources/sites/resources/well_known/raw_client.py @@ -0,0 +1,507 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from .....core.api_error import ApiError +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from .....core.http_response import AsyncHttpResponse, HttpResponse +from .....core.jsonable_encoder import jsonable_encoder +from .....core.parse_error import ParsingError +from .....core.pydantic_utilities import parse_obj_as +from .....core.request_options import RequestOptions +from .....errors.bad_request_error import BadRequestError +from .....errors.internal_server_error import InternalServerError +from .....errors.not_found_error import NotFoundError +from .....errors.too_many_requests_error import TooManyRequestsError +from .....errors.unauthorized_error import UnauthorizedError +from .....types.error import Error +from .types.well_known_file_content_type import WellKnownFileContentType +from pydantic import ValidationError + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawWellKnownClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def put( + self, + site_id: str, + *, + file_name: str, + file_data: str, + content_type: typing.Optional[WellKnownFileContentType] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[None]: + """ + Upload a supported well-known file to a site. + + The current restrictions on well-known files are as follows: + - Each file must be smaller than 100kb + - Less than 30 total files + - Have one of the following file extensions (or no extension): `.txt`, `.json`, `.noext` + + + `.noext` is a special file extension that removes other extensions. For example, `apple-app-site-association.noext.txt` will be uploaded as `apple-app-site-association`. Use this extension for tools that have trouble uploading extensionless files. + + + This endpoint requires an Enterprise workspace. + + Required scope: `site_config:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + file_name : str + The name of the file + + file_data : str + The contents of the file + + content_type : typing.Optional[WellKnownFileContentType] + The content type of the file. Defaults to application/json + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[None] + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/well_known", + base_url=self._client_wrapper.get_environment().base, + method="PUT", + json={ + "fileName": file_name, + "fileData": file_data, + "contentType": content_type, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + return HttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def delete( + self, + site_id: str, + *, + file_names: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[None]: + """ + Delete existing well-known files from a site. + + This endpoint requires an Enterprise workspace. + + Required scope: `site_config:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + file_names : typing.Optional[typing.Sequence[str]] + A list of file names to delete + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[None] + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/well_known", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + json={ + "fileNames": file_names, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + return HttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawWellKnownClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def put( + self, + site_id: str, + *, + file_name: str, + file_data: str, + content_type: typing.Optional[WellKnownFileContentType] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[None]: + """ + Upload a supported well-known file to a site. + + The current restrictions on well-known files are as follows: + - Each file must be smaller than 100kb + - Less than 30 total files + - Have one of the following file extensions (or no extension): `.txt`, `.json`, `.noext` + + + `.noext` is a special file extension that removes other extensions. For example, `apple-app-site-association.noext.txt` will be uploaded as `apple-app-site-association`. Use this extension for tools that have trouble uploading extensionless files. + + + This endpoint requires an Enterprise workspace. + + Required scope: `site_config:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + file_name : str + The name of the file + + file_data : str + The contents of the file + + content_type : typing.Optional[WellKnownFileContentType] + The content type of the file. Defaults to application/json + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[None] + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/well_known", + base_url=self._client_wrapper.get_environment().base, + method="PUT", + json={ + "fileName": file_name, + "fileData": file_data, + "contentType": content_type, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + return AsyncHttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def delete( + self, + site_id: str, + *, + file_names: typing.Optional[typing.Sequence[str]] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[None]: + """ + Delete existing well-known files from a site. + + This endpoint requires an Enterprise workspace. + + Required scope: `site_config:write` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + file_names : typing.Optional[typing.Sequence[str]] + A list of file names to delete + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[None] + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/well_known", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + json={ + "fileNames": file_names, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + return AsyncHttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/sites/resources/well_known/types/__init__.py b/src/webflow/resources/sites/resources/well_known/types/__init__.py new file mode 100644 index 0000000..a5ec3aa --- /dev/null +++ b/src/webflow/resources/sites/resources/well_known/types/__init__.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .well_known_file_content_type import WellKnownFileContentType +_dynamic_imports: typing.Dict[str, str] = {"WellKnownFileContentType": ".well_known_file_content_type"} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + + +__all__ = ["WellKnownFileContentType"] diff --git a/src/webflow/resources/sites/resources/well_known/types/well_known_file_content_type.py b/src/webflow/resources/sites/resources/well_known/types/well_known_file_content_type.py new file mode 100644 index 0000000..be135b4 --- /dev/null +++ b/src/webflow/resources/sites/resources/well_known/types/well_known_file_content_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +WellKnownFileContentType = typing.Union[typing.Literal["application/json", "text/plain"], typing.Any] diff --git a/src/webflow/resources/sites/types/__init__.py b/src/webflow/resources/sites/types/__init__.py index c85fd30..960aec6 100644 --- a/src/webflow/resources/sites/types/__init__.py +++ b/src/webflow/resources/sites/types/__init__.py @@ -1,5 +1,34 @@ # This file was auto-generated by Fern from our API Definition. -from .sites_publish_response import SitesPublishResponse +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .sites_publish_response import SitesPublishResponse +_dynamic_imports: typing.Dict[str, str] = {"SitesPublishResponse": ".sites_publish_response"} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + __all__ = ["SitesPublishResponse"] diff --git a/src/webflow/resources/sites/types/sites_publish_response.py b/src/webflow/resources/sites/types/sites_publish_response.py index bf7a95b..d32e70c 100644 --- a/src/webflow/resources/sites/types/sites_publish_response.py +++ b/src/webflow/resources/sites/types/sites_publish_response.py @@ -1,28 +1,25 @@ # This file was auto-generated by Fern from our API Definition. -from ....core.pydantic_utilities import UniversalBaseModel -import typing_extensions import typing -from ....types.domain import Domain -from ....core.serialization import FieldMetadata + import pydantic -from ....core.pydantic_utilities import IS_PYDANTIC_V2 +import typing_extensions +from ....core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ....core.serialization import FieldMetadata +from ....types.domain import Domain class SitesPublishResponse(UniversalBaseModel): custom_domains: typing_extensions.Annotated[ - typing.Optional[typing.List[Domain]], FieldMetadata(alias="customDomains") - ] = pydantic.Field(default=None) - """ - Array of domains objects - """ - + typing.Optional[typing.List[Domain]], + FieldMetadata(alias="customDomains"), + pydantic.Field(alias="customDomains", description="Array of domains objects"), + ] = None publish_to_webflow_subdomain: typing_extensions.Annotated[ - typing.Optional[bool], FieldMetadata(alias="publishToWebflowSubdomain") - ] = pydantic.Field(default=None) - """ - Flag for publishing to webflow.io subdomain - """ + typing.Optional[bool], + FieldMetadata(alias="publishToWebflowSubdomain"), + pydantic.Field(alias="publishToWebflowSubdomain", description="Flag for publishing to webflow.io subdomain"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/resources/token/__init__.py b/src/webflow/resources/token/__init__.py index f3ea265..5cde020 100644 --- a/src/webflow/resources/token/__init__.py +++ b/src/webflow/resources/token/__init__.py @@ -1,2 +1,4 @@ # This file was auto-generated by Fern from our API Definition. +# isort: skip_file + diff --git a/src/webflow/resources/token/client.py b/src/webflow/resources/token/client.py index 628ce3a..d4712d7 100644 --- a/src/webflow/resources/token/client.py +++ b/src/webflow/resources/token/client.py @@ -1,22 +1,28 @@ # This file was auto-generated by Fern from our API Definition. -from ...core.client_wrapper import SyncClientWrapper import typing + +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ...core.request_options import RequestOptions -from ...types.authorized_user import AuthorizedUser -from ...core.pydantic_utilities import parse_obj_as -from ...errors.unauthorized_error import UnauthorizedError -from ...types.error import Error -from ...errors.forbidden_error import ForbiddenError -from json.decoder import JSONDecodeError -from ...core.api_error import ApiError from ...types.authorization import Authorization -from ...core.client_wrapper import AsyncClientWrapper +from ...types.authorized_user import AuthorizedUser +from .raw_client import AsyncRawTokenClient, RawTokenClient class TokenClient: def __init__(self, *, client_wrapper: SyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = RawTokenClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawTokenClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawTokenClient + """ + return self._raw_client def authorized_by(self, *, request_options: typing.Optional[RequestOptions] = None) -> AuthorizedUser: """ @@ -43,44 +49,8 @@ def authorized_by(self, *, request_options: typing.Optional[RequestOptions] = No ) client.token.authorized_by() """ - _response = self._client_wrapper.httpx_client.request( - "token/authorized_by", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - AuthorizedUser, - parse_obj_as( - type_=AuthorizedUser, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.authorized_by(request_options=request_options) + return _response.data def introspect(self, *, request_options: typing.Optional[RequestOptions] = None) -> Authorization: """ @@ -107,39 +77,24 @@ def introspect(self, *, request_options: typing.Optional[RequestOptions] = None) ) client.token.introspect() """ - _response = self._client_wrapper.httpx_client.request( - "token/introspect", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Authorization, - parse_obj_as( - type_=Authorization, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.introspect(request_options=request_options) + return _response.data class AsyncTokenClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = AsyncRawTokenClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawTokenClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawTokenClient + """ + return self._raw_client async def authorized_by(self, *, request_options: typing.Optional[RequestOptions] = None) -> AuthorizedUser: """ @@ -174,44 +129,8 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - "token/authorized_by", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - AuthorizedUser, - parse_obj_as( - type_=AuthorizedUser, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.authorized_by(request_options=request_options) + return _response.data async def introspect(self, *, request_options: typing.Optional[RequestOptions] = None) -> Authorization: """ @@ -246,31 +165,5 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - "token/introspect", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Authorization, - parse_obj_as( - type_=Authorization, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.introspect(request_options=request_options) + return _response.data diff --git a/src/webflow/resources/token/raw_client.py b/src/webflow/resources/token/raw_client.py new file mode 100644 index 0000000..ea49a25 --- /dev/null +++ b/src/webflow/resources/token/raw_client.py @@ -0,0 +1,261 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing +from json.decoder import JSONDecodeError + +from ...core.api_error import ApiError +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from ...core.http_response import AsyncHttpResponse, HttpResponse +from ...core.parse_error import ParsingError +from ...core.pydantic_utilities import parse_obj_as +from ...core.request_options import RequestOptions +from ...errors.forbidden_error import ForbiddenError +from ...errors.unauthorized_error import UnauthorizedError +from ...types.authorization import Authorization +from ...types.authorized_user import AuthorizedUser +from ...types.error import Error +from pydantic import ValidationError + + +class RawTokenClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def authorized_by(self, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[AuthorizedUser]: + """ + Information about the Authorized User + + Required Scope | `authorized_user:read` + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[AuthorizedUser] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + "token/authorized_by", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + AuthorizedUser, + parse_obj_as( + type_=AuthorizedUser, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def introspect(self, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[Authorization]: + """ + Information about the authorization token + + Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Authorization] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + "token/introspect", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Authorization, + parse_obj_as( + type_=Authorization, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawTokenClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def authorized_by( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[AuthorizedUser]: + """ + Information about the Authorized User + + Required Scope | `authorized_user:read` + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[AuthorizedUser] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + "token/authorized_by", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + AuthorizedUser, + parse_obj_as( + type_=AuthorizedUser, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def introspect( + self, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[Authorization]: + """ + Information about the authorization token + + Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + + Parameters + ---------- + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Authorization] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + "token/introspect", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Authorization, + parse_obj_as( + type_=Authorization, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/users/__init__.py b/src/webflow/resources/users/__init__.py deleted file mode 100644 index 88e72a2..0000000 --- a/src/webflow/resources/users/__init__.py +++ /dev/null @@ -1,5 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from .types import UsersListRequestSort, UsersUpdateRequestData - -__all__ = ["UsersListRequestSort", "UsersUpdateRequestData"] diff --git a/src/webflow/resources/users/client.py b/src/webflow/resources/users/client.py deleted file mode 100644 index d690c0f..0000000 --- a/src/webflow/resources/users/client.py +++ /dev/null @@ -1,1370 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing -from ...core.client_wrapper import SyncClientWrapper -from .types.users_list_request_sort import UsersListRequestSort -from ...core.request_options import RequestOptions -from ...types.user_list import UserList -from ...core.jsonable_encoder import jsonable_encoder -from ...core.pydantic_utilities import parse_obj_as -from ...errors.bad_request_error import BadRequestError -from ...errors.unauthorized_error import UnauthorizedError -from ...types.error import Error -from ...errors.forbidden_error import ForbiddenError -from ...errors.not_found_error import NotFoundError -from ...errors.too_many_requests_error import TooManyRequestsError -from ...errors.internal_server_error import InternalServerError -from json.decoder import JSONDecodeError -from ...core.api_error import ApiError -from ...types.user import User -from .types.users_update_request_data import UsersUpdateRequestData -from ...core.serialization import convert_and_respect_annotation_metadata -from ...errors.conflict_error import ConflictError -from ...core.client_wrapper import AsyncClientWrapper - -# this is used as the default value for optional parameters -OMIT = typing.cast(typing.Any, ...) - - -class UsersClient: - def __init__(self, *, client_wrapper: SyncClientWrapper): - self._client_wrapper = client_wrapper - - def list( - self, - site_id: str, - *, - offset: typing.Optional[float] = None, - limit: typing.Optional[float] = None, - sort: typing.Optional[UsersListRequestSort] = None, - request_options: typing.Optional[RequestOptions] = None, - ) -> UserList: - """ - Get a list of users for a site - - Required scope | `users:read` - - Parameters - ---------- - site_id : str - Unique identifier for a Site - - offset : typing.Optional[float] - Offset used for pagination if the results have more than limit records - - limit : typing.Optional[float] - Maximum number of records to be returned (max limit: 100) - - sort : typing.Optional[UsersListRequestSort] - Sort string to use when ordering users - - Example(`CreatedOn`, `Email`, `Status`, `LastLogin`, `UpdatedOn`). - - Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) - - request_options : typing.Optional[RequestOptions] - Request-specific configuration. - - Returns - ------- - UserList - Request was successful - - Examples - -------- - from webflow import Webflow - - client = Webflow( - access_token="YOUR_ACCESS_TOKEN", - ) - client.users.list( - site_id="580e63e98c9a982ac9b8b741", - ) - """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/users", - method="GET", - params={ - "offset": offset, - "limit": limit, - "sort": sort, - }, - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - UserList, - parse_obj_as( - type_=UserList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) - - def get(self, site_id: str, user_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> User: - """ - Get a User by ID - - Required scope | `users:read` - - Parameters - ---------- - site_id : str - Unique identifier for a Site - - user_id : str - Unique identifier for a User - - request_options : typing.Optional[RequestOptions] - Request-specific configuration. - - Returns - ------- - User - Request was successful - - Examples - -------- - from webflow import Webflow - - client = Webflow( - access_token="YOUR_ACCESS_TOKEN", - ) - client.users.get( - site_id="580e63e98c9a982ac9b8b741", - user_id="580e63e98c9a982ac9b8b741", - ) - """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/users/{jsonable_encoder(user_id)}", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - User, - parse_obj_as( - type_=User, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) - - def delete(self, site_id: str, user_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None: - """ - Delete a User by ID - - Required scope | `users:write` - - Parameters - ---------- - site_id : str - Unique identifier for a Site - - user_id : str - Unique identifier for a User - - request_options : typing.Optional[RequestOptions] - Request-specific configuration. - - Returns - ------- - None - - Examples - -------- - from webflow import Webflow - - client = Webflow( - access_token="YOUR_ACCESS_TOKEN", - ) - client.users.delete( - site_id="580e63e98c9a982ac9b8b741", - user_id="580e63e98c9a982ac9b8b741", - ) - """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/users/{jsonable_encoder(user_id)}", - method="DELETE", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) - - def update( - self, - site_id: str, - user_id: str, - *, - data: typing.Optional[UsersUpdateRequestData] = OMIT, - access_groups: typing.Optional[typing.Sequence[str]] = OMIT, - request_options: typing.Optional[RequestOptions] = None, - ) -> User: - """ - Update a User by ID - - Required scope | `users:write` - - The email and password - fields cannot be updated using this endpoint - - Parameters - ---------- - site_id : str - Unique identifier for a Site - - user_id : str - Unique identifier for a User - - data : typing.Optional[UsersUpdateRequestData] - - access_groups : typing.Optional[typing.Sequence[str]] - An array of access group slugs. Access groups are assigned to the user as type `admin` and the user remains in the group until removed. - - - request_options : typing.Optional[RequestOptions] - Request-specific configuration. - - Returns - ------- - User - Request was successful - - Examples - -------- - from webflow import Webflow - from webflow.resources.users import UsersUpdateRequestData - - client = Webflow( - access_token="YOUR_ACCESS_TOKEN", - ) - client.users.update( - site_id="580e63e98c9a982ac9b8b741", - user_id="580e63e98c9a982ac9b8b741", - data=UsersUpdateRequestData( - name="Some One", - accept_privacy=False, - accept_communications=False, - ), - access_groups=["webflowers", "platinum", "free-tier"], - ) - """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/users/{jsonable_encoder(user_id)}", - method="PATCH", - json={ - "data": convert_and_respect_annotation_metadata( - object_=data, annotation=UsersUpdateRequestData, direction="write" - ), - "accessGroups": access_groups, - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - User, - parse_obj_as( - type_=User, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) - - def invite( - self, - site_id: str, - *, - email: str, - access_groups: typing.Optional[typing.Sequence[str]] = OMIT, - request_options: typing.Optional[RequestOptions] = None, - ) -> User: - """ - Create and invite a user with an email address. - - The user will be sent and invite via email, which they will need to accept in order to join paid any paid access group. - - Required scope | `users:write` - - Parameters - ---------- - site_id : str - Unique identifier for a Site - - email : str - Email address of user to send invite to - - access_groups : typing.Optional[typing.Sequence[str]] - An array of access group slugs. Access groups are assigned to the user as type `admin` and the user remains in the group until removed. - - - request_options : typing.Optional[RequestOptions] - Request-specific configuration. - - Returns - ------- - User - Request was successful - - Examples - -------- - from webflow import Webflow - - client = Webflow( - access_token="YOUR_ACCESS_TOKEN", - ) - client.users.invite( - site_id="580e63e98c9a982ac9b8b741", - email="some.one@home.com", - access_groups=["webflowers"], - ) - """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/users/invite", - method="POST", - json={ - "email": email, - "accessGroups": access_groups, - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - User, - parse_obj_as( - type_=User, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) - - -class AsyncUsersClient: - def __init__(self, *, client_wrapper: AsyncClientWrapper): - self._client_wrapper = client_wrapper - - async def list( - self, - site_id: str, - *, - offset: typing.Optional[float] = None, - limit: typing.Optional[float] = None, - sort: typing.Optional[UsersListRequestSort] = None, - request_options: typing.Optional[RequestOptions] = None, - ) -> UserList: - """ - Get a list of users for a site - - Required scope | `users:read` - - Parameters - ---------- - site_id : str - Unique identifier for a Site - - offset : typing.Optional[float] - Offset used for pagination if the results have more than limit records - - limit : typing.Optional[float] - Maximum number of records to be returned (max limit: 100) - - sort : typing.Optional[UsersListRequestSort] - Sort string to use when ordering users - - Example(`CreatedOn`, `Email`, `Status`, `LastLogin`, `UpdatedOn`). - - Can be prefixed with a `-` to reverse the sort (ex. `-CreatedOn`) - - request_options : typing.Optional[RequestOptions] - Request-specific configuration. - - Returns - ------- - UserList - Request was successful - - Examples - -------- - import asyncio - - from webflow import AsyncWebflow - - client = AsyncWebflow( - access_token="YOUR_ACCESS_TOKEN", - ) - - - async def main() -> None: - await client.users.list( - site_id="580e63e98c9a982ac9b8b741", - ) - - - asyncio.run(main()) - """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/users", - method="GET", - params={ - "offset": offset, - "limit": limit, - "sort": sort, - }, - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - UserList, - parse_obj_as( - type_=UserList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) - - async def get(self, site_id: str, user_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> User: - """ - Get a User by ID - - Required scope | `users:read` - - Parameters - ---------- - site_id : str - Unique identifier for a Site - - user_id : str - Unique identifier for a User - - request_options : typing.Optional[RequestOptions] - Request-specific configuration. - - Returns - ------- - User - Request was successful - - Examples - -------- - import asyncio - - from webflow import AsyncWebflow - - client = AsyncWebflow( - access_token="YOUR_ACCESS_TOKEN", - ) - - - async def main() -> None: - await client.users.get( - site_id="580e63e98c9a982ac9b8b741", - user_id="580e63e98c9a982ac9b8b741", - ) - - - asyncio.run(main()) - """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/users/{jsonable_encoder(user_id)}", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - User, - parse_obj_as( - type_=User, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) - - async def delete( - self, site_id: str, user_id: str, *, request_options: typing.Optional[RequestOptions] = None - ) -> None: - """ - Delete a User by ID - - Required scope | `users:write` - - Parameters - ---------- - site_id : str - Unique identifier for a Site - - user_id : str - Unique identifier for a User - - request_options : typing.Optional[RequestOptions] - Request-specific configuration. - - Returns - ------- - None - - Examples - -------- - import asyncio - - from webflow import AsyncWebflow - - client = AsyncWebflow( - access_token="YOUR_ACCESS_TOKEN", - ) - - - async def main() -> None: - await client.users.delete( - site_id="580e63e98c9a982ac9b8b741", - user_id="580e63e98c9a982ac9b8b741", - ) - - - asyncio.run(main()) - """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/users/{jsonable_encoder(user_id)}", - method="DELETE", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) - - async def update( - self, - site_id: str, - user_id: str, - *, - data: typing.Optional[UsersUpdateRequestData] = OMIT, - access_groups: typing.Optional[typing.Sequence[str]] = OMIT, - request_options: typing.Optional[RequestOptions] = None, - ) -> User: - """ - Update a User by ID - - Required scope | `users:write` - - The email and password - fields cannot be updated using this endpoint - - Parameters - ---------- - site_id : str - Unique identifier for a Site - - user_id : str - Unique identifier for a User - - data : typing.Optional[UsersUpdateRequestData] - - access_groups : typing.Optional[typing.Sequence[str]] - An array of access group slugs. Access groups are assigned to the user as type `admin` and the user remains in the group until removed. - - - request_options : typing.Optional[RequestOptions] - Request-specific configuration. - - Returns - ------- - User - Request was successful - - Examples - -------- - import asyncio - - from webflow import AsyncWebflow - from webflow.resources.users import UsersUpdateRequestData - - client = AsyncWebflow( - access_token="YOUR_ACCESS_TOKEN", - ) - - - async def main() -> None: - await client.users.update( - site_id="580e63e98c9a982ac9b8b741", - user_id="580e63e98c9a982ac9b8b741", - data=UsersUpdateRequestData( - name="Some One", - accept_privacy=False, - accept_communications=False, - ), - access_groups=["webflowers", "platinum", "free-tier"], - ) - - - asyncio.run(main()) - """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/users/{jsonable_encoder(user_id)}", - method="PATCH", - json={ - "data": convert_and_respect_annotation_metadata( - object_=data, annotation=UsersUpdateRequestData, direction="write" - ), - "accessGroups": access_groups, - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - User, - parse_obj_as( - type_=User, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) - - async def invite( - self, - site_id: str, - *, - email: str, - access_groups: typing.Optional[typing.Sequence[str]] = OMIT, - request_options: typing.Optional[RequestOptions] = None, - ) -> User: - """ - Create and invite a user with an email address. - - The user will be sent and invite via email, which they will need to accept in order to join paid any paid access group. - - Required scope | `users:write` - - Parameters - ---------- - site_id : str - Unique identifier for a Site - - email : str - Email address of user to send invite to - - access_groups : typing.Optional[typing.Sequence[str]] - An array of access group slugs. Access groups are assigned to the user as type `admin` and the user remains in the group until removed. - - - request_options : typing.Optional[RequestOptions] - Request-specific configuration. - - Returns - ------- - User - Request was successful - - Examples - -------- - import asyncio - - from webflow import AsyncWebflow - - client = AsyncWebflow( - access_token="YOUR_ACCESS_TOKEN", - ) - - - async def main() -> None: - await client.users.invite( - site_id="580e63e98c9a982ac9b8b741", - email="some.one@home.com", - access_groups=["webflowers"], - ) - - - asyncio.run(main()) - """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/users/invite", - method="POST", - json={ - "email": email, - "accessGroups": access_groups, - }, - headers={ - "content-type": "application/json", - }, - request_options=request_options, - omit=OMIT, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - User, - parse_obj_as( - type_=User, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 403: - raise ForbiddenError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 409: - raise ConflictError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) diff --git a/src/webflow/resources/users/types/__init__.py b/src/webflow/resources/users/types/__init__.py deleted file mode 100644 index cadf367..0000000 --- a/src/webflow/resources/users/types/__init__.py +++ /dev/null @@ -1,6 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from .users_list_request_sort import UsersListRequestSort -from .users_update_request_data import UsersUpdateRequestData - -__all__ = ["UsersListRequestSort", "UsersUpdateRequestData"] diff --git a/src/webflow/resources/users/types/users_list_request_sort.py b/src/webflow/resources/users/types/users_list_request_sort.py deleted file mode 100644 index e4143a4..0000000 --- a/src/webflow/resources/users/types/users_list_request_sort.py +++ /dev/null @@ -1,19 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -UsersListRequestSort = typing.Union[ - typing.Literal[ - "CreatedOn", - "-CreatedOn", - "Email", - "-Email", - "Status", - "-Status", - "LastLogin", - "-LastLogin", - "UpdatedOn", - "-UpdatedOn", - ], - typing.Any, -] diff --git a/src/webflow/resources/users/types/users_update_request_data.py b/src/webflow/resources/users/types/users_update_request_data.py deleted file mode 100644 index 919406c..0000000 --- a/src/webflow/resources/users/types/users_update_request_data.py +++ /dev/null @@ -1,38 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from ....core.pydantic_utilities import UniversalBaseModel -import typing -import pydantic -import typing_extensions -from ....core.serialization import FieldMetadata -from ....core.pydantic_utilities import IS_PYDANTIC_V2 - - -class UsersUpdateRequestData(UniversalBaseModel): - name: typing.Optional[str] = pydantic.Field(default=None) - """ - The name of the user - """ - - accept_privacy: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="accept-privacy")] = ( - pydantic.Field(default=None) - ) - """ - Boolean indicating if the user has accepted the privacy policy - """ - - accept_communications: typing_extensions.Annotated[ - typing.Optional[bool], FieldMetadata(alias="accept-communications") - ] = pydantic.Field(default=None) - """ - Boolean indicating if the user has accepted to receive communications - """ - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow diff --git a/src/webflow/resources/webhooks/__init__.py b/src/webflow/resources/webhooks/__init__.py index f3ea265..5cde020 100644 --- a/src/webflow/resources/webhooks/__init__.py +++ b/src/webflow/resources/webhooks/__init__.py @@ -1,2 +1,4 @@ # This file was auto-generated by Fern from our API Definition. +# isort: skip_file + diff --git a/src/webflow/resources/webhooks/client.py b/src/webflow/resources/webhooks/client.py index ded9a2f..4360526 100644 --- a/src/webflow/resources/webhooks/client.py +++ b/src/webflow/resources/webhooks/client.py @@ -1,25 +1,15 @@ # This file was auto-generated by Fern from our API Definition. +import datetime as dt import typing -from ...core.client_wrapper import SyncClientWrapper + +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper from ...core.request_options import RequestOptions -from ...types.webhook_list import WebhookList -from ...core.jsonable_encoder import jsonable_encoder -from ...core.pydantic_utilities import parse_obj_as -from ...errors.bad_request_error import BadRequestError -from ...errors.unauthorized_error import UnauthorizedError -from ...types.error import Error -from ...errors.not_found_error import NotFoundError -from ...errors.too_many_requests_error import TooManyRequestsError -from ...errors.internal_server_error import InternalServerError -from json.decoder import JSONDecodeError -from ...core.api_error import ApiError from ...types.trigger_type import TriggerType -from ...types.webhook_filter import WebhookFilter -import datetime as dt from ...types.webhook import Webhook -from ...core.serialization import convert_and_respect_annotation_metadata -from ...core.client_wrapper import AsyncClientWrapper +from ...types.webhook_filter import WebhookFilter +from ...types.webhook_list import WebhookList +from .raw_client import AsyncRawWebhooksClient, RawWebhooksClient # this is used as the default value for optional parameters OMIT = typing.cast(typing.Any, ...) @@ -27,7 +17,18 @@ class WebhooksClient: def __init__(self, *, client_wrapper: SyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = RawWebhooksClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawWebhooksClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawWebhooksClient + """ + return self._raw_client def list(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> WebhookList: """ @@ -59,74 +60,8 @@ def list(self, site_id: str, *, request_options: typing.Optional[RequestOptions] site_id="580e63e98c9a982ac9b8b741", ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/webhooks", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - WebhookList, - parse_obj_as( - type_=WebhookList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.list(site_id, request_options=request_options) + return _response.data def create( self, @@ -210,87 +145,19 @@ def create( ), ) """ - _response = self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id_)}/webhooks", - method="POST", - json={ - "id": id, - "triggerType": trigger_type, - "url": url, - "workspaceId": workspace_id, - "siteId": site_id, - "filter": convert_and_respect_annotation_metadata( - object_=filter, annotation=WebhookFilter, direction="write" - ), - "lastTriggered": last_triggered, - "createdOn": created_on, - }, + _response = self._raw_client.create( + site_id_, + id=id, + trigger_type=trigger_type, + url=url, + workspace_id=workspace_id, + site_id=site_id, + filter=filter, + last_triggered=last_triggered, + created_on=created_on, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Webhook, - parse_obj_as( - type_=Webhook, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data def get(self, webhook_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Webhook: """ @@ -322,74 +189,8 @@ def get(self, webhook_id: str, *, request_options: typing.Optional[RequestOption webhook_id="580e64008c9a982ac9b8b754", ) """ - _response = self._client_wrapper.httpx_client.request( - f"webhooks/{jsonable_encoder(webhook_id)}", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Webhook, - parse_obj_as( - type_=Webhook, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.get(webhook_id, request_options=request_options) + return _response.data def delete(self, webhook_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ @@ -420,73 +221,24 @@ def delete(self, webhook_id: str, *, request_options: typing.Optional[RequestOpt webhook_id="580e64008c9a982ac9b8b754", ) """ - _response = self._client_wrapper.httpx_client.request( - f"webhooks/{jsonable_encoder(webhook_id)}", - method="DELETE", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = self._raw_client.delete(webhook_id, request_options=request_options) + return _response.data class AsyncWebhooksClient: def __init__(self, *, client_wrapper: AsyncClientWrapper): - self._client_wrapper = client_wrapper + self._raw_client = AsyncRawWebhooksClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawWebhooksClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawWebhooksClient + """ + return self._raw_client async def list(self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> WebhookList: """ @@ -526,74 +278,8 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id)}/webhooks", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - WebhookList, - parse_obj_as( - type_=WebhookList, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.list(site_id, request_options=request_options) + return _response.data async def create( self, @@ -684,87 +370,19 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"sites/{jsonable_encoder(site_id_)}/webhooks", - method="POST", - json={ - "id": id, - "triggerType": trigger_type, - "url": url, - "workspaceId": workspace_id, - "siteId": site_id, - "filter": convert_and_respect_annotation_metadata( - object_=filter, annotation=WebhookFilter, direction="write" - ), - "lastTriggered": last_triggered, - "createdOn": created_on, - }, + _response = await self._raw_client.create( + site_id_, + id=id, + trigger_type=trigger_type, + url=url, + workspace_id=workspace_id, + site_id=site_id, + filter=filter, + last_triggered=last_triggered, + created_on=created_on, request_options=request_options, - omit=OMIT, ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Webhook, - parse_obj_as( - type_=Webhook, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + return _response.data async def get(self, webhook_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> Webhook: """ @@ -804,74 +422,8 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"webhooks/{jsonable_encoder(webhook_id)}", - method="GET", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return typing.cast( - Webhook, - parse_obj_as( - type_=Webhook, # type: ignore - object_=_response.json(), - ), - ) - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.get(webhook_id, request_options=request_options) + return _response.data async def delete(self, webhook_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> None: """ @@ -910,65 +462,5 @@ async def main() -> None: asyncio.run(main()) """ - _response = await self._client_wrapper.httpx_client.request( - f"webhooks/{jsonable_encoder(webhook_id)}", - method="DELETE", - request_options=request_options, - ) - try: - if 200 <= _response.status_code < 300: - return - if _response.status_code == 400: - raise BadRequestError( - typing.cast( - typing.Optional[typing.Any], - parse_obj_as( - type_=typing.Optional[typing.Any], # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 401: - raise UnauthorizedError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 404: - raise NotFoundError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 429: - raise TooManyRequestsError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - if _response.status_code == 500: - raise InternalServerError( - typing.cast( - Error, - parse_obj_as( - type_=Error, # type: ignore - object_=_response.json(), - ), - ) - ) - _response_json = _response.json() - except JSONDecodeError: - raise ApiError(status_code=_response.status_code, body=_response.text) - raise ApiError(status_code=_response.status_code, body=_response_json) + _response = await self._raw_client.delete(webhook_id, request_options=request_options) + return _response.data diff --git a/src/webflow/resources/webhooks/raw_client.py b/src/webflow/resources/webhooks/raw_client.py new file mode 100644 index 0000000..ca4462d --- /dev/null +++ b/src/webflow/resources/webhooks/raw_client.py @@ -0,0 +1,932 @@ +# This file was auto-generated by Fern from our API Definition. + +import datetime as dt +import typing +from json.decoder import JSONDecodeError + +from ...core.api_error import ApiError +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from ...core.http_response import AsyncHttpResponse, HttpResponse +from ...core.jsonable_encoder import jsonable_encoder +from ...core.parse_error import ParsingError +from ...core.pydantic_utilities import parse_obj_as +from ...core.request_options import RequestOptions +from ...core.serialization import convert_and_respect_annotation_metadata +from ...errors.bad_request_error import BadRequestError +from ...errors.internal_server_error import InternalServerError +from ...errors.not_found_error import NotFoundError +from ...errors.too_many_requests_error import TooManyRequestsError +from ...errors.unauthorized_error import UnauthorizedError +from ...types.error import Error +from ...types.trigger_type import TriggerType +from ...types.webhook import Webhook +from ...types.webhook_filter import WebhookFilter +from ...types.webhook_list import WebhookList +from pydantic import ValidationError + +# this is used as the default value for optional parameters +OMIT = typing.cast(typing.Any, ...) + + +class RawWebhooksClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def list( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> HttpResponse[WebhookList]: + """ + List all App-created Webhooks registered for a given site + + Required scope | `sites:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[WebhookList] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/webhooks", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + WebhookList, + parse_obj_as( + type_=WebhookList, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def create( + self, + site_id_: str, + *, + id: typing.Optional[str] = OMIT, + trigger_type: typing.Optional[TriggerType] = OMIT, + url: typing.Optional[str] = OMIT, + workspace_id: typing.Optional[str] = OMIT, + site_id: typing.Optional[str] = OMIT, + filter: typing.Optional[WebhookFilter] = OMIT, + last_triggered: typing.Optional[dt.datetime] = OMIT, + created_on: typing.Optional[dt.datetime] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[Webhook]: + """ + Create a new Webhook. + + Limit of 75 registrations per `triggerType`, per site. + + Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + Required scope | `sites:write` + + Parameters + ---------- + site_id_ : str + Unique identifier for a Site + + id : typing.Optional[str] + Unique identifier for the Webhook registration + + trigger_type : typing.Optional[TriggerType] + + url : typing.Optional[str] + URL to send the Webhook payload to + + workspace_id : typing.Optional[str] + Unique identifier for the Workspace the Webhook is registered in + + site_id : typing.Optional[str] + Unique identifier for the Site the Webhook is registered in + + filter : typing.Optional[WebhookFilter] + Only supported for the `form_submission` trigger type. Filter for the form you want Webhooks to be sent for. + + last_triggered : typing.Optional[dt.datetime] + Date the Webhook instance was last triggered + + created_on : typing.Optional[dt.datetime] + Date the Webhook registration was created + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Webhook] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id_)}/webhooks", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "id": id, + "triggerType": trigger_type, + "url": url, + "workspaceId": workspace_id, + "siteId": site_id, + "filter": convert_and_respect_annotation_metadata( + object_=filter, annotation=WebhookFilter, direction="write" + ), + "lastTriggered": last_triggered, + "createdOn": created_on, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Webhook, + parse_obj_as( + type_=Webhook, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def get(self, webhook_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[Webhook]: + """ + Get a specific Webhook instance + + Required scope: `sites:read` + + Parameters + ---------- + webhook_id : str + Unique identifier for a Webhook + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[Webhook] + Request was successful + """ + _response = self._client_wrapper.httpx_client.request( + f"webhooks/{jsonable_encoder(webhook_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Webhook, + parse_obj_as( + type_=Webhook, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + def delete(self, webhook_id: str, *, request_options: typing.Optional[RequestOptions] = None) -> HttpResponse[None]: + """ + Remove a Webhook + + Required scope: `sites:read` + + Parameters + ---------- + webhook_id : str + Unique identifier for a Webhook + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[None] + """ + _response = self._client_wrapper.httpx_client.request( + f"webhooks/{jsonable_encoder(webhook_id)}", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return HttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawWebhooksClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def list( + self, site_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[WebhookList]: + """ + List all App-created Webhooks registered for a given site + + Required scope | `sites:read` + + Parameters + ---------- + site_id : str + Unique identifier for a Site + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[WebhookList] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id)}/webhooks", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + WebhookList, + parse_obj_as( + type_=WebhookList, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def create( + self, + site_id_: str, + *, + id: typing.Optional[str] = OMIT, + trigger_type: typing.Optional[TriggerType] = OMIT, + url: typing.Optional[str] = OMIT, + workspace_id: typing.Optional[str] = OMIT, + site_id: typing.Optional[str] = OMIT, + filter: typing.Optional[WebhookFilter] = OMIT, + last_triggered: typing.Optional[dt.datetime] = OMIT, + created_on: typing.Optional[dt.datetime] = OMIT, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[Webhook]: + """ + Create a new Webhook. + + Limit of 75 registrations per `triggerType`, per site. + + Access to this endpoint requires a bearer token from a [Data Client App](/data/docs/getting-started-data-clients). + Required scope | `sites:write` + + Parameters + ---------- + site_id_ : str + Unique identifier for a Site + + id : typing.Optional[str] + Unique identifier for the Webhook registration + + trigger_type : typing.Optional[TriggerType] + + url : typing.Optional[str] + URL to send the Webhook payload to + + workspace_id : typing.Optional[str] + Unique identifier for the Workspace the Webhook is registered in + + site_id : typing.Optional[str] + Unique identifier for the Site the Webhook is registered in + + filter : typing.Optional[WebhookFilter] + Only supported for the `form_submission` trigger type. Filter for the form you want Webhooks to be sent for. + + last_triggered : typing.Optional[dt.datetime] + Date the Webhook instance was last triggered + + created_on : typing.Optional[dt.datetime] + Date the Webhook registration was created + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Webhook] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"sites/{jsonable_encoder(site_id_)}/webhooks", + base_url=self._client_wrapper.get_environment().base, + method="POST", + json={ + "id": id, + "triggerType": trigger_type, + "url": url, + "workspaceId": workspace_id, + "siteId": site_id, + "filter": convert_and_respect_annotation_metadata( + object_=filter, annotation=WebhookFilter, direction="write" + ), + "lastTriggered": last_triggered, + "createdOn": created_on, + }, + headers={ + "content-type": "application/json", + }, + request_options=request_options, + omit=OMIT, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Webhook, + parse_obj_as( + type_=Webhook, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def get( + self, webhook_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[Webhook]: + """ + Get a specific Webhook instance + + Required scope: `sites:read` + + Parameters + ---------- + webhook_id : str + Unique identifier for a Webhook + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[Webhook] + Request was successful + """ + _response = await self._client_wrapper.httpx_client.request( + f"webhooks/{jsonable_encoder(webhook_id)}", + base_url=self._client_wrapper.get_environment().base, + method="GET", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + Webhook, + parse_obj_as( + type_=Webhook, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + async def delete( + self, webhook_id: str, *, request_options: typing.Optional[RequestOptions] = None + ) -> AsyncHttpResponse[None]: + """ + Remove a Webhook + + Required scope: `sites:read` + + Parameters + ---------- + webhook_id : str + Unique identifier for a Webhook + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[None] + """ + _response = await self._client_wrapper.httpx_client.request( + f"webhooks/{jsonable_encoder(webhook_id)}", + base_url=self._client_wrapper.get_environment().base, + method="DELETE", + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + return AsyncHttpResponse(response=_response, data=None) + if _response.status_code == 400: + raise BadRequestError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/workspaces/__init__.py b/src/webflow/resources/workspaces/__init__.py new file mode 100644 index 0000000..dd54dbd --- /dev/null +++ b/src/webflow/resources/workspaces/__init__.py @@ -0,0 +1,46 @@ +# This file was auto-generated by Fern from our API Definition. + +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .resources import ( + AuditLogsGetWorkspaceAuditLogsRequestEventType, + AuditLogsGetWorkspaceAuditLogsRequestSortOrder, + audit_logs, + ) +_dynamic_imports: typing.Dict[str, str] = { + "AuditLogsGetWorkspaceAuditLogsRequestEventType": ".resources", + "AuditLogsGetWorkspaceAuditLogsRequestSortOrder": ".resources", + "audit_logs": ".resources", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + + +__all__ = [ + "AuditLogsGetWorkspaceAuditLogsRequestEventType", + "AuditLogsGetWorkspaceAuditLogsRequestSortOrder", + "audit_logs", +] diff --git a/src/webflow/resources/workspaces/client.py b/src/webflow/resources/workspaces/client.py new file mode 100644 index 0000000..4b6aa91 --- /dev/null +++ b/src/webflow/resources/workspaces/client.py @@ -0,0 +1,63 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations + +import typing + +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from .raw_client import AsyncRawWorkspacesClient, RawWorkspacesClient + +if typing.TYPE_CHECKING: + from .resources.audit_logs.client import AsyncAuditLogsClient, AuditLogsClient + + +class WorkspacesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawWorkspacesClient(client_wrapper=client_wrapper) + self._client_wrapper = client_wrapper + self._audit_logs: typing.Optional[AuditLogsClient] = None + + @property + def with_raw_response(self) -> RawWorkspacesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawWorkspacesClient + """ + return self._raw_client + + @property + def audit_logs(self): + if self._audit_logs is None: + from .resources.audit_logs.client import AuditLogsClient # noqa: E402 + + self._audit_logs = AuditLogsClient(client_wrapper=self._client_wrapper) + return self._audit_logs + + +class AsyncWorkspacesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawWorkspacesClient(client_wrapper=client_wrapper) + self._client_wrapper = client_wrapper + self._audit_logs: typing.Optional[AsyncAuditLogsClient] = None + + @property + def with_raw_response(self) -> AsyncRawWorkspacesClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawWorkspacesClient + """ + return self._raw_client + + @property + def audit_logs(self): + if self._audit_logs is None: + from .resources.audit_logs.client import AsyncAuditLogsClient # noqa: E402 + + self._audit_logs = AsyncAuditLogsClient(client_wrapper=self._client_wrapper) + return self._audit_logs diff --git a/src/webflow/resources/workspaces/raw_client.py b/src/webflow/resources/workspaces/raw_client.py new file mode 100644 index 0000000..8e98606 --- /dev/null +++ b/src/webflow/resources/workspaces/raw_client.py @@ -0,0 +1,13 @@ +# This file was auto-generated by Fern from our API Definition. + +from ...core.client_wrapper import AsyncClientWrapper, SyncClientWrapper + + +class RawWorkspacesClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + +class AsyncRawWorkspacesClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper diff --git a/src/webflow/resources/workspaces/resources/__init__.py b/src/webflow/resources/workspaces/resources/__init__.py new file mode 100644 index 0000000..a7bfbd2 --- /dev/null +++ b/src/webflow/resources/workspaces/resources/__init__.py @@ -0,0 +1,46 @@ +# This file was auto-generated by Fern from our API Definition. + +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from . import audit_logs + from .audit_logs import ( + AuditLogsGetWorkspaceAuditLogsRequestEventType, + AuditLogsGetWorkspaceAuditLogsRequestSortOrder, + ) +_dynamic_imports: typing.Dict[str, str] = { + "AuditLogsGetWorkspaceAuditLogsRequestEventType": ".audit_logs", + "AuditLogsGetWorkspaceAuditLogsRequestSortOrder": ".audit_logs", + "audit_logs": ".audit_logs", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + + +__all__ = [ + "AuditLogsGetWorkspaceAuditLogsRequestEventType", + "AuditLogsGetWorkspaceAuditLogsRequestSortOrder", + "audit_logs", +] diff --git a/src/webflow/resources/workspaces/resources/audit_logs/__init__.py b/src/webflow/resources/workspaces/resources/audit_logs/__init__.py new file mode 100644 index 0000000..2e698bb --- /dev/null +++ b/src/webflow/resources/workspaces/resources/audit_logs/__init__.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .types import AuditLogsGetWorkspaceAuditLogsRequestEventType, AuditLogsGetWorkspaceAuditLogsRequestSortOrder +_dynamic_imports: typing.Dict[str, str] = { + "AuditLogsGetWorkspaceAuditLogsRequestEventType": ".types", + "AuditLogsGetWorkspaceAuditLogsRequestSortOrder": ".types", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + + +__all__ = ["AuditLogsGetWorkspaceAuditLogsRequestEventType", "AuditLogsGetWorkspaceAuditLogsRequestSortOrder"] diff --git a/src/webflow/resources/workspaces/resources/audit_logs/client.py b/src/webflow/resources/workspaces/resources/audit_logs/client.py new file mode 100644 index 0000000..2572f43 --- /dev/null +++ b/src/webflow/resources/workspaces/resources/audit_logs/client.py @@ -0,0 +1,220 @@ +# This file was auto-generated by Fern from our API Definition. + +import datetime as dt +import typing + +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from .....core.request_options import RequestOptions +from .....types.workspace_audit_log_response import WorkspaceAuditLogResponse +from .raw_client import AsyncRawAuditLogsClient, RawAuditLogsClient +from .types.audit_logs_get_workspace_audit_logs_request_event_type import AuditLogsGetWorkspaceAuditLogsRequestEventType +from .types.audit_logs_get_workspace_audit_logs_request_sort_order import AuditLogsGetWorkspaceAuditLogsRequestSortOrder + + +class AuditLogsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._raw_client = RawAuditLogsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> RawAuditLogsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + RawAuditLogsClient + """ + return self._raw_client + + def get_workspace_audit_logs( + self, + workspace_id_or_slug: str, + *, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, + sort_order: typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestSortOrder] = None, + event_type: typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestEventType] = None, + from_: typing.Optional[dt.datetime] = None, + to: typing.Optional[dt.datetime] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> WorkspaceAuditLogResponse: + """ + Get audit logs for a workspace. + + This endpoint requires an Enterprise workspace and a workspace token with the `workspace_activity:read` scope. Create a workspace token from your workspace dashboard integrations page to use this endpoint. + + Required scope | `workspace_activity:read` + + Parameters + ---------- + workspace_id_or_slug : str + Unique identifier or slug for a Workspace + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + sort_order : typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestSortOrder] + Sorts the results by asc or desc + + event_type : typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestEventType] + The event type to filter by + + from_ : typing.Optional[dt.datetime] + The start date to filter by + + to : typing.Optional[dt.datetime] + The end date to filter by + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + WorkspaceAuditLogResponse + A list of workspace audit logs + + Examples + -------- + import datetime + + from webflow import Webflow + + client = Webflow( + access_token="YOUR_ACCESS_TOKEN", + ) + client.workspaces.audit_logs.get_workspace_audit_logs( + workspace_id_or_slug="hitchhikers-workspace", + limit=1, + offset=1, + sort_order="asc", + event_type="user_access", + from_=datetime.datetime.fromisoformat( + "2025-06-22 16:00:31+00:00", + ), + to=datetime.datetime.fromisoformat( + "2025-07-22 16:00:31+00:00", + ), + ) + """ + _response = self._raw_client.get_workspace_audit_logs( + workspace_id_or_slug, + limit=limit, + offset=offset, + sort_order=sort_order, + event_type=event_type, + from_=from_, + to=to, + request_options=request_options, + ) + return _response.data + + +class AsyncAuditLogsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._raw_client = AsyncRawAuditLogsClient(client_wrapper=client_wrapper) + + @property + def with_raw_response(self) -> AsyncRawAuditLogsClient: + """ + Retrieves a raw implementation of this client that returns raw responses. + + Returns + ------- + AsyncRawAuditLogsClient + """ + return self._raw_client + + async def get_workspace_audit_logs( + self, + workspace_id_or_slug: str, + *, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, + sort_order: typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestSortOrder] = None, + event_type: typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestEventType] = None, + from_: typing.Optional[dt.datetime] = None, + to: typing.Optional[dt.datetime] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> WorkspaceAuditLogResponse: + """ + Get audit logs for a workspace. + + This endpoint requires an Enterprise workspace and a workspace token with the `workspace_activity:read` scope. Create a workspace token from your workspace dashboard integrations page to use this endpoint. + + Required scope | `workspace_activity:read` + + Parameters + ---------- + workspace_id_or_slug : str + Unique identifier or slug for a Workspace + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + sort_order : typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestSortOrder] + Sorts the results by asc or desc + + event_type : typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestEventType] + The event type to filter by + + from_ : typing.Optional[dt.datetime] + The start date to filter by + + to : typing.Optional[dt.datetime] + The end date to filter by + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + WorkspaceAuditLogResponse + A list of workspace audit logs + + Examples + -------- + import asyncio + import datetime + + from webflow import AsyncWebflow + + client = AsyncWebflow( + access_token="YOUR_ACCESS_TOKEN", + ) + + + async def main() -> None: + await client.workspaces.audit_logs.get_workspace_audit_logs( + workspace_id_or_slug="hitchhikers-workspace", + limit=1, + offset=1, + sort_order="asc", + event_type="user_access", + from_=datetime.datetime.fromisoformat( + "2025-06-22 16:00:31+00:00", + ), + to=datetime.datetime.fromisoformat( + "2025-07-22 16:00:31+00:00", + ), + ) + + + asyncio.run(main()) + """ + _response = await self._raw_client.get_workspace_audit_logs( + workspace_id_or_slug, + limit=limit, + offset=offset, + sort_order=sort_order, + event_type=event_type, + from_=from_, + to=to, + request_options=request_options, + ) + return _response.data diff --git a/src/webflow/resources/workspaces/resources/audit_logs/raw_client.py b/src/webflow/resources/workspaces/resources/audit_logs/raw_client.py new file mode 100644 index 0000000..276afcc --- /dev/null +++ b/src/webflow/resources/workspaces/resources/audit_logs/raw_client.py @@ -0,0 +1,310 @@ +# This file was auto-generated by Fern from our API Definition. + +import datetime as dt +import typing +from json.decoder import JSONDecodeError + +from .....core.api_error import ApiError +from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper +from .....core.datetime_utils import serialize_datetime +from .....core.http_response import AsyncHttpResponse, HttpResponse +from .....core.jsonable_encoder import jsonable_encoder +from .....core.parse_error import ParsingError +from .....core.pydantic_utilities import parse_obj_as +from .....core.request_options import RequestOptions +from .....errors.forbidden_error import ForbiddenError +from .....errors.internal_server_error import InternalServerError +from .....errors.not_found_error import NotFoundError +from .....errors.too_many_requests_error import TooManyRequestsError +from .....errors.unauthorized_error import UnauthorizedError +from .....types.error import Error +from .....types.workspace_audit_log_response import WorkspaceAuditLogResponse +from .types.audit_logs_get_workspace_audit_logs_request_event_type import AuditLogsGetWorkspaceAuditLogsRequestEventType +from .types.audit_logs_get_workspace_audit_logs_request_sort_order import AuditLogsGetWorkspaceAuditLogsRequestSortOrder +from pydantic import ValidationError + + +class RawAuditLogsClient: + def __init__(self, *, client_wrapper: SyncClientWrapper): + self._client_wrapper = client_wrapper + + def get_workspace_audit_logs( + self, + workspace_id_or_slug: str, + *, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, + sort_order: typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestSortOrder] = None, + event_type: typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestEventType] = None, + from_: typing.Optional[dt.datetime] = None, + to: typing.Optional[dt.datetime] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> HttpResponse[WorkspaceAuditLogResponse]: + """ + Get audit logs for a workspace. + + This endpoint requires an Enterprise workspace and a workspace token with the `workspace_activity:read` scope. Create a workspace token from your workspace dashboard integrations page to use this endpoint. + + Required scope | `workspace_activity:read` + + Parameters + ---------- + workspace_id_or_slug : str + Unique identifier or slug for a Workspace + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + sort_order : typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestSortOrder] + Sorts the results by asc or desc + + event_type : typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestEventType] + The event type to filter by + + from_ : typing.Optional[dt.datetime] + The start date to filter by + + to : typing.Optional[dt.datetime] + The end date to filter by + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + HttpResponse[WorkspaceAuditLogResponse] + A list of workspace audit logs + """ + _response = self._client_wrapper.httpx_client.request( + f"workspaces/{jsonable_encoder(workspace_id_or_slug)}/audit_logs", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "limit": limit, + "offset": offset, + "sortOrder": sort_order, + "eventType": event_type, + "from": serialize_datetime(from_) if from_ is not None else None, + "to": serialize_datetime(to) if to is not None else None, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + WorkspaceAuditLogResponse, + parse_obj_as( + type_=WorkspaceAuditLogResponse, # type: ignore + object_=_response.json(), + ), + ) + return HttpResponse(response=_response, data=_data) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) + + +class AsyncRawAuditLogsClient: + def __init__(self, *, client_wrapper: AsyncClientWrapper): + self._client_wrapper = client_wrapper + + async def get_workspace_audit_logs( + self, + workspace_id_or_slug: str, + *, + limit: typing.Optional[int] = None, + offset: typing.Optional[int] = None, + sort_order: typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestSortOrder] = None, + event_type: typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestEventType] = None, + from_: typing.Optional[dt.datetime] = None, + to: typing.Optional[dt.datetime] = None, + request_options: typing.Optional[RequestOptions] = None, + ) -> AsyncHttpResponse[WorkspaceAuditLogResponse]: + """ + Get audit logs for a workspace. + + This endpoint requires an Enterprise workspace and a workspace token with the `workspace_activity:read` scope. Create a workspace token from your workspace dashboard integrations page to use this endpoint. + + Required scope | `workspace_activity:read` + + Parameters + ---------- + workspace_id_or_slug : str + Unique identifier or slug for a Workspace + + limit : typing.Optional[int] + Maximum number of records to be returned (max limit: 100) + + offset : typing.Optional[int] + Offset used for pagination if the results have more than limit records + + sort_order : typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestSortOrder] + Sorts the results by asc or desc + + event_type : typing.Optional[AuditLogsGetWorkspaceAuditLogsRequestEventType] + The event type to filter by + + from_ : typing.Optional[dt.datetime] + The start date to filter by + + to : typing.Optional[dt.datetime] + The end date to filter by + + request_options : typing.Optional[RequestOptions] + Request-specific configuration. + + Returns + ------- + AsyncHttpResponse[WorkspaceAuditLogResponse] + A list of workspace audit logs + """ + _response = await self._client_wrapper.httpx_client.request( + f"workspaces/{jsonable_encoder(workspace_id_or_slug)}/audit_logs", + base_url=self._client_wrapper.get_environment().base, + method="GET", + params={ + "limit": limit, + "offset": offset, + "sortOrder": sort_order, + "eventType": event_type, + "from": serialize_datetime(from_) if from_ is not None else None, + "to": serialize_datetime(to) if to is not None else None, + }, + request_options=request_options, + ) + try: + if 200 <= _response.status_code < 300: + _data = typing.cast( + WorkspaceAuditLogResponse, + parse_obj_as( + type_=WorkspaceAuditLogResponse, # type: ignore + object_=_response.json(), + ), + ) + return AsyncHttpResponse(response=_response, data=_data) + if _response.status_code == 401: + raise UnauthorizedError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 403: + raise ForbiddenError( + headers=dict(_response.headers), + body=typing.cast( + typing.Any, + parse_obj_as( + type_=typing.Any, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 404: + raise NotFoundError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 429: + raise TooManyRequestsError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + if _response.status_code == 500: + raise InternalServerError( + headers=dict(_response.headers), + body=typing.cast( + Error, + parse_obj_as( + type_=Error, # type: ignore + object_=_response.json(), + ), + ), + ) + _response_json = _response.json() + except JSONDecodeError: + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text) + except ValidationError as e: + raise ParsingError( + status_code=_response.status_code, headers=dict(_response.headers), body=_response.json(), cause=e + ) + raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json) diff --git a/src/webflow/resources/workspaces/resources/audit_logs/types/__init__.py b/src/webflow/resources/workspaces/resources/audit_logs/types/__init__.py new file mode 100644 index 0000000..c54f614 --- /dev/null +++ b/src/webflow/resources/workspaces/resources/audit_logs/types/__init__.py @@ -0,0 +1,38 @@ +# This file was auto-generated by Fern from our API Definition. + +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .audit_logs_get_workspace_audit_logs_request_event_type import AuditLogsGetWorkspaceAuditLogsRequestEventType + from .audit_logs_get_workspace_audit_logs_request_sort_order import AuditLogsGetWorkspaceAuditLogsRequestSortOrder +_dynamic_imports: typing.Dict[str, str] = { + "AuditLogsGetWorkspaceAuditLogsRequestEventType": ".audit_logs_get_workspace_audit_logs_request_event_type", + "AuditLogsGetWorkspaceAuditLogsRequestSortOrder": ".audit_logs_get_workspace_audit_logs_request_sort_order", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + + +__all__ = ["AuditLogsGetWorkspaceAuditLogsRequestEventType", "AuditLogsGetWorkspaceAuditLogsRequestSortOrder"] diff --git a/src/webflow/resources/workspaces/resources/audit_logs/types/audit_logs_get_workspace_audit_logs_request_event_type.py b/src/webflow/resources/workspaces/resources/audit_logs/types/audit_logs_get_workspace_audit_logs_request_event_type.py new file mode 100644 index 0000000..08c3185 --- /dev/null +++ b/src/webflow/resources/workspaces/resources/audit_logs/types/audit_logs_get_workspace_audit_logs_request_event_type.py @@ -0,0 +1,15 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +AuditLogsGetWorkspaceAuditLogsRequestEventType = typing.Union[ + typing.Literal[ + "user_access", + "custom_role", + "workspace_membership", + "site_membership", + "workspace_invitation", + "workspace_setting", + ], + typing.Any, +] diff --git a/src/webflow/resources/workspaces/resources/audit_logs/types/audit_logs_get_workspace_audit_logs_request_sort_order.py b/src/webflow/resources/workspaces/resources/audit_logs/types/audit_logs_get_workspace_audit_logs_request_sort_order.py new file mode 100644 index 0000000..dd90d5f --- /dev/null +++ b/src/webflow/resources/workspaces/resources/audit_logs/types/audit_logs_get_workspace_audit_logs_request_sort_order.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +AuditLogsGetWorkspaceAuditLogsRequestSortOrder = typing.Union[typing.Literal["asc", "desc"], typing.Any] diff --git a/src/webflow/types/__init__.py b/src/webflow/types/__init__.py index 5b2d8c6..88c0cbd 100644 --- a/src/webflow/types/__init__.py +++ b/src/webflow/types/__init__.py @@ -1,169 +1,603 @@ # This file was auto-generated by Fern from our API Definition. -from .access_group import AccessGroup -from .access_group_list import AccessGroupList -from .application import Application -from .asset import Asset -from .asset_folder import AssetFolder -from .asset_folder_list import AssetFolderList -from .asset_upload import AssetUpload -from .asset_upload_upload_details import AssetUploadUploadDetails -from .asset_variant import AssetVariant -from .assets import Assets -from .authorization import Authorization -from .authorization_authorization import AuthorizationAuthorization -from .authorization_authorization_authorized_to import AuthorizationAuthorizationAuthorizedTo -from .authorized_user import AuthorizedUser -from .bad_request_error_body import BadRequestErrorBody -from .bulk_collection_item import BulkCollectionItem -from .bulk_collection_item_field_data import BulkCollectionItemFieldData -from .collection import Collection -from .collection_item import CollectionItem -from .collection_item_field_data import CollectionItemFieldData -from .collection_item_list import CollectionItemList -from .collection_item_list_no_pagination import CollectionItemListNoPagination -from .collection_item_list_pagination import CollectionItemListPagination -from .collection_item_patch_single import CollectionItemPatchSingle -from .collection_item_patch_single_field_data import CollectionItemPatchSingleFieldData -from .collection_item_post_single import CollectionItemPostSingle -from .collection_item_post_single_field_data import CollectionItemPostSingleFieldData -from .collection_item_with_id_input import CollectionItemWithIdInput -from .collection_item_with_id_input_field_data import CollectionItemWithIdInputFieldData -from .collection_list import CollectionList -from .collection_list_array_item import CollectionListArrayItem -from .component import Component -from .component_dom import ComponentDom -from .component_instance_node_property_overrides_write import ComponentInstanceNodePropertyOverridesWrite -from .component_instance_node_property_overrides_write_property_overrides_item import ( - ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem, -) -from .component_list import ComponentList -from .component_node import ComponentNode -from .component_properties import ComponentProperties -from .component_property import ComponentProperty -from .component_property_type import ComponentPropertyType -from .conflict_error_body import ConflictErrorBody -from .custom_code_block import CustomCodeBlock -from .custom_code_block_type import CustomCodeBlockType -from .custom_code_hosted_response import CustomCodeHostedResponse -from .custom_code_inline_response import CustomCodeInlineResponse -from .dom import Dom -from .domain import Domain -from .domains import Domains -from .duplicate_user_email import DuplicateUserEmail -from .ecommerce_settings import EcommerceSettings -from .error import Error -from .error_code import ErrorCode -from .field import Field -from .field_type import FieldType -from .forbidden_error_body import ForbiddenErrorBody -from .form import Form -from .form_field import FormField -from .form_field_value import FormFieldValue -from .form_field_value_type import FormFieldValueType -from .form_list import FormList -from .form_response_settings import FormResponseSettings -from .form_submission import FormSubmission -from .form_submission_list import FormSubmissionList -from .image_node import ImageNode -from .image_node_image import ImageNodeImage -from .invalid_domain import InvalidDomain -from .invalid_scopes import InvalidScopes -from .inventory_item import InventoryItem -from .inventory_item_inventory_type import InventoryItemInventoryType -from .list_custom_code_blocks import ListCustomCodeBlocks -from .locale import Locale -from .locales import Locales -from .no_domains import NoDomains -from .node import Node, Node_ComponentInstance, Node_Image, Node_Text -from .not_enterprise_plan_site import NotEnterprisePlanSite -from .not_enterprise_plan_workspace import NotEnterprisePlanWorkspace -from .order import Order -from .order_address import OrderAddress -from .order_address_japan_type import OrderAddressJapanType -from .order_address_type import OrderAddressType -from .order_customer_info import OrderCustomerInfo -from .order_dispute_last_status import OrderDisputeLastStatus -from .order_download_files_item import OrderDownloadFilesItem -from .order_list import OrderList -from .order_metadata import OrderMetadata -from .order_price import OrderPrice -from .order_purchased_item import OrderPurchasedItem -from .order_purchased_item_variant_image import OrderPurchasedItemVariantImage -from .order_purchased_item_variant_image_file import OrderPurchasedItemVariantImageFile -from .order_purchased_item_variant_image_file_variants_item import OrderPurchasedItemVariantImageFileVariantsItem -from .order_status import OrderStatus -from .order_totals import OrderTotals -from .order_totals_extras_item import OrderTotalsExtrasItem -from .order_totals_extras_item_type import OrderTotalsExtrasItemType -from .page import Page -from .page_list import PageList -from .page_open_graph import PageOpenGraph -from .page_seo import PageSeo -from .pagination import Pagination -from .paypal_details import PaypalDetails -from .product import Product -from .product_and_sk_us import ProductAndSkUs -from .product_and_sk_us_list import ProductAndSkUsList -from .product_field_data import ProductFieldData -from .product_field_data_ec_product_type import ProductFieldDataEcProductType -from .product_field_data_tax_category import ProductFieldDataTaxCategory -from .publish_status import PublishStatus -from .redirect import Redirect -from .redirects import Redirects -from .registered_script_list import RegisteredScriptList -from .script_apply import ScriptApply -from .script_apply_list import ScriptApplyList -from .script_apply_location import ScriptApplyLocation -from .scripts import Scripts -from .site import Site -from .site_activity_log_item import SiteActivityLogItem -from .site_activity_log_item_event import SiteActivityLogItemEvent -from .site_activity_log_item_resource_operation import SiteActivityLogItemResourceOperation -from .site_activity_log_item_user import SiteActivityLogItemUser -from .site_activity_log_response import SiteActivityLogResponse -from .site_data_collection_type import SiteDataCollectionType -from .site_plan import SitePlan -from .site_plan_id import SitePlanId -from .site_plan_name import SitePlanName -from .sites import Sites -from .sku import Sku -from .sku_field_data import SkuFieldData -from .sku_field_data_compare_at_price import SkuFieldDataCompareAtPrice -from .sku_field_data_ec_sku_billing_method import SkuFieldDataEcSkuBillingMethod -from .sku_field_data_ec_sku_subscription_plan import SkuFieldDataEcSkuSubscriptionPlan -from .sku_field_data_ec_sku_subscription_plan_interval import SkuFieldDataEcSkuSubscriptionPlanInterval -from .sku_field_data_ec_sku_subscription_plan_plans_item import SkuFieldDataEcSkuSubscriptionPlanPlansItem -from .sku_field_data_ec_sku_subscription_plan_plans_item_status import SkuFieldDataEcSkuSubscriptionPlanPlansItemStatus -from .sku_field_data_price import SkuFieldDataPrice -from .sku_property_list import SkuPropertyList -from .sku_property_list_enum_item import SkuPropertyListEnumItem -from .sku_value_list import SkuValueList -from .stripe_card import StripeCard -from .stripe_card_brand import StripeCardBrand -from .stripe_card_expires import StripeCardExpires -from .stripe_details import StripeDetails -from .text import Text -from .text_node import TextNode -from .text_node_text import TextNodeText -from .text_node_write import TextNodeWrite -from .trigger_type import TriggerType -from .user import User -from .user_access_groups_item import UserAccessGroupsItem -from .user_access_groups_item_type import UserAccessGroupsItemType -from .user_data import UserData -from .user_data_data import UserDataData -from .user_limit_reached import UserLimitReached -from .user_list import UserList -from .user_status import UserStatus -from .users_not_enabled import UsersNotEnabled -from .webhook import Webhook -from .webhook_filter import WebhookFilter -from .webhook_list import WebhookList +# isort: skip_file + +import typing +from importlib import import_module + +if typing.TYPE_CHECKING: + from .application import Application + from .asset import Asset + from .asset_folder import AssetFolder + from .asset_folder_list import AssetFolderList + from .asset_upload import AssetUpload + from .asset_upload_upload_details import AssetUploadUploadDetails + from .asset_variant import AssetVariant + from .assets import Assets + from .authorization import Authorization + from .authorization_authorization import AuthorizationAuthorization + from .authorization_authorization_authorized_to import AuthorizationAuthorizationAuthorizedTo + from .authorized_user import AuthorizedUser + from .bad_request_error_body import BadRequestErrorBody + from .bulk_collection_item import BulkCollectionItem + from .bulk_collection_item_field_data import BulkCollectionItemFieldData + from .collection import Collection + from .collection_item import CollectionItem + from .collection_item_changed import CollectionItemChanged + from .collection_item_created import CollectionItemCreated + from .collection_item_field_data import CollectionItemFieldData + from .collection_item_list import CollectionItemList + from .collection_item_list_no_pagination import CollectionItemListNoPagination + from .collection_item_list_pagination import CollectionItemListPagination + from .collection_item_patch_single import CollectionItemPatchSingle + from .collection_item_patch_single_field_data import CollectionItemPatchSingleFieldData + from .collection_item_post_single import CollectionItemPostSingle + from .collection_item_post_single_field_data import CollectionItemPostSingleFieldData + from .collection_item_published import CollectionItemPublished + from .collection_item_removed import CollectionItemRemoved + from .collection_item_removed_payload import CollectionItemRemovedPayload + from .collection_item_removed_payload_field_data import CollectionItemRemovedPayloadFieldData + from .collection_item_unpublished import CollectionItemUnpublished + from .collection_item_unpublished_payload import CollectionItemUnpublishedPayload + from .collection_item_unpublished_payload_field_data import CollectionItemUnpublishedPayloadFieldData + from .collection_item_with_id_input import CollectionItemWithIdInput + from .collection_item_with_id_input_field_data import CollectionItemWithIdInputFieldData + from .collection_list import CollectionList + from .collection_list_array_item import CollectionListArrayItem + from .comment import Comment + from .comment_payload import CommentPayload + from .comment_payload_author import CommentPayloadAuthor + from .comment_payload_mentioned_users_item import CommentPayloadMentionedUsersItem + from .comment_reply import CommentReply + from .comment_reply_author import CommentReplyAuthor + from .comment_reply_list import CommentReplyList + from .comment_reply_list_pagination import CommentReplyListPagination + from .comment_reply_mentioned_users_item import CommentReplyMentionedUsersItem + from .comment_thread import CommentThread + from .comment_thread_author import CommentThreadAuthor + from .comment_thread_list import CommentThreadList + from .comment_thread_list_pagination import CommentThreadListPagination + from .comment_thread_mentioned_users_item import CommentThreadMentionedUsersItem + from .component import Component + from .component_dom import ComponentDom + from .component_instance_node_property_overrides_write import ComponentInstanceNodePropertyOverridesWrite + from .component_instance_node_property_overrides_write_property_overrides_item import ( + ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem, + ) + from .component_list import ComponentList + from .component_node import ComponentNode + from .component_properties import ComponentProperties + from .component_property import ComponentProperty + from .component_property_type import ComponentPropertyType + from .conflict import Conflict + from .custom_code_block import CustomCodeBlock + from .custom_code_block_type import CustomCodeBlockType + from .custom_code_hosted_response import CustomCodeHostedResponse + from .custom_code_inline_response import CustomCodeInlineResponse + from .custom_role import CustomRole + from .custom_role_audit_log_item import CustomRoleAuditLogItem + from .custom_role_audit_log_item_event_sub_type import CustomRoleAuditLogItemEventSubType + from .dom import Dom + from .domain import Domain + from .domains import Domains + from .ecommerce_settings import EcommerceSettings + from .error import Error + from .error_code import ErrorCode + from .field import Field + from .field_create import FieldCreate + from .field_type import FieldType + from .field_validations import FieldValidations + from .field_validations_additional_properties import FieldValidationsAdditionalProperties + from .field_validations_additional_properties_additional_properties import ( + FieldValidationsAdditionalPropertiesAdditionalProperties, + ) + from .forbidden_error_body import ForbiddenErrorBody + from .form import Form + from .form_field import FormField + from .form_field_value import FormFieldValue + from .form_field_value_type import FormFieldValueType + from .form_list import FormList + from .form_response_settings import FormResponseSettings + from .form_submission import FormSubmission + from .form_submission_list import FormSubmissionList + from .form_submission_trigger import FormSubmissionTrigger + from .form_submission_trigger_payload import FormSubmissionTriggerPayload + from .form_submission_trigger_payload_schema_item import FormSubmissionTriggerPayloadSchemaItem + from .form_submission_trigger_payload_schema_item_field_type import FormSubmissionTriggerPayloadSchemaItemFieldType + from .image_node import ImageNode + from .image_node_image import ImageNodeImage + from .invalid_domain import InvalidDomain + from .invalid_scopes import InvalidScopes + from .inventory_item import InventoryItem + from .inventory_item_inventory_type import InventoryItemInventoryType + from .items_list_items_live_request_last_published import ItemsListItemsLiveRequestLastPublished + from .items_list_items_request_last_published import ItemsListItemsRequestLastPublished + from .list_custom_code_blocks import ListCustomCodeBlocks + from .locale import Locale + from .locales import Locales + from .metadata import Metadata + from .metadata_options_item import MetadataOptionsItem + from .new_order import NewOrder + from .no_domains import NoDomains + from .node import ( + Node, + Node_ComponentInstance, + Node_Image, + Node_SearchButton, + Node_Select, + Node_SubmitButton, + Node_Text, + Node_TextInput, + ) + from .not_enterprise_plan_site import NotEnterprisePlanSite + from .not_enterprise_plan_workspace import NotEnterprisePlanWorkspace + from .option_field import OptionField + from .order import Order + from .order_address import OrderAddress + from .order_address_japan_type import OrderAddressJapanType + from .order_address_type import OrderAddressType + from .order_billing_address import OrderBillingAddress + from .order_billing_address_japan_type import OrderBillingAddressJapanType + from .order_billing_address_type import OrderBillingAddressType + from .order_customer_info import OrderCustomerInfo + from .order_dispute_last_status import OrderDisputeLastStatus + from .order_download_files_item import OrderDownloadFilesItem + from .order_list import OrderList + from .order_metadata import OrderMetadata + from .order_price import OrderPrice + from .order_purchased_item import OrderPurchasedItem + from .order_purchased_item_variant_image import OrderPurchasedItemVariantImage + from .order_purchased_item_variant_image_file import OrderPurchasedItemVariantImageFile + from .order_purchased_item_variant_image_file_variants_item import OrderPurchasedItemVariantImageFileVariantsItem + from .order_shipping_address import OrderShippingAddress + from .order_shipping_address_japan_type import OrderShippingAddressJapanType + from .order_shipping_address_type import OrderShippingAddressType + from .order_status import OrderStatus + from .order_totals import OrderTotals + from .order_totals_extras_item import OrderTotalsExtrasItem + from .order_totals_extras_item_type import OrderTotalsExtrasItemType + from .page import Page + from .page_created_webhook import PageCreatedWebhook + from .page_created_webhook_payload import PageCreatedWebhookPayload + from .page_deleted_webhook import PageDeletedWebhook + from .page_deleted_webhook_payload import PageDeletedWebhookPayload + from .page_list import PageList + from .page_metadata_updated_webhook import PageMetadataUpdatedWebhook + from .page_metadata_updated_webhook_payload import PageMetadataUpdatedWebhookPayload + from .page_open_graph import PageOpenGraph + from .page_seo import PageSeo + from .pagination import Pagination + from .payload import Payload + from .payload_field_data import PayloadFieldData + from .paypal_details import PaypalDetails + from .product import Product + from .product_and_sk_us import ProductAndSkUs + from .product_and_sk_us_list import ProductAndSkUsList + from .product_field_data import ProductFieldData + from .product_field_data_ec_product_type import ProductFieldDataEcProductType + from .product_field_data_tax_category import ProductFieldDataTaxCategory + from .publish_status import PublishStatus + from .redirect import Redirect + from .redirects import Redirects + from .reference_field import ReferenceField + from .reference_field_metadata import ReferenceFieldMetadata + from .reference_field_type import ReferenceFieldType + from .registered_script_list import RegisteredScriptList + from .robots import Robots + from .robots_rules_item import RobotsRulesItem + from .script_apply import ScriptApply + from .script_apply_list import ScriptApplyList + from .script_apply_location import ScriptApplyLocation + from .scripts import Scripts + from .search_button_node import SearchButtonNode + from .search_button_node_write import SearchButtonNodeWrite + from .select import Select + from .select_node import SelectNode + from .select_node_choices_item import SelectNodeChoicesItem + from .select_node_write_choices_item import SelectNodeWriteChoicesItem + from .setting_change import SettingChange + from .setting_change_audit_log_item import SettingChangeAuditLogItem + from .single_locale_created_payload import SingleLocaleCreatedPayload + from .single_locale_created_payload_field_data import SingleLocaleCreatedPayloadFieldData + from .site import Site + from .site_activity_log_item import SiteActivityLogItem + from .site_activity_log_item_event import SiteActivityLogItemEvent + from .site_activity_log_item_resource_operation import SiteActivityLogItemResourceOperation + from .site_activity_log_item_user import SiteActivityLogItemUser + from .site_activity_log_response import SiteActivityLogResponse + from .site_data_collection_type import SiteDataCollectionType + from .site_membership import SiteMembership + from .site_membership_audit_log_item import SiteMembershipAuditLogItem + from .site_membership_audit_log_item_event_sub_type import SiteMembershipAuditLogItemEventSubType + from .site_plan import SitePlan + from .site_plan_id import SitePlanId + from .site_plan_name import SitePlanName + from .site_publish import SitePublish + from .site_publish_payload import SitePublishPayload + from .sites import Sites + from .sku import Sku + from .sku_field_data import SkuFieldData + from .sku_field_data_compare_at_price import SkuFieldDataCompareAtPrice + from .sku_field_data_ec_sku_billing_method import SkuFieldDataEcSkuBillingMethod + from .sku_field_data_ec_sku_subscription_plan import SkuFieldDataEcSkuSubscriptionPlan + from .sku_field_data_ec_sku_subscription_plan_interval import SkuFieldDataEcSkuSubscriptionPlanInterval + from .sku_field_data_ec_sku_subscription_plan_plans_item import SkuFieldDataEcSkuSubscriptionPlanPlansItem + from .sku_field_data_ec_sku_subscription_plan_plans_item_status import ( + SkuFieldDataEcSkuSubscriptionPlanPlansItemStatus, + ) + from .sku_field_data_price import SkuFieldDataPrice + from .sku_property_list import SkuPropertyList + from .sku_property_list_enum_item import SkuPropertyListEnumItem + from .sku_value_list import SkuValueList + from .static_field import StaticField + from .static_field_type import StaticFieldType + from .stripe_card import StripeCard + from .stripe_card_brand import StripeCardBrand + from .stripe_card_expires import StripeCardExpires + from .stripe_details import StripeDetails + from .submit_button_node import SubmitButtonNode + from .submit_button_node_write import SubmitButtonNodeWrite + from .text import Text + from .text_input_node import TextInputNode + from .text_input_node_write import TextInputNodeWrite + from .text_node import TextNode + from .text_node_text import TextNodeText + from .text_node_write import TextNodeWrite + from .trigger_type import TriggerType + from .updated_order import UpdatedOrder + from .user_access import UserAccess + from .user_access_audit_log_item import UserAccessAuditLogItem + from .user_access_audit_log_item_event_sub_type import UserAccessAuditLogItemEventSubType + from .webhook import Webhook + from .webhook_filter import WebhookFilter + from .webhook_list import WebhookList + from .workspace_audit_log_item import ( + WorkspaceAuditLogItem, + WorkspaceAuditLogItem_CustomRole, + WorkspaceAuditLogItem_SiteMembership, + WorkspaceAuditLogItem_UserAccess, + WorkspaceAuditLogItem_WorkspaceInvitation, + WorkspaceAuditLogItem_WorkspaceMembership, + WorkspaceAuditLogItem_WorkspaceSetting, + ) + from .workspace_audit_log_item_actor import WorkspaceAuditLogItemActor + from .workspace_audit_log_item_payload_setting_change_method import WorkspaceAuditLogItemPayloadSettingChangeMethod + from .workspace_audit_log_item_payload_site_membership_granular_access import ( + WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess, + ) + from .workspace_audit_log_item_payload_site_membership_method import ( + WorkspaceAuditLogItemPayloadSiteMembershipMethod, + ) + from .workspace_audit_log_item_payload_site_membership_site import WorkspaceAuditLogItemPayloadSiteMembershipSite + from .workspace_audit_log_item_payload_site_membership_target_user import ( + WorkspaceAuditLogItemPayloadSiteMembershipTargetUser, + ) + from .workspace_audit_log_item_payload_site_membership_user_type import ( + WorkspaceAuditLogItemPayloadSiteMembershipUserType, + ) + from .workspace_audit_log_item_payload_user_access_method import WorkspaceAuditLogItemPayloadUserAccessMethod + from .workspace_audit_log_item_payload_workspace_invitation_method import ( + WorkspaceAuditLogItemPayloadWorkspaceInvitationMethod, + ) + from .workspace_audit_log_item_payload_workspace_invitation_target_user import ( + WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUser, + ) + from .workspace_audit_log_item_payload_workspace_invitation_target_users_item import ( + WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUsersItem, + ) + from .workspace_audit_log_item_payload_workspace_invitation_user_type import ( + WorkspaceAuditLogItemPayloadWorkspaceInvitationUserType, + ) + from .workspace_audit_log_item_payload_workspace_membership_method import ( + WorkspaceAuditLogItemPayloadWorkspaceMembershipMethod, + ) + from .workspace_audit_log_item_payload_workspace_membership_target_user import ( + WorkspaceAuditLogItemPayloadWorkspaceMembershipTargetUser, + ) + from .workspace_audit_log_item_payload_workspace_membership_user_type import ( + WorkspaceAuditLogItemPayloadWorkspaceMembershipUserType, + ) + from .workspace_audit_log_item_workspace import WorkspaceAuditLogItemWorkspace + from .workspace_audit_log_response import WorkspaceAuditLogResponse + from .workspace_invitation import WorkspaceInvitation + from .workspace_invitation_audit_log_item import WorkspaceInvitationAuditLogItem + from .workspace_invitation_audit_log_item_event_sub_type import WorkspaceInvitationAuditLogItemEventSubType + from .workspace_membership import WorkspaceMembership + from .workspace_membership_audit_log_item import WorkspaceMembershipAuditLogItem + from .workspace_membership_audit_log_item_event_sub_type import WorkspaceMembershipAuditLogItemEventSubType +_dynamic_imports: typing.Dict[str, str] = { + "Application": ".application", + "Asset": ".asset", + "AssetFolder": ".asset_folder", + "AssetFolderList": ".asset_folder_list", + "AssetUpload": ".asset_upload", + "AssetUploadUploadDetails": ".asset_upload_upload_details", + "AssetVariant": ".asset_variant", + "Assets": ".assets", + "Authorization": ".authorization", + "AuthorizationAuthorization": ".authorization_authorization", + "AuthorizationAuthorizationAuthorizedTo": ".authorization_authorization_authorized_to", + "AuthorizedUser": ".authorized_user", + "BadRequestErrorBody": ".bad_request_error_body", + "BulkCollectionItem": ".bulk_collection_item", + "BulkCollectionItemFieldData": ".bulk_collection_item_field_data", + "Collection": ".collection", + "CollectionItem": ".collection_item", + "CollectionItemChanged": ".collection_item_changed", + "CollectionItemCreated": ".collection_item_created", + "CollectionItemFieldData": ".collection_item_field_data", + "CollectionItemList": ".collection_item_list", + "CollectionItemListNoPagination": ".collection_item_list_no_pagination", + "CollectionItemListPagination": ".collection_item_list_pagination", + "CollectionItemPatchSingle": ".collection_item_patch_single", + "CollectionItemPatchSingleFieldData": ".collection_item_patch_single_field_data", + "CollectionItemPostSingle": ".collection_item_post_single", + "CollectionItemPostSingleFieldData": ".collection_item_post_single_field_data", + "CollectionItemPublished": ".collection_item_published", + "CollectionItemRemoved": ".collection_item_removed", + "CollectionItemRemovedPayload": ".collection_item_removed_payload", + "CollectionItemRemovedPayloadFieldData": ".collection_item_removed_payload_field_data", + "CollectionItemUnpublished": ".collection_item_unpublished", + "CollectionItemUnpublishedPayload": ".collection_item_unpublished_payload", + "CollectionItemUnpublishedPayloadFieldData": ".collection_item_unpublished_payload_field_data", + "CollectionItemWithIdInput": ".collection_item_with_id_input", + "CollectionItemWithIdInputFieldData": ".collection_item_with_id_input_field_data", + "CollectionList": ".collection_list", + "CollectionListArrayItem": ".collection_list_array_item", + "Comment": ".comment", + "CommentPayload": ".comment_payload", + "CommentPayloadAuthor": ".comment_payload_author", + "CommentPayloadMentionedUsersItem": ".comment_payload_mentioned_users_item", + "CommentReply": ".comment_reply", + "CommentReplyAuthor": ".comment_reply_author", + "CommentReplyList": ".comment_reply_list", + "CommentReplyListPagination": ".comment_reply_list_pagination", + "CommentReplyMentionedUsersItem": ".comment_reply_mentioned_users_item", + "CommentThread": ".comment_thread", + "CommentThreadAuthor": ".comment_thread_author", + "CommentThreadList": ".comment_thread_list", + "CommentThreadListPagination": ".comment_thread_list_pagination", + "CommentThreadMentionedUsersItem": ".comment_thread_mentioned_users_item", + "Component": ".component", + "ComponentDom": ".component_dom", + "ComponentInstanceNodePropertyOverridesWrite": ".component_instance_node_property_overrides_write", + "ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem": ".component_instance_node_property_overrides_write_property_overrides_item", + "ComponentList": ".component_list", + "ComponentNode": ".component_node", + "ComponentProperties": ".component_properties", + "ComponentProperty": ".component_property", + "ComponentPropertyType": ".component_property_type", + "Conflict": ".conflict", + "CustomCodeBlock": ".custom_code_block", + "CustomCodeBlockType": ".custom_code_block_type", + "CustomCodeHostedResponse": ".custom_code_hosted_response", + "CustomCodeInlineResponse": ".custom_code_inline_response", + "CustomRole": ".custom_role", + "CustomRoleAuditLogItem": ".custom_role_audit_log_item", + "CustomRoleAuditLogItemEventSubType": ".custom_role_audit_log_item_event_sub_type", + "Dom": ".dom", + "Domain": ".domain", + "Domains": ".domains", + "EcommerceSettings": ".ecommerce_settings", + "Error": ".error", + "ErrorCode": ".error_code", + "Field": ".field", + "FieldCreate": ".field_create", + "FieldType": ".field_type", + "FieldValidations": ".field_validations", + "FieldValidationsAdditionalProperties": ".field_validations_additional_properties", + "FieldValidationsAdditionalPropertiesAdditionalProperties": ".field_validations_additional_properties_additional_properties", + "ForbiddenErrorBody": ".forbidden_error_body", + "Form": ".form", + "FormField": ".form_field", + "FormFieldValue": ".form_field_value", + "FormFieldValueType": ".form_field_value_type", + "FormList": ".form_list", + "FormResponseSettings": ".form_response_settings", + "FormSubmission": ".form_submission", + "FormSubmissionList": ".form_submission_list", + "FormSubmissionTrigger": ".form_submission_trigger", + "FormSubmissionTriggerPayload": ".form_submission_trigger_payload", + "FormSubmissionTriggerPayloadSchemaItem": ".form_submission_trigger_payload_schema_item", + "FormSubmissionTriggerPayloadSchemaItemFieldType": ".form_submission_trigger_payload_schema_item_field_type", + "ImageNode": ".image_node", + "ImageNodeImage": ".image_node_image", + "InvalidDomain": ".invalid_domain", + "InvalidScopes": ".invalid_scopes", + "InventoryItem": ".inventory_item", + "InventoryItemInventoryType": ".inventory_item_inventory_type", + "ItemsListItemsLiveRequestLastPublished": ".items_list_items_live_request_last_published", + "ItemsListItemsRequestLastPublished": ".items_list_items_request_last_published", + "ListCustomCodeBlocks": ".list_custom_code_blocks", + "Locale": ".locale", + "Locales": ".locales", + "Metadata": ".metadata", + "MetadataOptionsItem": ".metadata_options_item", + "NewOrder": ".new_order", + "NoDomains": ".no_domains", + "Node": ".node", + "Node_ComponentInstance": ".node", + "Node_Image": ".node", + "Node_SearchButton": ".node", + "Node_Select": ".node", + "Node_SubmitButton": ".node", + "Node_Text": ".node", + "Node_TextInput": ".node", + "NotEnterprisePlanSite": ".not_enterprise_plan_site", + "NotEnterprisePlanWorkspace": ".not_enterprise_plan_workspace", + "OptionField": ".option_field", + "Order": ".order", + "OrderAddress": ".order_address", + "OrderAddressJapanType": ".order_address_japan_type", + "OrderAddressType": ".order_address_type", + "OrderBillingAddress": ".order_billing_address", + "OrderBillingAddressJapanType": ".order_billing_address_japan_type", + "OrderBillingAddressType": ".order_billing_address_type", + "OrderCustomerInfo": ".order_customer_info", + "OrderDisputeLastStatus": ".order_dispute_last_status", + "OrderDownloadFilesItem": ".order_download_files_item", + "OrderList": ".order_list", + "OrderMetadata": ".order_metadata", + "OrderPrice": ".order_price", + "OrderPurchasedItem": ".order_purchased_item", + "OrderPurchasedItemVariantImage": ".order_purchased_item_variant_image", + "OrderPurchasedItemVariantImageFile": ".order_purchased_item_variant_image_file", + "OrderPurchasedItemVariantImageFileVariantsItem": ".order_purchased_item_variant_image_file_variants_item", + "OrderShippingAddress": ".order_shipping_address", + "OrderShippingAddressJapanType": ".order_shipping_address_japan_type", + "OrderShippingAddressType": ".order_shipping_address_type", + "OrderStatus": ".order_status", + "OrderTotals": ".order_totals", + "OrderTotalsExtrasItem": ".order_totals_extras_item", + "OrderTotalsExtrasItemType": ".order_totals_extras_item_type", + "Page": ".page", + "PageCreatedWebhook": ".page_created_webhook", + "PageCreatedWebhookPayload": ".page_created_webhook_payload", + "PageDeletedWebhook": ".page_deleted_webhook", + "PageDeletedWebhookPayload": ".page_deleted_webhook_payload", + "PageList": ".page_list", + "PageMetadataUpdatedWebhook": ".page_metadata_updated_webhook", + "PageMetadataUpdatedWebhookPayload": ".page_metadata_updated_webhook_payload", + "PageOpenGraph": ".page_open_graph", + "PageSeo": ".page_seo", + "Pagination": ".pagination", + "Payload": ".payload", + "PayloadFieldData": ".payload_field_data", + "PaypalDetails": ".paypal_details", + "Product": ".product", + "ProductAndSkUs": ".product_and_sk_us", + "ProductAndSkUsList": ".product_and_sk_us_list", + "ProductFieldData": ".product_field_data", + "ProductFieldDataEcProductType": ".product_field_data_ec_product_type", + "ProductFieldDataTaxCategory": ".product_field_data_tax_category", + "PublishStatus": ".publish_status", + "Redirect": ".redirect", + "Redirects": ".redirects", + "ReferenceField": ".reference_field", + "ReferenceFieldMetadata": ".reference_field_metadata", + "ReferenceFieldType": ".reference_field_type", + "RegisteredScriptList": ".registered_script_list", + "Robots": ".robots", + "RobotsRulesItem": ".robots_rules_item", + "ScriptApply": ".script_apply", + "ScriptApplyList": ".script_apply_list", + "ScriptApplyLocation": ".script_apply_location", + "Scripts": ".scripts", + "SearchButtonNode": ".search_button_node", + "SearchButtonNodeWrite": ".search_button_node_write", + "Select": ".select", + "SelectNode": ".select_node", + "SelectNodeChoicesItem": ".select_node_choices_item", + "SelectNodeWriteChoicesItem": ".select_node_write_choices_item", + "SettingChange": ".setting_change", + "SettingChangeAuditLogItem": ".setting_change_audit_log_item", + "SingleLocaleCreatedPayload": ".single_locale_created_payload", + "SingleLocaleCreatedPayloadFieldData": ".single_locale_created_payload_field_data", + "Site": ".site", + "SiteActivityLogItem": ".site_activity_log_item", + "SiteActivityLogItemEvent": ".site_activity_log_item_event", + "SiteActivityLogItemResourceOperation": ".site_activity_log_item_resource_operation", + "SiteActivityLogItemUser": ".site_activity_log_item_user", + "SiteActivityLogResponse": ".site_activity_log_response", + "SiteDataCollectionType": ".site_data_collection_type", + "SiteMembership": ".site_membership", + "SiteMembershipAuditLogItem": ".site_membership_audit_log_item", + "SiteMembershipAuditLogItemEventSubType": ".site_membership_audit_log_item_event_sub_type", + "SitePlan": ".site_plan", + "SitePlanId": ".site_plan_id", + "SitePlanName": ".site_plan_name", + "SitePublish": ".site_publish", + "SitePublishPayload": ".site_publish_payload", + "Sites": ".sites", + "Sku": ".sku", + "SkuFieldData": ".sku_field_data", + "SkuFieldDataCompareAtPrice": ".sku_field_data_compare_at_price", + "SkuFieldDataEcSkuBillingMethod": ".sku_field_data_ec_sku_billing_method", + "SkuFieldDataEcSkuSubscriptionPlan": ".sku_field_data_ec_sku_subscription_plan", + "SkuFieldDataEcSkuSubscriptionPlanInterval": ".sku_field_data_ec_sku_subscription_plan_interval", + "SkuFieldDataEcSkuSubscriptionPlanPlansItem": ".sku_field_data_ec_sku_subscription_plan_plans_item", + "SkuFieldDataEcSkuSubscriptionPlanPlansItemStatus": ".sku_field_data_ec_sku_subscription_plan_plans_item_status", + "SkuFieldDataPrice": ".sku_field_data_price", + "SkuPropertyList": ".sku_property_list", + "SkuPropertyListEnumItem": ".sku_property_list_enum_item", + "SkuValueList": ".sku_value_list", + "StaticField": ".static_field", + "StaticFieldType": ".static_field_type", + "StripeCard": ".stripe_card", + "StripeCardBrand": ".stripe_card_brand", + "StripeCardExpires": ".stripe_card_expires", + "StripeDetails": ".stripe_details", + "SubmitButtonNode": ".submit_button_node", + "SubmitButtonNodeWrite": ".submit_button_node_write", + "Text": ".text", + "TextInputNode": ".text_input_node", + "TextInputNodeWrite": ".text_input_node_write", + "TextNode": ".text_node", + "TextNodeText": ".text_node_text", + "TextNodeWrite": ".text_node_write", + "TriggerType": ".trigger_type", + "UpdatedOrder": ".updated_order", + "UserAccess": ".user_access", + "UserAccessAuditLogItem": ".user_access_audit_log_item", + "UserAccessAuditLogItemEventSubType": ".user_access_audit_log_item_event_sub_type", + "Webhook": ".webhook", + "WebhookFilter": ".webhook_filter", + "WebhookList": ".webhook_list", + "WorkspaceAuditLogItem": ".workspace_audit_log_item", + "WorkspaceAuditLogItemActor": ".workspace_audit_log_item_actor", + "WorkspaceAuditLogItemPayloadSettingChangeMethod": ".workspace_audit_log_item_payload_setting_change_method", + "WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess": ".workspace_audit_log_item_payload_site_membership_granular_access", + "WorkspaceAuditLogItemPayloadSiteMembershipMethod": ".workspace_audit_log_item_payload_site_membership_method", + "WorkspaceAuditLogItemPayloadSiteMembershipSite": ".workspace_audit_log_item_payload_site_membership_site", + "WorkspaceAuditLogItemPayloadSiteMembershipTargetUser": ".workspace_audit_log_item_payload_site_membership_target_user", + "WorkspaceAuditLogItemPayloadSiteMembershipUserType": ".workspace_audit_log_item_payload_site_membership_user_type", + "WorkspaceAuditLogItemPayloadUserAccessMethod": ".workspace_audit_log_item_payload_user_access_method", + "WorkspaceAuditLogItemPayloadWorkspaceInvitationMethod": ".workspace_audit_log_item_payload_workspace_invitation_method", + "WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUser": ".workspace_audit_log_item_payload_workspace_invitation_target_user", + "WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUsersItem": ".workspace_audit_log_item_payload_workspace_invitation_target_users_item", + "WorkspaceAuditLogItemPayloadWorkspaceInvitationUserType": ".workspace_audit_log_item_payload_workspace_invitation_user_type", + "WorkspaceAuditLogItemPayloadWorkspaceMembershipMethod": ".workspace_audit_log_item_payload_workspace_membership_method", + "WorkspaceAuditLogItemPayloadWorkspaceMembershipTargetUser": ".workspace_audit_log_item_payload_workspace_membership_target_user", + "WorkspaceAuditLogItemPayloadWorkspaceMembershipUserType": ".workspace_audit_log_item_payload_workspace_membership_user_type", + "WorkspaceAuditLogItemWorkspace": ".workspace_audit_log_item_workspace", + "WorkspaceAuditLogItem_CustomRole": ".workspace_audit_log_item", + "WorkspaceAuditLogItem_SiteMembership": ".workspace_audit_log_item", + "WorkspaceAuditLogItem_UserAccess": ".workspace_audit_log_item", + "WorkspaceAuditLogItem_WorkspaceInvitation": ".workspace_audit_log_item", + "WorkspaceAuditLogItem_WorkspaceMembership": ".workspace_audit_log_item", + "WorkspaceAuditLogItem_WorkspaceSetting": ".workspace_audit_log_item", + "WorkspaceAuditLogResponse": ".workspace_audit_log_response", + "WorkspaceInvitation": ".workspace_invitation", + "WorkspaceInvitationAuditLogItem": ".workspace_invitation_audit_log_item", + "WorkspaceInvitationAuditLogItemEventSubType": ".workspace_invitation_audit_log_item_event_sub_type", + "WorkspaceMembership": ".workspace_membership", + "WorkspaceMembershipAuditLogItem": ".workspace_membership_audit_log_item", + "WorkspaceMembershipAuditLogItemEventSubType": ".workspace_membership_audit_log_item_event_sub_type", +} + + +def __getattr__(attr_name: str) -> typing.Any: + module_name = _dynamic_imports.get(attr_name) + if module_name is None: + raise AttributeError(f"No {attr_name} found in _dynamic_imports for module name -> {__name__}") + try: + module = import_module(module_name, __package__) + if module_name == f".{attr_name}": + return module + else: + return getattr(module, attr_name) + except ImportError as e: + raise ImportError(f"Failed to import {attr_name} from {module_name}: {e}") from e + except AttributeError as e: + raise AttributeError(f"Failed to get {attr_name} from {module_name}: {e}") from e + + +def __dir__(): + lazy_attrs = list(_dynamic_imports.keys()) + return sorted(lazy_attrs) + __all__ = [ - "AccessGroup", - "AccessGroupList", "Application", "Asset", "AssetFolder", @@ -181,6 +615,8 @@ "BulkCollectionItemFieldData", "Collection", "CollectionItem", + "CollectionItemChanged", + "CollectionItemCreated", "CollectionItemFieldData", "CollectionItemList", "CollectionItemListNoPagination", @@ -189,10 +625,31 @@ "CollectionItemPatchSingleFieldData", "CollectionItemPostSingle", "CollectionItemPostSingleFieldData", + "CollectionItemPublished", + "CollectionItemRemoved", + "CollectionItemRemovedPayload", + "CollectionItemRemovedPayloadFieldData", + "CollectionItemUnpublished", + "CollectionItemUnpublishedPayload", + "CollectionItemUnpublishedPayloadFieldData", "CollectionItemWithIdInput", "CollectionItemWithIdInputFieldData", "CollectionList", "CollectionListArrayItem", + "Comment", + "CommentPayload", + "CommentPayloadAuthor", + "CommentPayloadMentionedUsersItem", + "CommentReply", + "CommentReplyAuthor", + "CommentReplyList", + "CommentReplyListPagination", + "CommentReplyMentionedUsersItem", + "CommentThread", + "CommentThreadAuthor", + "CommentThreadList", + "CommentThreadListPagination", + "CommentThreadMentionedUsersItem", "Component", "ComponentDom", "ComponentInstanceNodePropertyOverridesWrite", @@ -202,20 +659,26 @@ "ComponentProperties", "ComponentProperty", "ComponentPropertyType", - "ConflictErrorBody", + "Conflict", "CustomCodeBlock", "CustomCodeBlockType", "CustomCodeHostedResponse", "CustomCodeInlineResponse", + "CustomRole", + "CustomRoleAuditLogItem", + "CustomRoleAuditLogItemEventSubType", "Dom", "Domain", "Domains", - "DuplicateUserEmail", "EcommerceSettings", "Error", "ErrorCode", "Field", + "FieldCreate", "FieldType", + "FieldValidations", + "FieldValidationsAdditionalProperties", + "FieldValidationsAdditionalPropertiesAdditionalProperties", "ForbiddenErrorBody", "Form", "FormField", @@ -225,26 +688,43 @@ "FormResponseSettings", "FormSubmission", "FormSubmissionList", + "FormSubmissionTrigger", + "FormSubmissionTriggerPayload", + "FormSubmissionTriggerPayloadSchemaItem", + "FormSubmissionTriggerPayloadSchemaItemFieldType", "ImageNode", "ImageNodeImage", "InvalidDomain", "InvalidScopes", "InventoryItem", "InventoryItemInventoryType", + "ItemsListItemsLiveRequestLastPublished", + "ItemsListItemsRequestLastPublished", "ListCustomCodeBlocks", "Locale", "Locales", + "Metadata", + "MetadataOptionsItem", + "NewOrder", "NoDomains", "Node", "Node_ComponentInstance", "Node_Image", + "Node_SearchButton", + "Node_Select", + "Node_SubmitButton", "Node_Text", + "Node_TextInput", "NotEnterprisePlanSite", "NotEnterprisePlanWorkspace", + "OptionField", "Order", "OrderAddress", "OrderAddressJapanType", "OrderAddressType", + "OrderBillingAddress", + "OrderBillingAddressJapanType", + "OrderBillingAddressType", "OrderCustomerInfo", "OrderDisputeLastStatus", "OrderDownloadFilesItem", @@ -255,15 +735,26 @@ "OrderPurchasedItemVariantImage", "OrderPurchasedItemVariantImageFile", "OrderPurchasedItemVariantImageFileVariantsItem", + "OrderShippingAddress", + "OrderShippingAddressJapanType", + "OrderShippingAddressType", "OrderStatus", "OrderTotals", "OrderTotalsExtrasItem", "OrderTotalsExtrasItemType", "Page", + "PageCreatedWebhook", + "PageCreatedWebhookPayload", + "PageDeletedWebhook", + "PageDeletedWebhookPayload", "PageList", + "PageMetadataUpdatedWebhook", + "PageMetadataUpdatedWebhookPayload", "PageOpenGraph", "PageSeo", "Pagination", + "Payload", + "PayloadFieldData", "PaypalDetails", "Product", "ProductAndSkUs", @@ -274,11 +765,26 @@ "PublishStatus", "Redirect", "Redirects", + "ReferenceField", + "ReferenceFieldMetadata", + "ReferenceFieldType", "RegisteredScriptList", + "Robots", + "RobotsRulesItem", "ScriptApply", "ScriptApplyList", "ScriptApplyLocation", "Scripts", + "SearchButtonNode", + "SearchButtonNodeWrite", + "Select", + "SelectNode", + "SelectNodeChoicesItem", + "SelectNodeWriteChoicesItem", + "SettingChange", + "SettingChangeAuditLogItem", + "SingleLocaleCreatedPayload", + "SingleLocaleCreatedPayloadFieldData", "Site", "SiteActivityLogItem", "SiteActivityLogItemEvent", @@ -286,9 +792,14 @@ "SiteActivityLogItemUser", "SiteActivityLogResponse", "SiteDataCollectionType", + "SiteMembership", + "SiteMembershipAuditLogItem", + "SiteMembershipAuditLogItemEventSubType", "SitePlan", "SitePlanId", "SitePlanName", + "SitePublish", + "SitePublishPayload", "Sites", "Sku", "SkuFieldData", @@ -302,25 +813,56 @@ "SkuPropertyList", "SkuPropertyListEnumItem", "SkuValueList", + "StaticField", + "StaticFieldType", "StripeCard", "StripeCardBrand", "StripeCardExpires", "StripeDetails", + "SubmitButtonNode", + "SubmitButtonNodeWrite", "Text", + "TextInputNode", + "TextInputNodeWrite", "TextNode", "TextNodeText", "TextNodeWrite", "TriggerType", - "User", - "UserAccessGroupsItem", - "UserAccessGroupsItemType", - "UserData", - "UserDataData", - "UserLimitReached", - "UserList", - "UserStatus", - "UsersNotEnabled", + "UpdatedOrder", + "UserAccess", + "UserAccessAuditLogItem", + "UserAccessAuditLogItemEventSubType", "Webhook", "WebhookFilter", "WebhookList", + "WorkspaceAuditLogItem", + "WorkspaceAuditLogItemActor", + "WorkspaceAuditLogItemPayloadSettingChangeMethod", + "WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess", + "WorkspaceAuditLogItemPayloadSiteMembershipMethod", + "WorkspaceAuditLogItemPayloadSiteMembershipSite", + "WorkspaceAuditLogItemPayloadSiteMembershipTargetUser", + "WorkspaceAuditLogItemPayloadSiteMembershipUserType", + "WorkspaceAuditLogItemPayloadUserAccessMethod", + "WorkspaceAuditLogItemPayloadWorkspaceInvitationMethod", + "WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUser", + "WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUsersItem", + "WorkspaceAuditLogItemPayloadWorkspaceInvitationUserType", + "WorkspaceAuditLogItemPayloadWorkspaceMembershipMethod", + "WorkspaceAuditLogItemPayloadWorkspaceMembershipTargetUser", + "WorkspaceAuditLogItemPayloadWorkspaceMembershipUserType", + "WorkspaceAuditLogItemWorkspace", + "WorkspaceAuditLogItem_CustomRole", + "WorkspaceAuditLogItem_SiteMembership", + "WorkspaceAuditLogItem_UserAccess", + "WorkspaceAuditLogItem_WorkspaceInvitation", + "WorkspaceAuditLogItem_WorkspaceMembership", + "WorkspaceAuditLogItem_WorkspaceSetting", + "WorkspaceAuditLogResponse", + "WorkspaceInvitation", + "WorkspaceInvitationAuditLogItem", + "WorkspaceInvitationAuditLogItemEventSubType", + "WorkspaceMembership", + "WorkspaceMembershipAuditLogItem", + "WorkspaceMembershipAuditLogItemEventSubType", ] diff --git a/src/webflow/types/access_group.py b/src/webflow/types/access_group.py deleted file mode 100644 index fa2a418..0000000 --- a/src/webflow/types/access_group.py +++ /dev/null @@ -1,49 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from ..core.pydantic_utilities import UniversalBaseModel -import typing -import pydantic -import typing_extensions -from ..core.serialization import FieldMetadata -import datetime as dt -from ..core.pydantic_utilities import IS_PYDANTIC_V2 - - -class AccessGroup(UniversalBaseModel): - id: typing.Optional[str] = pydantic.Field(default=None) - """ - Unique identifier for the Access Group - """ - - name: typing.Optional[str] = pydantic.Field(default=None) - """ - Name of the the Access Group - """ - - short_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="shortId")] = pydantic.Field( - default=None - ) - """ - Shortened unique identifier based on name, optimized for its use in the user’s JWT - """ - - slug: typing.Optional[str] = pydantic.Field(default=None) - """ - Shortened unique identifier based on name, optimized for human readability and public API use - """ - - created_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdOn")] = ( - pydantic.Field(default=None) - ) - """ - The date the Access Group was created - """ - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow diff --git a/src/webflow/types/access_group_list.py b/src/webflow/types/access_group_list.py deleted file mode 100644 index 0d5e140..0000000 --- a/src/webflow/types/access_group_list.py +++ /dev/null @@ -1,51 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from ..core.pydantic_utilities import UniversalBaseModel -import typing -import pydantic -import typing_extensions -from .access_group import AccessGroup -from ..core.serialization import FieldMetadata -from ..core.pydantic_utilities import IS_PYDANTIC_V2 - - -class AccessGroupList(UniversalBaseModel): - """ - The list access groups results - """ - - count: typing.Optional[float] = pydantic.Field(default=None) - """ - Number of access groups returned - """ - - limit: typing.Optional[float] = pydantic.Field(default=None) - """ - The limit specified in the request - """ - - offset: typing.Optional[float] = pydantic.Field(default=None) - """ - The offset specified for pagination - """ - - total: typing.Optional[float] = pydantic.Field(default=None) - """ - Total number of access groups in the collection - """ - - access_groups: typing_extensions.Annotated[ - typing.Optional[typing.List[AccessGroup]], FieldMetadata(alias="accessGroups") - ] = pydantic.Field(default=None) - """ - List of Site Access Groups - """ - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow diff --git a/src/webflow/types/application.py b/src/webflow/types/application.py index ac819f0..2b86757 100644 --- a/src/webflow/types/application.py +++ b/src/webflow/types/application.py @@ -2,4 +2,39 @@ import typing -Application = typing.Optional[typing.Any] +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata + + +class Application(UniversalBaseModel): + id: typing.Optional[str] = pydantic.Field(default=None) + """ + Unique identifier for the Application + """ + + description: typing.Optional[str] = pydantic.Field(default=None) + """ + Application description provided by the developer + """ + + homepage: typing.Optional[str] = pydantic.Field(default=None) + """ + Application homepage URL provided by the developer + """ + + display_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="displayName"), + pydantic.Field(alias="displayName", description="Application name provided by the developer"), + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/asset.py b/src/webflow/types/asset.py index b67cefa..eb3425d 100644 --- a/src/webflow/types/asset.py +++ b/src/webflow/types/asset.py @@ -1,82 +1,75 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel +import datetime as dt import typing + import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -import datetime as dt from .asset_variant import AssetVariant -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class Asset(UniversalBaseModel): - id: typing.Optional[str] = pydantic.Field(default=None) """ - Unique identifier for this asset + Asset details """ - content_type: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="contentType")] = ( - pydantic.Field(default=None) - ) + id: typing.Optional[str] = pydantic.Field(default=None) """ - File format type + Unique identifier for this asset """ + content_type: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="contentType"), + pydantic.Field(alias="contentType", description="File format type"), + ] = None size: typing.Optional[int] = pydantic.Field(default=None) """ size in bytes """ - site_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="siteId")] = pydantic.Field( - default=None - ) - """ - Unique identifier for the site that hosts this asset - """ - - hosted_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="hostedUrl")] = pydantic.Field( - default=None - ) - """ - Link to the asset + site_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="siteId"), + pydantic.Field(alias="siteId", description="Unique identifier for the site that hosts this asset"), + ] = None + hosted_url: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="hostedUrl"), + pydantic.Field(alias="hostedUrl", description="Link to the asset"), + ] = None + original_file_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="originalFileName"), + pydantic.Field(alias="originalFileName", description="Original file name at the time of upload"), + ] = None + display_name: typing_extensions.Annotated[ + str, + FieldMetadata(alias="displayName"), + pydantic.Field(alias="displayName", description="Display name of the asset"), + ] + last_updated: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="Date the asset metadata was last updated"), + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="Date the asset metadata was created"), + ] = None + variants: typing.List[AssetVariant] = pydantic.Field() + """ + A list of [asset variants](https://help.webflow.com/hc/en-us/articles/33961378697107-Responsive-images) created by Webflow to serve your site responsively. """ - original_file_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="originalFileName")] = ( - pydantic.Field(default=None) - ) - """ - Original file name at the time of upload - """ - - display_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="displayName")] = ( - pydantic.Field(default=None) - ) - """ - Display name of the asset - """ - - last_updated: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastUpdated")] = ( - pydantic.Field(default=None) - ) - """ - Date the asset metadata was last updated - """ - - created_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdOn")] = ( - pydantic.Field(default=None) - ) - """ - Date the asset metadata was created - """ - - variants: typing.Optional[typing.List[AssetVariant]] = None - alt_text: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="altText")] = pydantic.Field( - default=None - ) - """ - The visual description of the asset - """ + alt_text: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="altText"), + pydantic.Field(alias="altText", description="The visual description of the asset"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/asset_folder.py b/src/webflow/types/asset_folder.py index b01747e..193fd69 100644 --- a/src/webflow/types/asset_folder.py +++ b/src/webflow/types/asset_folder.py @@ -1,12 +1,12 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel +import datetime as dt import typing + import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -import datetime as dt -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class AssetFolder(UniversalBaseModel): @@ -19,45 +19,36 @@ class AssetFolder(UniversalBaseModel): Unique identifier for the Asset Folder """ - display_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="displayName")] = ( - pydantic.Field(default=None) - ) - """ - User visible name for the Asset Folder - """ - - parent_folder: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="parentFolder")] = ( - pydantic.Field(default=None) - ) - """ - Pointer to parent Asset Folder (or null if root) - """ - + display_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="displayName"), + pydantic.Field(alias="displayName", description="User visible name for the Asset Folder"), + ] = None + parent_folder: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="parentFolder"), + pydantic.Field(alias="parentFolder", description="Pointer to parent Asset Folder (or null if root)"), + ] = None assets: typing.Optional[typing.List[str]] = pydantic.Field(default=None) """ Array of Asset instances in the folder """ - site_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="siteId")] = pydantic.Field( - default=None - ) - """ - The unique ID of the site the Asset Folder belongs to - """ - - created_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdOn")] = ( - pydantic.Field(default=None) - ) - """ - Date that the Asset Folder was created on - """ - - last_updated: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastUpdated")] = ( - pydantic.Field(default=None) - ) - """ - Date that the Asset Folder was last updated on - """ + site_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="siteId"), + pydantic.Field(alias="siteId", description="The unique ID of the site the Asset Folder belongs to"), + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="Date that the Asset Folder was created on"), + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="Date that the Asset Folder was last updated on"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/asset_folder_list.py b/src/webflow/types/asset_folder_list.py index 3badf08..e36db60 100644 --- a/src/webflow/types/asset_folder_list.py +++ b/src/webflow/types/asset_folder_list.py @@ -1,13 +1,13 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions import typing -from .asset_folder import AssetFolder -from ..core.serialization import FieldMetadata + import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .asset_folder import AssetFolder from .pagination import Pagination -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class AssetFolderList(UniversalBaseModel): @@ -16,12 +16,10 @@ class AssetFolderList(UniversalBaseModel): """ asset_folders: typing_extensions.Annotated[ - typing.Optional[typing.List[AssetFolder]], FieldMetadata(alias="assetFolders") - ] = pydantic.Field(default=None) - """ - A list of Asset folders - """ - + typing.Optional[typing.List[AssetFolder]], + FieldMetadata(alias="assetFolders"), + pydantic.Field(alias="assetFolders", description="A list of Asset folders"), + ] = None pagination: typing.Optional[Pagination] = None if IS_PYDANTIC_V2: diff --git a/src/webflow/types/asset_upload.py b/src/webflow/types/asset_upload.py index fe36752..3f02db2 100644 --- a/src/webflow/types/asset_upload.py +++ b/src/webflow/types/asset_upload.py @@ -1,67 +1,61 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions +import datetime as dt import typing -from .asset_upload_upload_details import AssetUploadUploadDetails -from ..core.serialization import FieldMetadata + import pydantic -import datetime as dt -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .asset_upload_upload_details import AssetUploadUploadDetails class AssetUpload(UniversalBaseModel): upload_details: typing_extensions.Annotated[ - typing.Optional[AssetUploadUploadDetails], FieldMetadata(alias="uploadDetails") - ] = pydantic.Field(default=None) - """ - Metadata for uploading the asset binary - """ - - content_type: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="contentType")] = None + typing.Optional[AssetUploadUploadDetails], + FieldMetadata(alias="uploadDetails"), + pydantic.Field(alias="uploadDetails", description="Metadata for uploading the asset binary"), + ] = None + content_type: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="contentType"), pydantic.Field(alias="contentType") + ] = None id: typing.Optional[str] = None - parent_folder: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="parentFolder")] = ( - pydantic.Field(default=None) - ) - """ - Parent folder for the asset - """ - - upload_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="uploadUrl")] = None - asset_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="assetUrl")] = pydantic.Field( - default=None - ) - """ - S3 link to the asset - """ - - hosted_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="hostedUrl")] = pydantic.Field( - default=None - ) - """ - Represents the link to the asset - """ - - original_file_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="originalFileName")] = ( - pydantic.Field(default=None) - ) - """ - Original file name when uploaded. If not specified at time of upload, it may be extracted from the raw file name - """ - - created_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdOn")] = ( - pydantic.Field(default=None) - ) - """ - Date the asset metadata was created - """ - - last_updated: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastUpdated")] = ( - pydantic.Field(default=None) - ) - """ - Date the asset metadata was last updated - """ + parent_folder: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="parentFolder"), + pydantic.Field(alias="parentFolder", description="Parent folder for the asset"), + ] = None + upload_url: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="uploadUrl"), pydantic.Field(alias="uploadUrl") + ] = None + asset_url: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="assetUrl"), + pydantic.Field(alias="assetUrl", description="S3 link to the asset"), + ] = None + hosted_url: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="hostedUrl"), + pydantic.Field(alias="hostedUrl", description="Represents the link to the asset"), + ] = None + original_file_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="originalFileName"), + pydantic.Field( + alias="originalFileName", + description="Original file name when uploaded. If not specified at time of upload, it may be extracted from the raw file name", + ), + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="Date the asset metadata was created"), + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="Date the asset metadata was last updated"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/asset_upload_upload_details.py b/src/webflow/types/asset_upload_upload_details.py index bf3e115..68e174e 100644 --- a/src/webflow/types/asset_upload_upload_details.py +++ b/src/webflow/types/asset_upload_upload_details.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + +import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -from ..core.pydantic_utilities import IS_PYDANTIC_V2 -import pydantic class AssetUploadUploadDetails(UniversalBaseModel): @@ -15,15 +15,29 @@ class AssetUploadUploadDetails(UniversalBaseModel): acl: typing.Optional[str] = None bucket: typing.Optional[str] = None - x_amz_algorithm: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="X-Amz-Algorithm")] = None - x_amz_credential: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="X-Amz-Credential")] = None - x_amz_date: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="X-Amz-Date")] = None + x_amz_algorithm: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="X-Amz-Algorithm"), pydantic.Field(alias="X-Amz-Algorithm") + ] = None + x_amz_credential: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="X-Amz-Credential"), pydantic.Field(alias="X-Amz-Credential") + ] = None + x_amz_date: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="X-Amz-Date"), pydantic.Field(alias="X-Amz-Date") + ] = None key: typing.Optional[str] = None - policy: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="Policy")] = None - x_amz_signature: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="X-Amz-Signature")] = None + policy: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="Policy"), pydantic.Field(alias="Policy") + ] = None + x_amz_signature: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="X-Amz-Signature"), pydantic.Field(alias="X-Amz-Signature") + ] = None success_action_status: typing.Optional[str] = None - content_type: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="content-type")] = None - cache_control: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="Cache-Control")] = None + content_type: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="content-type"), pydantic.Field(alias="content-type") + ] = None + cache_control: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="Cache-Control"), pydantic.Field(alias="Cache-Control") + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/asset_variant.py b/src/webflow/types/asset_variant.py index 5278667..f43472d 100644 --- a/src/webflow/types/asset_variant.py +++ b/src/webflow/types/asset_variant.py @@ -1,41 +1,39 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions import typing -from ..core.serialization import FieldMetadata + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata class AssetVariant(UniversalBaseModel): - hosted_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="hostedUrl")] = pydantic.Field( - default=None - ) - """ - URL of where the asset variant is hosted """ - - original_file_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="originalFileName")] = ( - pydantic.Field(default=None) - ) - """ - Original file name of the variant - """ - - display_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="displayName")] = ( - pydantic.Field(default=None) - ) - """ - Display name of the variant - """ - - format: typing.Optional[str] = pydantic.Field(default=None) + Asset variant details + """ + + hosted_url: typing_extensions.Annotated[ + str, + FieldMetadata(alias="hostedUrl"), + pydantic.Field(alias="hostedUrl", description="URL of where the asset variant is hosted"), + ] + original_file_name: typing_extensions.Annotated[ + str, + FieldMetadata(alias="originalFileName"), + pydantic.Field(alias="originalFileName", description="Original file name of the variant"), + ] + display_name: typing_extensions.Annotated[ + str, + FieldMetadata(alias="displayName"), + pydantic.Field(alias="displayName", description="Display name of the variant"), + ] + format: str = pydantic.Field() """ format of the variant """ - width: typing.Optional[int] = pydantic.Field(default=None) + width: int = pydantic.Field() """ Width in pixels """ @@ -45,7 +43,7 @@ class AssetVariant(UniversalBaseModel): Height in pixels """ - quality: typing.Optional[int] = pydantic.Field(default=None) + quality: int = pydantic.Field() """ Value between 0 and 100 representing the image quality """ diff --git a/src/webflow/types/assets.py b/src/webflow/types/assets.py index 380b0de..ed33272 100644 --- a/src/webflow/types/assets.py +++ b/src/webflow/types/assets.py @@ -1,10 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing -from .asset import Asset -from ..core.pydantic_utilities import IS_PYDANTIC_V2 + import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .asset import Asset +from .pagination import Pagination class Assets(UniversalBaseModel): @@ -13,6 +14,7 @@ class Assets(UniversalBaseModel): """ assets: typing.Optional[typing.List[Asset]] = None + pagination: typing.Optional[Pagination] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/authorization.py b/src/webflow/types/authorization.py index 7668ace..6deea56 100644 --- a/src/webflow/types/authorization.py +++ b/src/webflow/types/authorization.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing -from .authorization_authorization import AuthorizationAuthorization + import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from .application import Application -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from .authorization_authorization import AuthorizationAuthorization class Authorization(UniversalBaseModel): diff --git a/src/webflow/types/authorization_authorization.py b/src/webflow/types/authorization_authorization.py index b732aac..e3ee7ca 100644 --- a/src/webflow/types/authorization_authorization.py +++ b/src/webflow/types/authorization_authorization.py @@ -1,13 +1,13 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel +import datetime as dt import typing + import pydantic import typing_extensions -import datetime as dt +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata from .authorization_authorization_authorized_to import AuthorizationAuthorizationAuthorizedTo -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class AuthorizationAuthorization(UniversalBaseModel): @@ -20,41 +20,35 @@ class AuthorizationAuthorization(UniversalBaseModel): The unique ID of the Authorization instance """ - created_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdOn")] = ( - pydantic.Field(default=None) - ) - """ - The date the Authorization was created - """ - - last_used: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastUsed")] = ( - pydantic.Field(default=None) - ) - """ - The date the Authorization was last used - """ - - grant_type: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="grantType")] = pydantic.Field( - default=None - ) - """ - The grant type of the Authorization - """ - - rate_limit: typing_extensions.Annotated[typing.Optional[int], FieldMetadata(alias="rateLimit")] = pydantic.Field( - default=None - ) - """ - The default rate limit for the Authorization (requests/min) - """ - + created_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="The date the Authorization was created"), + ] = None + last_used: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="lastUsed"), + pydantic.Field(alias="lastUsed", description="The date the Authorization was last used"), + ] = None + grant_type: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="grantType"), + pydantic.Field(alias="grantType", description="The grant type of the Authorization"), + ] = None + rate_limit: typing_extensions.Annotated[ + typing.Optional[int], + FieldMetadata(alias="rateLimit"), + pydantic.Field(alias="rateLimit", description="The default rate limit for the Authorization (requests/min)"), + ] = None scope: typing.Optional[str] = pydantic.Field(default=None) """ Comma separted list of OAuth scopes corresponding to the Authorization """ authorized_to: typing_extensions.Annotated[ - typing.Optional[AuthorizationAuthorizationAuthorizedTo], FieldMetadata(alias="authorizedTo") + typing.Optional[AuthorizationAuthorizationAuthorizedTo], + FieldMetadata(alias="authorizedTo"), + pydantic.Field(alias="authorizedTo"), ] = None if IS_PYDANTIC_V2: diff --git a/src/webflow/types/authorization_authorization_authorized_to.py b/src/webflow/types/authorization_authorization_authorized_to.py index c4316ab..d0189e4 100644 --- a/src/webflow/types/authorization_authorization_authorized_to.py +++ b/src/webflow/types/authorization_authorization_authorized_to.py @@ -1,34 +1,29 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions import typing -from ..core.serialization import FieldMetadata + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata class AuthorizationAuthorizationAuthorizedTo(UniversalBaseModel): site_ids: typing_extensions.Annotated[ - typing.Optional[typing.List[typing.Optional[typing.Any]]], FieldMetadata(alias="siteIds") - ] = pydantic.Field(default=None) - """ - Array of Sites this app is authorized to - """ - + typing.Optional[typing.List[typing.Any]], + FieldMetadata(alias="siteIds"), + pydantic.Field(alias="siteIds", description="Array of Sites this app is authorized to"), + ] = None workspace_ids: typing_extensions.Annotated[ - typing.Optional[typing.List[typing.Optional[typing.Any]]], FieldMetadata(alias="workspaceIds") - ] = pydantic.Field(default=None) - """ - Array of Workspaces this app is authorized to - """ - + typing.Optional[typing.List[typing.Any]], + FieldMetadata(alias="workspaceIds"), + pydantic.Field(alias="workspaceIds", description="Array of Workspaces this app is authorized to"), + ] = None user_ids: typing_extensions.Annotated[ - typing.Optional[typing.List[typing.Optional[typing.Any]]], FieldMetadata(alias="userIds") - ] = pydantic.Field(default=None) - """ - Array of Users this app is authorized to - """ + typing.Optional[typing.List[typing.Any]], + FieldMetadata(alias="userIds"), + pydantic.Field(alias="userIds", description="Array of Users this app is authorized to"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/authorized_user.py b/src/webflow/types/authorized_user.py index d91c8c6..bbbb058 100644 --- a/src/webflow/types/authorized_user.py +++ b/src/webflow/types/authorized_user.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class AuthorizedUser(UniversalBaseModel): @@ -19,19 +19,16 @@ class AuthorizedUser(UniversalBaseModel): The user's email address """ - first_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="firstName")] = pydantic.Field( - default=None - ) - """ - The user's first name - """ - - last_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="lastName")] = pydantic.Field( - default=None - ) - """ - The user's last name - """ + first_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="firstName"), + pydantic.Field(alias="firstName", description="The user's first name"), + ] = None + last_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="lastName"), + pydantic.Field(alias="lastName", description="The user's last name"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/bad_request_error_body.py b/src/webflow/types/bad_request_error_body.py index 5c1277c..6403cc4 100644 --- a/src/webflow/types/bad_request_error_body.py +++ b/src/webflow/types/bad_request_error_body.py @@ -1,6 +1,7 @@ # This file was auto-generated by Fern from our API Definition. import typing + from .invalid_domain import InvalidDomain from .no_domains import NoDomains diff --git a/src/webflow/types/bulk_collection_item.py b/src/webflow/types/bulk_collection_item.py index 4d17d13..f53e06d 100644 --- a/src/webflow/types/bulk_collection_item.py +++ b/src/webflow/types/bulk_collection_item.py @@ -1,12 +1,12 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel +import typing + import pydantic import typing_extensions -import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata from .bulk_collection_item_field_data import BulkCollectionItemFieldData -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class BulkCollectionItem(UniversalBaseModel): @@ -14,55 +14,47 @@ class BulkCollectionItem(UniversalBaseModel): The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items """ - id: str = pydantic.Field() + id: typing.Optional[str] = pydantic.Field(default=None) """ Unique identifier for the Item """ cms_locale_ids: typing_extensions.Annotated[ - typing.Optional[typing.List[str]], FieldMetadata(alias="cmsLocaleIds") - ] = pydantic.Field(default=None) - """ - Array of identifiers for the locales where the item will be created - """ - - last_published: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="lastPublished")] = ( - pydantic.Field(default=None) - ) - """ - The date the item was last published - """ - - last_updated: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="lastUpdated")] = ( - pydantic.Field(default=None) - ) - """ - The date the item was last updated - """ - - created_on: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="createdOn")] = pydantic.Field( - default=None - ) - """ - The date the item was created - """ - - is_archived: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="isArchived")] = pydantic.Field( - default=None - ) - """ - Boolean determining if the Item is set to archived - """ - - is_draft: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="isDraft")] = pydantic.Field( - default=None - ) - """ - Boolean determining if the Item is set to draft - """ - + typing.Optional[typing.List[str]], + FieldMetadata(alias="cmsLocaleIds"), + pydantic.Field( + alias="cmsLocaleIds", description="Array of identifiers for the locales where the item will be created" + ), + ] = None + last_published: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="lastPublished"), + pydantic.Field(alias="lastPublished", description="The date the item was last published"), + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="The date the item was last updated"), + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="The date the item was created"), + ] = None + is_archived: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="isArchived"), + pydantic.Field(alias="isArchived", description="Boolean determining if the Item is set to archived"), + ] = None + is_draft: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="isDraft"), + pydantic.Field(alias="isDraft", description="Boolean determining if the Item is set to draft"), + ] = None field_data: typing_extensions.Annotated[ - typing.Optional[BulkCollectionItemFieldData], FieldMetadata(alias="fieldData") + typing.Optional[BulkCollectionItemFieldData], + FieldMetadata(alias="fieldData"), + pydantic.Field(alias="fieldData"), ] = None if IS_PYDANTIC_V2: diff --git a/src/webflow/types/bulk_collection_item_field_data.py b/src/webflow/types/bulk_collection_item_field_data.py index 9b977a3..f428233 100644 --- a/src/webflow/types/bulk_collection_item_field_data.py +++ b/src/webflow/types/bulk_collection_item_field_data.py @@ -1,9 +1,9 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel class BulkCollectionItemFieldData(UniversalBaseModel): diff --git a/src/webflow/types/collection.py b/src/webflow/types/collection.py index 81e0f90..1976f76 100644 --- a/src/webflow/types/collection.py +++ b/src/webflow/types/collection.py @@ -1,13 +1,13 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel +import datetime as dt +import typing + import pydantic import typing_extensions -import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -import datetime as dt from .field import Field -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class Collection(UniversalBaseModel): @@ -20,39 +20,34 @@ class Collection(UniversalBaseModel): Unique identifier for a Collection """ - display_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="displayName")] = ( - pydantic.Field(default=None) - ) - """ - Name given to the Collection - """ - - singular_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="singularName")] = ( - pydantic.Field(default=None) - ) - """ - The name of one Item in Collection (e.g. ”Blog Post” if the Collection is called “Blog Posts”) - """ - + display_name: typing_extensions.Annotated[ + str, + FieldMetadata(alias="displayName"), + pydantic.Field(alias="displayName", description="Name given to the Collection"), + ] + singular_name: typing_extensions.Annotated[ + str, + FieldMetadata(alias="singularName"), + pydantic.Field( + alias="singularName", + description="The name of one Item in Collection (e.g. ”Blog Post” if the Collection is called “Blog Posts”)", + ), + ] slug: typing.Optional[str] = pydantic.Field(default=None) """ Slug of Collection in Site URL structure """ - created_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdOn")] = ( - pydantic.Field(default=None) - ) - """ - The date the collection was created - """ - - last_updated: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastUpdated")] = ( - pydantic.Field(default=None) - ) - """ - The date the collection was last updated - """ - + created_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="The date the collection was created"), + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="The date the collection was last updated"), + ] = None fields: typing.List[Field] = pydantic.Field() """ The list of fields in the Collection diff --git a/src/webflow/types/collection_item.py b/src/webflow/types/collection_item.py index 6551900..832a11c 100644 --- a/src/webflow/types/collection_item.py +++ b/src/webflow/types/collection_item.py @@ -1,12 +1,12 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata from .collection_item_field_data import CollectionItemFieldData -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class CollectionItem(UniversalBaseModel): @@ -23,49 +23,39 @@ class CollectionItem(UniversalBaseModel): Unique identifier for the Item """ - cms_locale_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="cmsLocaleId")] = ( - pydantic.Field(default=None) - ) - """ - Identifier for the locale of the CMS item - """ - - last_published: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="lastPublished")] = ( - pydantic.Field(default=None) - ) - """ - The date the item was last published - """ - - last_updated: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="lastUpdated")] = ( - pydantic.Field(default=None) - ) - """ - The date the item was last updated - """ - - created_on: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="createdOn")] = pydantic.Field( - default=None - ) - """ - The date the item was created - """ - - is_archived: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="isArchived")] = pydantic.Field( - default=None - ) - """ - Boolean determining if the Item is set to archived - """ - - is_draft: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="isDraft")] = pydantic.Field( - default=None - ) - """ - Boolean determining if the Item is set to draft - """ - - field_data: typing_extensions.Annotated[CollectionItemFieldData, FieldMetadata(alias="fieldData")] + cms_locale_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="cmsLocaleId"), + pydantic.Field(alias="cmsLocaleId", description="Identifier for the locale of the CMS item"), + ] = None + last_published: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="lastPublished"), + pydantic.Field(alias="lastPublished", description="The date the item was last published"), + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="The date the item was last updated"), + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="The date the item was created"), + ] = None + is_archived: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="isArchived"), + pydantic.Field(alias="isArchived", description="Boolean determining if the Item is set to archived"), + ] = None + is_draft: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="isDraft"), + pydantic.Field(alias="isDraft", description="Boolean determining if the Item is set to draft"), + ] = None + field_data: typing_extensions.Annotated[ + CollectionItemFieldData, FieldMetadata(alias="fieldData"), pydantic.Field(alias="fieldData") + ] if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/collection_item_changed.py b/src/webflow/types/collection_item_changed.py new file mode 100644 index 0000000..2586381 --- /dev/null +++ b/src/webflow/types/collection_item_changed.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .single_locale_created_payload import SingleLocaleCreatedPayload + + +class CollectionItemChanged(UniversalBaseModel): + """ + The Webhook payload for when a Collection Item is changed + """ + + trigger_type: typing_extensions.Annotated[ + typing.Literal["collection_item_changed"], + FieldMetadata(alias="triggerType"), + pydantic.Field(alias="triggerType", description="The type of event that triggered the request"), + ] = "collection_item_changed" + payload: SingleLocaleCreatedPayload + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/collection_item_created.py b/src/webflow/types/collection_item_created.py new file mode 100644 index 0000000..0103ed7 --- /dev/null +++ b/src/webflow/types/collection_item_created.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .single_locale_created_payload import SingleLocaleCreatedPayload + + +class CollectionItemCreated(UniversalBaseModel): + """ + The Webhook payload for when a Collection Item is created + """ + + trigger_type: typing_extensions.Annotated[ + typing.Literal["collection_item_created"], + FieldMetadata(alias="triggerType"), + pydantic.Field(alias="triggerType", description="The type of event that triggered the request"), + ] = "collection_item_created" + payload: SingleLocaleCreatedPayload + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/collection_item_field_data.py b/src/webflow/types/collection_item_field_data.py index 651dbe8..f531e2e 100644 --- a/src/webflow/types/collection_item_field_data.py +++ b/src/webflow/types/collection_item_field_data.py @@ -1,10 +1,10 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + class CollectionItemFieldData(UniversalBaseModel): name: str = pydantic.Field() diff --git a/src/webflow/types/collection_item_list.py b/src/webflow/types/collection_item_list.py index a1ff6d9..ee576c5 100644 --- a/src/webflow/types/collection_item_list.py +++ b/src/webflow/types/collection_item_list.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing -from .collection_item import CollectionItem + import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .collection_item import CollectionItem from .collection_item_list_pagination import CollectionItemListPagination -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class CollectionItemList(UniversalBaseModel): diff --git a/src/webflow/types/collection_item_list_no_pagination.py b/src/webflow/types/collection_item_list_no_pagination.py index 2b3f556..bdd0bcd 100644 --- a/src/webflow/types/collection_item_list_no_pagination.py +++ b/src/webflow/types/collection_item_list_no_pagination.py @@ -1,10 +1,10 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing -from .collection_item import CollectionItem + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .collection_item import CollectionItem class CollectionItemListNoPagination(UniversalBaseModel): diff --git a/src/webflow/types/collection_item_list_pagination.py b/src/webflow/types/collection_item_list_pagination.py index 394953b..a8f72be 100644 --- a/src/webflow/types/collection_item_list_pagination.py +++ b/src/webflow/types/collection_item_list_pagination.py @@ -1,23 +1,23 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel class CollectionItemListPagination(UniversalBaseModel): - limit: typing.Optional[float] = pydantic.Field(default=None) + limit: typing.Optional[int] = pydantic.Field(default=None) """ The limit specified in the request """ - offset: typing.Optional[float] = pydantic.Field(default=None) + offset: typing.Optional[int] = pydantic.Field(default=None) """ The offset specified for pagination """ - total: typing.Optional[float] = pydantic.Field(default=None) + total: typing.Optional[int] = pydantic.Field(default=None) """ Total number of items in the collection """ diff --git a/src/webflow/types/collection_item_patch_single.py b/src/webflow/types/collection_item_patch_single.py index 17266b0..64b0170 100644 --- a/src/webflow/types/collection_item_patch_single.py +++ b/src/webflow/types/collection_item_patch_single.py @@ -1,12 +1,12 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata from .collection_item_patch_single_field_data import CollectionItemPatchSingleFieldData -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class CollectionItemPatchSingle(UniversalBaseModel): @@ -19,50 +19,40 @@ class CollectionItemPatchSingle(UniversalBaseModel): Unique identifier for the Item """ - cms_locale_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="cmsLocaleId")] = ( - pydantic.Field(default=None) - ) - """ - Identifier for the locale of the CMS item - """ - - last_published: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="lastPublished")] = ( - pydantic.Field(default=None) - ) - """ - The date the item was last published - """ - - last_updated: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="lastUpdated")] = ( - pydantic.Field(default=None) - ) - """ - The date the item was last updated - """ - - created_on: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="createdOn")] = pydantic.Field( - default=None - ) - """ - The date the item was created - """ - - is_archived: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="isArchived")] = pydantic.Field( - default=None - ) - """ - Boolean determining if the Item is set to archived - """ - - is_draft: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="isDraft")] = pydantic.Field( - default=None - ) - """ - Boolean determining if the Item is set to draft - """ - + cms_locale_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="cmsLocaleId"), + pydantic.Field(alias="cmsLocaleId", description="Identifier for the locale of the CMS item"), + ] = None + last_published: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="lastPublished"), + pydantic.Field(alias="lastPublished", description="The date the item was last published"), + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="The date the item was last updated"), + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="The date the item was created"), + ] = None + is_archived: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="isArchived"), + pydantic.Field(alias="isArchived", description="Boolean determining if the Item is set to archived"), + ] = None + is_draft: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="isDraft"), + pydantic.Field(alias="isDraft", description="Boolean determining if the Item is set to draft"), + ] = None field_data: typing_extensions.Annotated[ - typing.Optional[CollectionItemPatchSingleFieldData], FieldMetadata(alias="fieldData") + typing.Optional[CollectionItemPatchSingleFieldData], + FieldMetadata(alias="fieldData"), + pydantic.Field(alias="fieldData"), ] = None if IS_PYDANTIC_V2: diff --git a/src/webflow/types/collection_item_patch_single_field_data.py b/src/webflow/types/collection_item_patch_single_field_data.py index 2d5d5f8..f952564 100644 --- a/src/webflow/types/collection_item_patch_single_field_data.py +++ b/src/webflow/types/collection_item_patch_single_field_data.py @@ -1,9 +1,9 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel class CollectionItemPatchSingleFieldData(UniversalBaseModel): diff --git a/src/webflow/types/collection_item_post_single.py b/src/webflow/types/collection_item_post_single.py index 3a9bafa..f58465a 100644 --- a/src/webflow/types/collection_item_post_single.py +++ b/src/webflow/types/collection_item_post_single.py @@ -1,12 +1,12 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata from .collection_item_post_single_field_data import CollectionItemPostSingleFieldData -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class CollectionItemPostSingle(UniversalBaseModel): @@ -23,49 +23,39 @@ class CollectionItemPostSingle(UniversalBaseModel): Unique identifier for the Item """ - cms_locale_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="cmsLocaleId")] = ( - pydantic.Field(default=None) - ) - """ - Identifier for the locale of the CMS item - """ - - last_published: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="lastPublished")] = ( - pydantic.Field(default=None) - ) - """ - The date the item was last published - """ - - last_updated: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="lastUpdated")] = ( - pydantic.Field(default=None) - ) - """ - The date the item was last updated - """ - - created_on: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="createdOn")] = pydantic.Field( - default=None - ) - """ - The date the item was created - """ - - is_archived: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="isArchived")] = pydantic.Field( - default=None - ) - """ - Boolean determining if the Item is in an archived state. - """ - - is_draft: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="isDraft")] = pydantic.Field( - default=None - ) - """ - Boolean determining if the Item is in a draft state. - """ - - field_data: typing_extensions.Annotated[CollectionItemPostSingleFieldData, FieldMetadata(alias="fieldData")] + cms_locale_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="cmsLocaleId"), + pydantic.Field(alias="cmsLocaleId", description="Identifier for the locale of the CMS item"), + ] = None + last_published: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="lastPublished"), + pydantic.Field(alias="lastPublished", description="The date the item was last published"), + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="The date the item was last updated"), + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="The date the item was created"), + ] = None + is_archived: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="isArchived"), + pydantic.Field(alias="isArchived", description="Boolean determining if the Item is in an archived state."), + ] = None + is_draft: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="isDraft"), + pydantic.Field(alias="isDraft", description="Boolean determining if the Item is in a draft state."), + ] = None + field_data: typing_extensions.Annotated[ + CollectionItemPostSingleFieldData, FieldMetadata(alias="fieldData"), pydantic.Field(alias="fieldData") + ] if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/collection_item_post_single_field_data.py b/src/webflow/types/collection_item_post_single_field_data.py index ae86f3b..ba4d35a 100644 --- a/src/webflow/types/collection_item_post_single_field_data.py +++ b/src/webflow/types/collection_item_post_single_field_data.py @@ -1,10 +1,10 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + class CollectionItemPostSingleFieldData(UniversalBaseModel): name: str = pydantic.Field() diff --git a/src/webflow/types/collection_item_published.py b/src/webflow/types/collection_item_published.py new file mode 100644 index 0000000..1b9acc0 --- /dev/null +++ b/src/webflow/types/collection_item_published.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .payload import Payload + + +class CollectionItemPublished(UniversalBaseModel): + trigger_type: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="triggerType"), + pydantic.Field(alias="triggerType", description="The type of event that triggered the request"), + ] = None + payload: typing.Optional[Payload] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/collection_item_removed.py b/src/webflow/types/collection_item_removed.py new file mode 100644 index 0000000..5c2af06 --- /dev/null +++ b/src/webflow/types/collection_item_removed.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .collection_item_removed_payload import CollectionItemRemovedPayload + + +class CollectionItemRemoved(UniversalBaseModel): + trigger_type: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="triggerType"), + pydantic.Field(alias="triggerType", description="The type of event that triggered the request"), + ] = None + payload: typing.Optional[CollectionItemRemovedPayload] = pydantic.Field(default=None) + """ + The payload of data sent from Webflow + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/collection_item_removed_payload.py b/src/webflow/types/collection_item_removed_payload.py new file mode 100644 index 0000000..011fb89 --- /dev/null +++ b/src/webflow/types/collection_item_removed_payload.py @@ -0,0 +1,71 @@ +# This file was auto-generated by Fern from our API Definition. + +import datetime as dt +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .collection_item_removed_payload_field_data import CollectionItemRemovedPayloadFieldData + + +class CollectionItemRemovedPayload(UniversalBaseModel): + """ + The payload of data sent from Webflow + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the collection item that was deleted + """ + + site_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="siteId"), + pydantic.Field(alias="siteId", description="The ID of the site"), + ] = None + workspace_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="workspaceId"), + pydantic.Field(alias="workspaceId", description="The ID of the workspace"), + ] = None + collection_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="collectionId"), + pydantic.Field(alias="collectionId", description="The ID of the collection"), + ] = None + cms_locale_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="cmsLocaleId"), + pydantic.Field(alias="cmsLocaleId", description="Unique identifier of the CMS locale for this item"), + ] = None + last_published: typing_extensions.Annotated[ + typing.Optional[dt.datetime], FieldMetadata(alias="lastPublished"), pydantic.Field(alias="lastPublished") + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[dt.datetime], FieldMetadata(alias="lastUpdated"), pydantic.Field(alias="lastUpdated") + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], FieldMetadata(alias="createdOn"), pydantic.Field(alias="createdOn") + ] = None + is_archived: typing_extensions.Annotated[ + typing.Optional[bool], FieldMetadata(alias="isArchived"), pydantic.Field(alias="isArchived") + ] = None + is_draft: typing_extensions.Annotated[ + typing.Optional[bool], FieldMetadata(alias="isDraft"), pydantic.Field(alias="isDraft") + ] = None + field_data: typing_extensions.Annotated[ + typing.Optional[CollectionItemRemovedPayloadFieldData], + FieldMetadata(alias="fieldData"), + pydantic.Field(alias="fieldData"), + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/collection_item_removed_payload_field_data.py b/src/webflow/types/collection_item_removed_payload_field_data.py new file mode 100644 index 0000000..048baf4 --- /dev/null +++ b/src/webflow/types/collection_item_removed_payload_field_data.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class CollectionItemRemovedPayloadFieldData(UniversalBaseModel): + name: str + slug: str + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/collection_item_unpublished.py b/src/webflow/types/collection_item_unpublished.py new file mode 100644 index 0000000..a9200be --- /dev/null +++ b/src/webflow/types/collection_item_unpublished.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .collection_item_unpublished_payload import CollectionItemUnpublishedPayload + + +class CollectionItemUnpublished(UniversalBaseModel): + trigger_type: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="triggerType"), + pydantic.Field(alias="triggerType", description="The type of event that triggered the request"), + ] = None + payload: typing.Optional[CollectionItemUnpublishedPayload] = pydantic.Field(default=None) + """ + The payload of data sent from Webflow + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/collection_item_unpublished_payload.py b/src/webflow/types/collection_item_unpublished_payload.py new file mode 100644 index 0000000..2867a45 --- /dev/null +++ b/src/webflow/types/collection_item_unpublished_payload.py @@ -0,0 +1,71 @@ +# This file was auto-generated by Fern from our API Definition. + +import datetime as dt +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .collection_item_unpublished_payload_field_data import CollectionItemUnpublishedPayloadFieldData + + +class CollectionItemUnpublishedPayload(UniversalBaseModel): + """ + The payload of data sent from Webflow + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the collection item that was unpublished + """ + + site_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="siteId"), + pydantic.Field(alias="siteId", description="The ID of the site"), + ] = None + workspace_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="workspaceId"), + pydantic.Field(alias="workspaceId", description="The ID of the workspace"), + ] = None + collection_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="collectionId"), + pydantic.Field(alias="collectionId", description="The ID of the collection"), + ] = None + cms_locale_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="cmsLocaleId"), + pydantic.Field(alias="cmsLocaleId", description="Unique identifier of the CMS locale for this item"), + ] = None + last_published: typing_extensions.Annotated[ + typing.Optional[dt.datetime], FieldMetadata(alias="lastPublished"), pydantic.Field(alias="lastPublished") + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[dt.datetime], FieldMetadata(alias="lastUpdated"), pydantic.Field(alias="lastUpdated") + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], FieldMetadata(alias="createdOn"), pydantic.Field(alias="createdOn") + ] = None + is_archived: typing_extensions.Annotated[ + typing.Optional[bool], FieldMetadata(alias="isArchived"), pydantic.Field(alias="isArchived") + ] = None + is_draft: typing_extensions.Annotated[ + typing.Optional[bool], FieldMetadata(alias="isDraft"), pydantic.Field(alias="isDraft") + ] = None + field_data: typing_extensions.Annotated[ + typing.Optional[CollectionItemUnpublishedPayloadFieldData], + FieldMetadata(alias="fieldData"), + pydantic.Field(alias="fieldData"), + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/collection_item_unpublished_payload_field_data.py b/src/webflow/types/collection_item_unpublished_payload_field_data.py new file mode 100644 index 0000000..a2004c1 --- /dev/null +++ b/src/webflow/types/collection_item_unpublished_payload_field_data.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class CollectionItemUnpublishedPayloadFieldData(UniversalBaseModel): + name: str + slug: str + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/collection_item_with_id_input.py b/src/webflow/types/collection_item_with_id_input.py index df3cd7e..0a1aae2 100644 --- a/src/webflow/types/collection_item_with_id_input.py +++ b/src/webflow/types/collection_item_with_id_input.py @@ -1,12 +1,12 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel +import typing + import pydantic import typing_extensions -import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata from .collection_item_with_id_input_field_data import CollectionItemWithIdInputFieldData -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class CollectionItemWithIdInput(UniversalBaseModel): @@ -19,50 +19,40 @@ class CollectionItemWithIdInput(UniversalBaseModel): Unique identifier for the Item """ - cms_locale_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="cmsLocaleId")] = ( - pydantic.Field(default=None) - ) - """ - Identifier for the locale of the CMS item - """ - - last_published: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="lastPublished")] = ( - pydantic.Field(default=None) - ) - """ - The date the item was last published - """ - - last_updated: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="lastUpdated")] = ( - pydantic.Field(default=None) - ) - """ - The date the item was last updated - """ - - created_on: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="createdOn")] = pydantic.Field( - default=None - ) - """ - The date the item was created - """ - - is_archived: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="isArchived")] = pydantic.Field( - default=None - ) - """ - Boolean determining if the Item is set to archived - """ - - is_draft: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="isDraft")] = pydantic.Field( - default=None - ) - """ - Boolean determining if the Item is set to draft - """ - + cms_locale_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="cmsLocaleId"), + pydantic.Field(alias="cmsLocaleId", description="Identifier for the locale of the CMS item"), + ] = None + last_published: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="lastPublished"), + pydantic.Field(alias="lastPublished", description="The date the item was last published"), + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="The date the item was last updated"), + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="The date the item was created"), + ] = None + is_archived: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="isArchived"), + pydantic.Field(alias="isArchived", description="Boolean determining if the Item is set to archived"), + ] = None + is_draft: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="isDraft"), + pydantic.Field(alias="isDraft", description="Boolean determining if the Item is set to draft"), + ] = None field_data: typing_extensions.Annotated[ - typing.Optional[CollectionItemWithIdInputFieldData], FieldMetadata(alias="fieldData") + typing.Optional[CollectionItemWithIdInputFieldData], + FieldMetadata(alias="fieldData"), + pydantic.Field(alias="fieldData"), ] = None if IS_PYDANTIC_V2: diff --git a/src/webflow/types/collection_item_with_id_input_field_data.py b/src/webflow/types/collection_item_with_id_input_field_data.py index 3109eb2..d27ccab 100644 --- a/src/webflow/types/collection_item_with_id_input_field_data.py +++ b/src/webflow/types/collection_item_with_id_input_field_data.py @@ -1,9 +1,9 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel class CollectionItemWithIdInputFieldData(UniversalBaseModel): diff --git a/src/webflow/types/collection_list.py b/src/webflow/types/collection_list.py index a1ac376..bfa7212 100644 --- a/src/webflow/types/collection_list.py +++ b/src/webflow/types/collection_list.py @@ -1,10 +1,10 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing -from .collection_list_array_item import CollectionListArrayItem + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .collection_list_array_item import CollectionListArrayItem class CollectionList(UniversalBaseModel): diff --git a/src/webflow/types/collection_list_array_item.py b/src/webflow/types/collection_list_array_item.py index 77e518a..035f7e0 100644 --- a/src/webflow/types/collection_list_array_item.py +++ b/src/webflow/types/collection_list_array_item.py @@ -1,12 +1,12 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel +import datetime as dt +import typing + import pydantic import typing_extensions -import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -import datetime as dt -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class CollectionListArrayItem(UniversalBaseModel): @@ -19,38 +19,34 @@ class CollectionListArrayItem(UniversalBaseModel): Unique identifier for a Collection """ - display_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="displayName")] = ( - pydantic.Field(default=None) - ) - """ - Name given to the Collection - """ - - singular_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="singularName")] = ( - pydantic.Field(default=None) - ) - """ - The name of one Item in Collection (e.g. ”Blog Post” if the Collection is called “Blog Posts”) - """ - + display_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="displayName"), + pydantic.Field(alias="displayName", description="Name given to the Collection"), + ] = None + singular_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="singularName"), + pydantic.Field( + alias="singularName", + description="The name of one Item in Collection (e.g. ”Blog Post” if the Collection is called “Blog Posts”)", + ), + ] = None slug: typing.Optional[str] = pydantic.Field(default=None) """ Slug of Collection in Site URL structure """ - created_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdOn")] = ( - pydantic.Field(default=None) - ) - """ - The date the collection was created - """ - - last_updated: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastUpdated")] = ( - pydantic.Field(default=None) - ) - """ - The date the collection was last updated - """ + created_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="The date the collection was created"), + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="The date the collection was last updated"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/comment.py b/src/webflow/types/comment.py new file mode 100644 index 0000000..743c912 --- /dev/null +++ b/src/webflow/types/comment.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .comment_payload import CommentPayload + + +class Comment(UniversalBaseModel): + """ + The Webhook payload for when a comment thread or reply is made on a Site + """ + + trigger_type: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="triggerType"), + pydantic.Field(alias="triggerType", description="The type of event that triggered the request"), + ] = None + payload: typing.Optional[CommentPayload] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/comment_payload.py b/src/webflow/types/comment_payload.py new file mode 100644 index 0000000..8b51391 --- /dev/null +++ b/src/webflow/types/comment_payload.py @@ -0,0 +1,100 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .comment_payload_author import CommentPayloadAuthor +from .comment_payload_mentioned_users_item import CommentPayloadMentionedUsersItem + + +class CommentPayload(UniversalBaseModel): + """ + The comment webhook payload contains data for the thread and for replies. Check the type to determine if the payload is for a thread or a reply. The webhook payload may be delayed by up to 5 minutes. + """ + + thread_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="threadId"), + pydantic.Field(alias="threadId", description="Unique identifier for the comment thread"), + ] = None + comment_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="commentId"), + pydantic.Field(alias="commentId", description="Unique identifier for the comment reply"), + ] = None + type: typing.Optional[str] = pydantic.Field(default=None) + """ + The type of comment payload + """ + + site_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="siteId"), + pydantic.Field(alias="siteId", description="The site unique identifier"), + ] = None + page_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="pageId"), + pydantic.Field(alias="pageId", description="The page unique identifier"), + ] = None + locale_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="localeId"), + pydantic.Field(alias="localeId", description="The locale unique identifier"), + ] = None + item_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="itemId"), + pydantic.Field(alias="itemId", description="The item unique identifier"), + ] = None + breakpoint: typing.Optional[str] = pydantic.Field(default=None) + """ + The breakpoint the comment was left on + """ + + url: typing.Optional[str] = pydantic.Field(default=None) + """ + The URL of the page the comment was left on + """ + + content: str = pydantic.Field() + """ + The content of the comment reply + """ + + is_resolved: typing_extensions.Annotated[ + bool, + FieldMetadata(alias="isResolved"), + pydantic.Field(alias="isResolved", description="Boolean determining if the comment thread is resolved"), + ] + author: CommentPayloadAuthor + mentioned_users: typing_extensions.Annotated[ + typing.List[CommentPayloadMentionedUsersItem], + FieldMetadata(alias="mentionedUsers"), + pydantic.Field( + alias="mentionedUsers", + description="List of mentioned users. This is an empty array until email notifications are sent, which can take up to 5 minutes after the comment is created.", + ), + ] + created_on: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="The date the item was created"), + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="The date the item was last updated"), + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/comment_payload_author.py b/src/webflow/types/comment_payload_author.py new file mode 100644 index 0000000..a1f8e03 --- /dev/null +++ b/src/webflow/types/comment_payload_author.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata + + +class CommentPayloadAuthor(UniversalBaseModel): + user_id: typing_extensions.Annotated[ + str, + FieldMetadata(alias="userId"), + pydantic.Field(alias="userId", description="The unique identifier of the author"), + ] + email: str = pydantic.Field() + """ + Email of the author + """ + + name: str = pydantic.Field() + """ + Name of the author + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/comment_payload_mentioned_users_item.py b/src/webflow/types/comment_payload_mentioned_users_item.py new file mode 100644 index 0000000..d9e46b1 --- /dev/null +++ b/src/webflow/types/comment_payload_mentioned_users_item.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata + + +class CommentPayloadMentionedUsersItem(UniversalBaseModel): + user_id: typing_extensions.Annotated[ + str, + FieldMetadata(alias="userId"), + pydantic.Field(alias="userId", description="The unique identifier of the mentioned user"), + ] + email: str = pydantic.Field() + """ + Email of the user + """ + + name: str = pydantic.Field() + """ + Name of the User + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/comment_reply.py b/src/webflow/types/comment_reply.py new file mode 100644 index 0000000..e3d258a --- /dev/null +++ b/src/webflow/types/comment_reply.py @@ -0,0 +1,81 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .comment_reply_author import CommentReplyAuthor +from .comment_reply_mentioned_users_item import CommentReplyMentionedUsersItem + + +class CommentReply(UniversalBaseModel): + """ + A comment thread represents a conversation between users on a specific page. Each comment thread has a unique identifier and can contain multiple comments. + """ + + id: str = pydantic.Field() + """ + Unique identifier for the comment thread + """ + + comment_id: typing_extensions.Annotated[ + str, + FieldMetadata(alias="commentId"), + pydantic.Field(alias="commentId", description="The comment reply unique identifier"), + ] + site_id: typing_extensions.Annotated[ + str, FieldMetadata(alias="siteId"), pydantic.Field(alias="siteId", description="The site unique identifier") + ] + page_id: typing_extensions.Annotated[ + str, FieldMetadata(alias="pageId"), pydantic.Field(alias="pageId", description="The page unique identifier") + ] + locale_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="localeId"), + pydantic.Field(alias="localeId", description="The locale unique identifier"), + ] = None + breakpoint: str = pydantic.Field() + """ + The breakpoint the comment was left on + """ + + content: str = pydantic.Field() + """ + The content of the comment reply + """ + + is_resolved: typing_extensions.Annotated[ + bool, + FieldMetadata(alias="isResolved"), + pydantic.Field(alias="isResolved", description="Boolean determining if the comment thread is resolved"), + ] + author: CommentReplyAuthor + mentioned_users: typing_extensions.Annotated[ + typing.Optional[typing.List[CommentReplyMentionedUsersItem]], + FieldMetadata(alias="mentionedUsers"), + pydantic.Field( + alias="mentionedUsers", + description="List of mentioned users is an empty array until email notifications are sent.", + ), + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="The date the item was last updated"), + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="The date the item was created"), + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/comment_reply_author.py b/src/webflow/types/comment_reply_author.py new file mode 100644 index 0000000..71fece2 --- /dev/null +++ b/src/webflow/types/comment_reply_author.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class CommentReplyAuthor(UniversalBaseModel): + id: str = pydantic.Field() + """ + The unique identifier of the author + """ + + email: str = pydantic.Field() + """ + Email of the author + """ + + name: str = pydantic.Field() + """ + Name of the author + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/comment_reply_list.py b/src/webflow/types/comment_reply_list.py new file mode 100644 index 0000000..5a4cc7c --- /dev/null +++ b/src/webflow/types/comment_reply_list.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .comment_reply import CommentReply +from .comment_reply_list_pagination import CommentReplyListPagination + + +class CommentReplyList(UniversalBaseModel): + """ + A list of comment replies. + """ + + comments: typing.List[CommentReply] + pagination: CommentReplyListPagination + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/comment_reply_list_pagination.py b/src/webflow/types/comment_reply_list_pagination.py new file mode 100644 index 0000000..580ee06 --- /dev/null +++ b/src/webflow/types/comment_reply_list_pagination.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class CommentReplyListPagination(UniversalBaseModel): + limit: int = pydantic.Field() + """ + The limit specified in the request (default 100) + """ + + offset: int = pydantic.Field() + """ + The offset specified for pagination + """ + + total: int = pydantic.Field() + """ + Total number of comment replies + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/comment_reply_mentioned_users_item.py b/src/webflow/types/comment_reply_mentioned_users_item.py new file mode 100644 index 0000000..7315c20 --- /dev/null +++ b/src/webflow/types/comment_reply_mentioned_users_item.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class CommentReplyMentionedUsersItem(UniversalBaseModel): + id: str = pydantic.Field() + """ + The unique identifier of the mentioned user + """ + + email: str = pydantic.Field() + """ + Email of the user + """ + + name: str = pydantic.Field() + """ + Name of the User + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/comment_thread.py b/src/webflow/types/comment_thread.py new file mode 100644 index 0000000..44f1369 --- /dev/null +++ b/src/webflow/types/comment_thread.py @@ -0,0 +1,86 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .comment_thread_author import CommentThreadAuthor +from .comment_thread_mentioned_users_item import CommentThreadMentionedUsersItem + + +class CommentThread(UniversalBaseModel): + """ + A comment thread represents a conversation between users on a specific page. Each comment thread has a unique identifier and can contain multiple comments. Retrieve comment replies using the replies API endpoint. + """ + + id: str = pydantic.Field() + """ + Unique identifier for the comment thread + """ + + site_id: typing_extensions.Annotated[ + str, FieldMetadata(alias="siteId"), pydantic.Field(alias="siteId", description="The site unique identifier") + ] + page_id: typing_extensions.Annotated[ + str, FieldMetadata(alias="pageId"), pydantic.Field(alias="pageId", description="The page unique identifier") + ] + locale_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="localeId"), + pydantic.Field(alias="localeId", description="The locale unique identifier"), + ] = None + item_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="itemId"), + pydantic.Field(alias="itemId", description="The item unique identifier"), + ] = None + breakpoint: str = pydantic.Field() + """ + The breakpoint the comment was left on + """ + + url: str = pydantic.Field() + """ + The URL of the page the comment was left on + """ + + content: str = pydantic.Field() + """ + The content of the comment reply + """ + + is_resolved: typing_extensions.Annotated[ + bool, + FieldMetadata(alias="isResolved"), + pydantic.Field(alias="isResolved", description="Boolean determining if the comment thread is resolved"), + ] + author: CommentThreadAuthor + mentioned_users: typing_extensions.Annotated[ + typing.List[CommentThreadMentionedUsersItem], + FieldMetadata(alias="mentionedUsers"), + pydantic.Field( + alias="mentionedUsers", + description="List of mentioned users. This is an empty array until email notifications are sent, which can take up to 5 minutes after the comment is created.", + ), + ] + created_on: typing_extensions.Annotated[ + str, + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="The date the item was created"), + ] + last_updated: typing_extensions.Annotated[ + str, + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="The date the item was last updated"), + ] + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/comment_thread_author.py b/src/webflow/types/comment_thread_author.py new file mode 100644 index 0000000..00cee01 --- /dev/null +++ b/src/webflow/types/comment_thread_author.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata + + +class CommentThreadAuthor(UniversalBaseModel): + user_id: typing_extensions.Annotated[ + str, + FieldMetadata(alias="userId"), + pydantic.Field(alias="userId", description="The unique identifier of the author"), + ] + email: str = pydantic.Field() + """ + Email of the author + """ + + name: str = pydantic.Field() + """ + Name of the author + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/comment_thread_list.py b/src/webflow/types/comment_thread_list.py new file mode 100644 index 0000000..1b3db57 --- /dev/null +++ b/src/webflow/types/comment_thread_list.py @@ -0,0 +1,26 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .comment_thread import CommentThread +from .comment_thread_list_pagination import CommentThreadListPagination + + +class CommentThreadList(UniversalBaseModel): + """ + A list of comment threads on the site. Contains the content of the first reply. + """ + + comments: typing.List[CommentThread] + pagination: CommentThreadListPagination + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/comment_thread_list_pagination.py b/src/webflow/types/comment_thread_list_pagination.py new file mode 100644 index 0000000..e1e22fe --- /dev/null +++ b/src/webflow/types/comment_thread_list_pagination.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class CommentThreadListPagination(UniversalBaseModel): + limit: int = pydantic.Field() + """ + The limit specified in the request (default 100) + """ + + offset: int = pydantic.Field() + """ + The offset specified for pagination + """ + + total: int = pydantic.Field() + """ + Total number of comment threads + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/comment_thread_mentioned_users_item.py b/src/webflow/types/comment_thread_mentioned_users_item.py new file mode 100644 index 0000000..124037a --- /dev/null +++ b/src/webflow/types/comment_thread_mentioned_users_item.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata + + +class CommentThreadMentionedUsersItem(UniversalBaseModel): + user_id: typing_extensions.Annotated[ + str, + FieldMetadata(alias="userId"), + pydantic.Field(alias="userId", description="The unique identifier of the mentioned user"), + ] + email: str = pydantic.Field() + """ + Email of the user + """ + + name: str = pydantic.Field() + """ + Name of the User + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/component.py b/src/webflow/types/component.py index ae6fea2..51f3d72 100644 --- a/src/webflow/types/component.py +++ b/src/webflow/types/component.py @@ -1,9 +1,9 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import pydantic import typing -from ..core.pydantic_utilities import IS_PYDANTIC_V2 + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel class Component(UniversalBaseModel): diff --git a/src/webflow/types/component_dom.py b/src/webflow/types/component_dom.py index 3f76c81..5c2d621 100644 --- a/src/webflow/types/component_dom.py +++ b/src/webflow/types/component_dom.py @@ -1,27 +1,25 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions import typing -from ..core.serialization import FieldMetadata + import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata from .node import Node from .pagination import Pagination -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class ComponentDom(UniversalBaseModel): """ - The Component DOM schema represents the content structure of a component. Similar to Page DOM, it captures various content nodes and their associated attributes, but specifically for a component's structure. Each node has a unique identifier and can contain text, images, or nested component instances. - """ - - component_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="componentId")] = ( - pydantic.Field(default=None) - ) - """ - Component ID + The Component DOM schema represents the content structure of a component. Similar to Page DOM, it captures various content nodes and their associated attributes, but specifically for a component's structure. Each node has a unique identifier and can contain text, images, select or text inputs, submit buttons, or nested component instances. """ + component_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="componentId"), + pydantic.Field(alias="componentId", description="Component ID"), + ] = None nodes: typing.Optional[typing.List[Node]] = None pagination: typing.Optional[Pagination] = None diff --git a/src/webflow/types/component_instance_node_property_overrides_write.py b/src/webflow/types/component_instance_node_property_overrides_write.py index 6c7d69c..ddcf2cb 100644 --- a/src/webflow/types/component_instance_node_property_overrides_write.py +++ b/src/webflow/types/component_instance_node_property_overrides_write.py @@ -1,14 +1,14 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel +import typing + +import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -import pydantic -import typing from .component_instance_node_property_overrides_write_property_overrides_item import ( ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem, ) -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class ComponentInstanceNodePropertyOverridesWrite(UniversalBaseModel): @@ -16,18 +16,17 @@ class ComponentInstanceNodePropertyOverridesWrite(UniversalBaseModel): Update text property overrides of a component instance """ - node_id: typing_extensions.Annotated[str, FieldMetadata(alias="nodeId")] = pydantic.Field() - """ - Node UUID - """ - + node_id: typing_extensions.Annotated[ + str, FieldMetadata(alias="nodeId"), pydantic.Field(alias="nodeId", description="Node UUID") + ] property_overrides: typing_extensions.Annotated[ typing.List[ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem], FieldMetadata(alias="propertyOverrides"), - ] = pydantic.Field() - """ - A list of component instance properties to override within the specified secondary locale. - """ + pydantic.Field( + alias="propertyOverrides", + description="A list of component instance properties to override within the specified secondary locale.", + ), + ] if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/component_instance_node_property_overrides_write_property_overrides_item.py b/src/webflow/types/component_instance_node_property_overrides_write_property_overrides_item.py index 313b0d6..13e1256 100644 --- a/src/webflow/types/component_instance_node_property_overrides_write_property_overrides_item.py +++ b/src/webflow/types/component_instance_node_property_overrides_write_property_overrides_item.py @@ -1,24 +1,24 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel +import typing + +import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 -import typing class ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem(UniversalBaseModel): - property_id: typing_extensions.Annotated[str, FieldMetadata(alias="propertyId")] = pydantic.Field() - """ - The ID of the property. - """ - + property_id: typing_extensions.Annotated[ + str, + FieldMetadata(alias="propertyId"), + pydantic.Field(alias="propertyId", description="The ID of the property."), + ] text: str = pydantic.Field() """ - The new string or HTML value used to override the component instance property value. - The provided value must be compatible with the type of the component instance property. - For example, attempting to override a single-line plain-text property with a multi-line + The new string or HTML value used to override the component instance property value. + The provided value must be compatible with the type of the component instance property. + For example, attempting to override a single-line plain-text property with a multi-line value will result in an error. """ diff --git a/src/webflow/types/component_list.py b/src/webflow/types/component_list.py index cd16188..de17894 100644 --- a/src/webflow/types/component_list.py +++ b/src/webflow/types/component_list.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from .component import Component from .pagination import Pagination -from ..core.pydantic_utilities import IS_PYDANTIC_V2 -import pydantic class ComponentList(UniversalBaseModel): diff --git a/src/webflow/types/component_node.py b/src/webflow/types/component_node.py index fa5f69d..d091d2a 100644 --- a/src/webflow/types/component_node.py +++ b/src/webflow/types/component_node.py @@ -1,12 +1,12 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata from .component_property import ComponentProperty -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class ComponentNode(UniversalBaseModel): @@ -14,24 +14,24 @@ class ComponentNode(UniversalBaseModel): Represents a component instance within the DOM. It contains details about the component instance, such as its type and properties. """ - id: typing.Optional[str] = pydantic.Field(default=None) - """ - Node UUID - """ - - component_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="componentId")] = ( - pydantic.Field(default=None) - ) + id: str = pydantic.Field() """ - Component ID + The unique identifier of the component instance node """ + component_id: typing_extensions.Annotated[ + str, + FieldMetadata(alias="componentId"), + pydantic.Field(alias="componentId", description="The unique identifier of the component"), + ] property_overrides: typing_extensions.Annotated[ - typing.Optional[typing.List[ComponentProperty]], FieldMetadata(alias="propertyOverrides") - ] = pydantic.Field(default=None) - """ - List of component properties with overrides for a component instance. - """ + typing.List[ComponentProperty], + FieldMetadata(alias="propertyOverrides"), + pydantic.Field( + alias="propertyOverrides", + description="List of component properties with overrides for a component instance.", + ), + ] if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/component_properties.py b/src/webflow/types/component_properties.py index f37e71b..aa97a9c 100644 --- a/src/webflow/types/component_properties.py +++ b/src/webflow/types/component_properties.py @@ -1,13 +1,13 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions import typing -from ..core.serialization import FieldMetadata + import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata from .component_property import ComponentProperty from .pagination import Pagination -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class ComponentProperties(UniversalBaseModel): @@ -15,13 +15,11 @@ class ComponentProperties(UniversalBaseModel): The Component Properties schema represents a list of properties that store text content. Each property has a unique identifier and can be of different types like plain text or rich text. The schema also provides pagination details for scenarios where there more properties than the limit. """ - component_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="componentId")] = ( - pydantic.Field(default=None) - ) - """ - Component ID - """ - + component_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="componentId"), + pydantic.Field(alias="componentId", description="Component ID"), + ] = None properties: typing.Optional[typing.List[ComponentProperty]] = None pagination: typing.Optional[Pagination] = None diff --git a/src/webflow/types/component_property.py b/src/webflow/types/component_property.py index 7f09d8e..4583f4d 100644 --- a/src/webflow/types/component_property.py +++ b/src/webflow/types/component_property.py @@ -1,13 +1,13 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions import typing -from ..core.serialization import FieldMetadata + import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata from .component_property_type import ComponentPropertyType from .text import Text -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class ComponentProperty(UniversalBaseModel): @@ -15,13 +15,11 @@ class ComponentProperty(UniversalBaseModel): Represents a property of a component instance in the DOM. A property contains a list of both the raw text and the HTML representation, allowing for flexibility in rendering and processing. Additional attributes can be associated with the text for styling or other purposes. """ - property_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="propertyId")] = pydantic.Field( - default=None - ) - """ - The ID of the property. - """ - + property_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="propertyId"), + pydantic.Field(alias="propertyId", description="The ID of the property."), + ] = None type: typing.Optional[ComponentPropertyType] = pydantic.Field(default=None) """ The type of the property. diff --git a/tests/__init__.py b/src/webflow/types/conflict.py similarity index 63% rename from tests/__init__.py rename to src/webflow/types/conflict.py index f3ea265..f90bc65 100644 --- a/tests/__init__.py +++ b/src/webflow/types/conflict.py @@ -1,2 +1,5 @@ # This file was auto-generated by Fern from our API Definition. +import typing + +Conflict = typing.Any diff --git a/src/webflow/types/conflict_error_body.py b/src/webflow/types/conflict_error_body.py deleted file mode 100644 index 2ec15f8..0000000 --- a/src/webflow/types/conflict_error_body.py +++ /dev/null @@ -1,7 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing -from .duplicate_user_email import DuplicateUserEmail -from .user_limit_reached import UserLimitReached - -ConflictErrorBody = typing.Union[DuplicateUserEmail, UserLimitReached] diff --git a/src/webflow/types/custom_code_block.py b/src/webflow/types/custom_code_block.py index f52e4b8..ea8c8fb 100644 --- a/src/webflow/types/custom_code_block.py +++ b/src/webflow/types/custom_code_block.py @@ -1,14 +1,14 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions +import datetime as dt import typing -from ..core.serialization import FieldMetadata + import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata from .custom_code_block_type import CustomCodeBlockType from .scripts import Scripts -import datetime as dt -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class CustomCodeBlock(UniversalBaseModel): @@ -16,39 +16,32 @@ class CustomCodeBlock(UniversalBaseModel): A specific instance of Custom Code applied to a Site or Page """ - site_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="siteId")] = pydantic.Field( - default=None - ) - """ - The Site ID where the custom code was applied - """ - - page_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="pageId")] = pydantic.Field( - default=None - ) - """ - The Page ID (if applied at Page-level) - """ - + site_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="siteId"), + pydantic.Field(alias="siteId", description="The Site ID where the custom code was applied"), + ] = None + page_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="pageId"), + pydantic.Field(alias="pageId", description="The Page ID (if applied at Page-level)"), + ] = None type: typing.Optional[CustomCodeBlockType] = pydantic.Field(default=None) """ Whether the Custom Code script is applied at the Site-level or Page-level """ scripts: typing.Optional[Scripts] = None - created_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdOn")] = ( - pydantic.Field(default=None) - ) - """ - The date the Block was created - """ - - last_updated: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastUpdated")] = ( - pydantic.Field(default=None) - ) - """ - The date the Block was most recently updated - """ + created_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="The date the Block was created"), + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="The date the Block was most recently updated"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/custom_code_hosted_response.py b/src/webflow/types/custom_code_hosted_response.py index 9bc97cf..ddc3bab 100644 --- a/src/webflow/types/custom_code_hosted_response.py +++ b/src/webflow/types/custom_code_hosted_response.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class CustomCodeHostedResponse(UniversalBaseModel): @@ -18,48 +18,44 @@ class CustomCodeHostedResponse(UniversalBaseModel): Human readable id, derived from the user-specified display name """ - can_copy: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="canCopy")] = pydantic.Field( - default=None - ) - """ - Define whether the script can be copied on site duplication and transfer - """ - - display_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="displayName")] = ( - pydantic.Field(default=None) - ) - """ - User-facing name for the script. Must be between 1 and 50 alphanumeric characters - """ - - hosted_location: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="hostedLocation")] = ( - pydantic.Field(default=None) - ) - """ - URI for an externally hosted script location - """ - - integrity_hash: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="integrityHash")] = ( - pydantic.Field(default=None) - ) - """ - Sub-Resource Integrity Hash. Only required for externally hosted scripts (passed via hostedLocation) - """ - - created_on: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="createdOn")] = pydantic.Field( - default=None - ) - """ - Timestamp when the script version was created - """ - - last_updated: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="lastUpdated")] = ( - pydantic.Field(default=None) - ) - """ - Timestamp when the script version was last updated - """ - + can_copy: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="canCopy"), + pydantic.Field( + alias="canCopy", description="Define whether the script can be copied on site duplication and transfer" + ), + ] = None + display_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="displayName"), + pydantic.Field( + alias="displayName", + description="User-facing name for the script. Must be between 1 and 50 alphanumeric characters", + ), + ] = None + hosted_location: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="hostedLocation"), + pydantic.Field(alias="hostedLocation", description="URI for an externally hosted script location"), + ] = None + integrity_hash: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="integrityHash"), + pydantic.Field( + alias="integrityHash", + description="Sub-Resource Integrity Hash. Only required for externally hosted scripts (passed via hostedLocation)", + ), + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="Timestamp when the script version was created"), + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="Timestamp when the script version was last updated"), + ] = None version: typing.Optional[str] = pydantic.Field(default=None) """ A Semantic Version (SemVer) string, denoting the version of the script diff --git a/src/webflow/types/custom_code_inline_response.py b/src/webflow/types/custom_code_inline_response.py index 7934ec5..971d0d1 100644 --- a/src/webflow/types/custom_code_inline_response.py +++ b/src/webflow/types/custom_code_inline_response.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class CustomCodeInlineResponse(UniversalBaseModel): @@ -18,48 +18,44 @@ class CustomCodeInlineResponse(UniversalBaseModel): Human readable id, derived from the user-specified display name """ - can_copy: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="canCopy")] = pydantic.Field( - default=None - ) - """ - Define whether the script can be copied on site duplication and transfer - """ - - display_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="displayName")] = ( - pydantic.Field(default=None) - ) - """ - User-facing name for the script. Must be between 1 and 50 alphanumeric characters - """ - - hosted_location: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="hostedLocation")] = ( - pydantic.Field(default=None) - ) - """ - URI for an externally hosted script location - """ - - integrity_hash: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="integrityHash")] = ( - pydantic.Field(default=None) - ) - """ - Sub-Resource Integrity Hash. Only required for externally hosted scripts (passed via hostedLocation) - """ - - created_on: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="createdOn")] = pydantic.Field( - default=None - ) - """ - Timestamp when the script version was created - """ - - last_updated: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="lastUpdated")] = ( - pydantic.Field(default=None) - ) - """ - Timestamp when the script version was last updated - """ - + can_copy: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="canCopy"), + pydantic.Field( + alias="canCopy", description="Define whether the script can be copied on site duplication and transfer" + ), + ] = None + display_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="displayName"), + pydantic.Field( + alias="displayName", + description="User-facing name for the script. Must be between 1 and 50 alphanumeric characters", + ), + ] = None + hosted_location: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="hostedLocation"), + pydantic.Field(alias="hostedLocation", description="URI for an externally hosted script location"), + ] = None + integrity_hash: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="integrityHash"), + pydantic.Field( + alias="integrityHash", + description="Sub-Resource Integrity Hash. Only required for externally hosted scripts (passed via hostedLocation)", + ), + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="Timestamp when the script version was created"), + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="Timestamp when the script version was last updated"), + ] = None version: typing.Optional[str] = pydantic.Field(default=None) """ A Semantic Version (SemVer) string, denoting the version of the script diff --git a/src/webflow/types/custom_role.py b/src/webflow/types/custom_role.py new file mode 100644 index 0000000..5c45925 --- /dev/null +++ b/src/webflow/types/custom_role.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata + + +class CustomRole(UniversalBaseModel): + role_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="roleName"), + pydantic.Field(alias="roleName", description="The name of the custom role"), + ] = None + previous_role_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="previousRoleName"), + pydantic.Field(alias="previousRoleName", description="The previous name of the custom role"), + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/custom_role_audit_log_item.py b/src/webflow/types/custom_role_audit_log_item.py new file mode 100644 index 0000000..79938a2 --- /dev/null +++ b/src/webflow/types/custom_role_audit_log_item.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .custom_role import CustomRole +from .custom_role_audit_log_item_event_sub_type import CustomRoleAuditLogItemEventSubType + + +class CustomRoleAuditLogItem(UniversalBaseModel): + event_sub_type: typing_extensions.Annotated[ + typing.Optional[CustomRoleAuditLogItemEventSubType], + FieldMetadata(alias="eventSubType"), + pydantic.Field(alias="eventSubType"), + ] = None + payload: typing.Optional[CustomRole] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/custom_role_audit_log_item_event_sub_type.py b/src/webflow/types/custom_role_audit_log_item_event_sub_type.py new file mode 100644 index 0000000..38d177b --- /dev/null +++ b/src/webflow/types/custom_role_audit_log_item_event_sub_type.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +CustomRoleAuditLogItemEventSubType = typing.Union[ + typing.Literal["role_created", "role_updated", "role_deleted"], typing.Any +] diff --git a/src/webflow/types/dom.py b/src/webflow/types/dom.py index ce15a6a..fe23cac 100644 --- a/src/webflow/types/dom.py +++ b/src/webflow/types/dom.py @@ -1,13 +1,14 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions +import datetime as dt import typing -from ..core.serialization import FieldMetadata + import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata from .node import Node from .pagination import Pagination -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class Dom(UniversalBaseModel): @@ -15,15 +16,24 @@ class Dom(UniversalBaseModel): The DOM (Document Object Model) schema represents the content structure of a web page or component. It captures various content nodes along with their associated attributes. Each node has a unique identifier and can be of different types like text, image or component-instance. The schema also provides pagination details for scenarios where the content nodes are too many to be fetched in a single request. """ - page_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="pageId")] = pydantic.Field( - default=None - ) - """ - Page ID - """ - + page_id: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="pageId"), pydantic.Field(alias="pageId", description="Page ID") + ] = None + branch_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="branchId"), + pydantic.Field( + alias="branchId", + description="The unique identifier of a [specific page branch.](https://help.webflow.com/hc/en-us/articles/33961355506195-Page-branching)", + ), + ] = None nodes: typing.Optional[typing.List[Node]] = None pagination: typing.Optional[Pagination] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="The date the page dom was most recently updated"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/domain.py b/src/webflow/types/domain.py index e678d1d..b82a1fd 100644 --- a/src/webflow/types/domain.py +++ b/src/webflow/types/domain.py @@ -1,12 +1,12 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import pydantic +import datetime as dt import typing + +import pydantic import typing_extensions -import datetime as dt +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class Domain(UniversalBaseModel): @@ -20,12 +20,11 @@ class Domain(UniversalBaseModel): The registered Domain name """ - last_published: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastPublished")] = ( - pydantic.Field(default=None) - ) - """ - The date the custom domain was last published to - """ + last_published: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="lastPublished"), + pydantic.Field(alias="lastPublished", description="The date the custom domain was last published to"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/domains.py b/src/webflow/types/domains.py index c34d85b..959efa0 100644 --- a/src/webflow/types/domains.py +++ b/src/webflow/types/domains.py @@ -1,17 +1,19 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions import typing -from .domain import Domain -from ..core.serialization import FieldMetadata -from ..core.pydantic_utilities import IS_PYDANTIC_V2 + import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .domain import Domain class Domains(UniversalBaseModel): custom_domains: typing_extensions.Annotated[ - typing.Optional[typing.List[Domain]], FieldMetadata(alias="customDomains") + typing.Optional[typing.List[Domain]], + FieldMetadata(alias="customDomains"), + pydantic.Field(alias="customDomains"), ] = None if IS_PYDANTIC_V2: diff --git a/src/webflow/types/duplicate_user_email.py b/src/webflow/types/duplicate_user_email.py deleted file mode 100644 index 4a44039..0000000 --- a/src/webflow/types/duplicate_user_email.py +++ /dev/null @@ -1,5 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -DuplicateUserEmail = typing.Optional[typing.Any] diff --git a/src/webflow/types/ecommerce_settings.py b/src/webflow/types/ecommerce_settings.py index d719e64..b3dd070 100644 --- a/src/webflow/types/ecommerce_settings.py +++ b/src/webflow/types/ecommerce_settings.py @@ -1,12 +1,12 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions +import datetime as dt import typing -from ..core.serialization import FieldMetadata + import pydantic -import datetime as dt -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata class EcommerceSettings(UniversalBaseModel): @@ -14,26 +14,21 @@ class EcommerceSettings(UniversalBaseModel): Ecommerce settings for a Webflow Site """ - site_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="siteId")] = pydantic.Field( - default=None - ) - """ - The identifier of the Site - """ - - created_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdOn")] = ( - pydantic.Field(default=None) - ) - """ - Date that the Site was created on - """ - - default_currency: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="defaultCurrency")] = ( - pydantic.Field(default=None) - ) - """ - The three-letter ISO currency code for the Site - """ + site_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="siteId"), + pydantic.Field(alias="siteId", description="The identifier of the Site"), + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="Date that the Site was created on"), + ] = None + default_currency: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="defaultCurrency"), + pydantic.Field(alias="defaultCurrency", description="The three-letter ISO currency code for the Site"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/error.py b/src/webflow/types/error.py index 0fef21c..1b069e3 100644 --- a/src/webflow/types/error.py +++ b/src/webflow/types/error.py @@ -1,12 +1,12 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing -from .error_code import ErrorCode + import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from .error_code import ErrorCode class Error(UniversalBaseModel): @@ -20,14 +20,12 @@ class Error(UniversalBaseModel): Error message """ - external_reference: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="externalReference")] = ( - pydantic.Field(default=None) - ) - """ - Link to more information - """ - - details: typing.Optional[typing.List[typing.Optional[typing.Any]]] = pydantic.Field(default=None) + external_reference: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="externalReference"), + pydantic.Field(alias="externalReference", description="Link to more information"), + ] = None + details: typing.Optional[typing.List[typing.Any]] = pydantic.Field(default=None) """ Array of errors """ diff --git a/src/webflow/types/field.py b/src/webflow/types/field.py index 40233a9..7eb4b77 100644 --- a/src/webflow/types/field.py +++ b/src/webflow/types/field.py @@ -1,12 +1,13 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel +import typing + import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -import typing from .field_type import FieldType -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from .field_validations import FieldValidations class Field(UniversalBaseModel): @@ -19,18 +20,16 @@ class Field(UniversalBaseModel): Unique identifier for a Field """ - is_required: typing_extensions.Annotated[bool, FieldMetadata(alias="isRequired")] = pydantic.Field() - """ - define whether a field is required in a collection - """ - - is_editable: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="isEditable")] = pydantic.Field( - default=None - ) - """ - Define whether the field is editable - """ - + is_required: typing_extensions.Annotated[ + bool, + FieldMetadata(alias="isRequired"), + pydantic.Field(alias="isRequired", description="define whether a field is required in a collection"), + ] + is_editable: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="isEditable"), + pydantic.Field(alias="isEditable", description="Define whether the field is editable"), + ] = None type: FieldType = pydantic.Field() """ Choose these appropriate field type for your collection data @@ -41,16 +40,17 @@ class Field(UniversalBaseModel): Slug of Field in Site URL structure. Slugs should be all lowercase with no spaces. Any spaces will be converted to "-." """ - display_name: typing_extensions.Annotated[str, FieldMetadata(alias="displayName")] = pydantic.Field() - """ - The name of a field - """ - - help_text: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="helpText")] = pydantic.Field( - default=None - ) + display_name: typing_extensions.Annotated[ + str, FieldMetadata(alias="displayName"), pydantic.Field(alias="displayName", description="The name of a field") + ] + help_text: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="helpText"), + pydantic.Field(alias="helpText", description="Additional text to help anyone filling out this field"), + ] = None + validations: typing.Optional[FieldValidations] = pydantic.Field(default=None) """ - Additional text to help anyone filling out this field + The validations for the field """ if IS_PYDANTIC_V2: diff --git a/src/webflow/types/field_create.py b/src/webflow/types/field_create.py new file mode 100644 index 0000000..0d312e5 --- /dev/null +++ b/src/webflow/types/field_create.py @@ -0,0 +1,9 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .option_field import OptionField +from .reference_field import ReferenceField +from .static_field import StaticField + +FieldCreate = typing.Union[StaticField, OptionField, ReferenceField] diff --git a/src/webflow/types/field_type.py b/src/webflow/types/field_type.py index 6318a3d..e3495ce 100644 --- a/src/webflow/types/field_type.py +++ b/src/webflow/types/field_type.py @@ -8,15 +8,19 @@ "DateTime", "Email", "ExtFileRef", + "File", "Image", "Link", "MultiImage", + "MultiReference", "Number", + "Option", "Phone", "PlainText", + "Reference", "RichText", "Switch", - "Video", + "VideoLink", ], typing.Any, ] diff --git a/src/webflow/types/field_validations.py b/src/webflow/types/field_validations.py new file mode 100644 index 0000000..40f076b --- /dev/null +++ b/src/webflow/types/field_validations.py @@ -0,0 +1,30 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .field_validations_additional_properties import FieldValidationsAdditionalProperties + + +class FieldValidations(UniversalBaseModel): + """ + The validations for the field + """ + + additional_properties: typing_extensions.Annotated[ + typing.Optional[FieldValidationsAdditionalProperties], + FieldMetadata(alias="additionalProperties"), + pydantic.Field(alias="additionalProperties"), + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/field_validations_additional_properties.py b/src/webflow/types/field_validations_additional_properties.py new file mode 100644 index 0000000..845d42f --- /dev/null +++ b/src/webflow/types/field_validations_additional_properties.py @@ -0,0 +1,11 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +from .field_validations_additional_properties_additional_properties import ( + FieldValidationsAdditionalPropertiesAdditionalProperties, +) + +FieldValidationsAdditionalProperties = typing.Union[ + str, float, bool, int, FieldValidationsAdditionalPropertiesAdditionalProperties +] diff --git a/src/webflow/types/field_validations_additional_properties_additional_properties.py b/src/webflow/types/field_validations_additional_properties_additional_properties.py new file mode 100644 index 0000000..0c676dd --- /dev/null +++ b/src/webflow/types/field_validations_additional_properties_additional_properties.py @@ -0,0 +1,23 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata + + +class FieldValidationsAdditionalPropertiesAdditionalProperties(UniversalBaseModel): + additional_properties: typing_extensions.Annotated[ + typing.Any, FieldMetadata(alias="additionalProperties"), pydantic.Field(alias="additionalProperties") + ] + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/forbidden_error_body.py b/src/webflow/types/forbidden_error_body.py index f580ad2..24bdcf5 100644 --- a/src/webflow/types/forbidden_error_body.py +++ b/src/webflow/types/forbidden_error_body.py @@ -1,7 +1,8 @@ # This file was auto-generated by Fern from our API Definition. import typing + from .invalid_scopes import InvalidScopes -from .users_not_enabled import UsersNotEnabled +from .not_enterprise_plan_site import NotEnterprisePlanSite -ForbiddenErrorBody = typing.Union[InvalidScopes, UsersNotEnabled] +ForbiddenErrorBody = typing.Union[InvalidScopes, NotEnterprisePlanSite] diff --git a/src/webflow/types/form.py b/src/webflow/types/form.py index 0cfef8b..14c7fd9 100644 --- a/src/webflow/types/form.py +++ b/src/webflow/types/form.py @@ -1,14 +1,14 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions +import datetime as dt import typing -from ..core.serialization import FieldMetadata + import pydantic -import datetime as dt +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata from .form_field import FormField from .form_response_settings import FormResponseSettings -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class Form(UniversalBaseModel): @@ -16,85 +16,66 @@ class Form(UniversalBaseModel): A Webflow form """ - display_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="displayName")] = ( - pydantic.Field(default=None) - ) - """ - The Form name displayed on the site - """ - - created_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdOn")] = ( - pydantic.Field(default=None) - ) - """ - Date that the Form was created on - """ - - last_updated: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastUpdated")] = ( - pydantic.Field(default=None) - ) - """ - Date that the Form was last updated on - """ - + display_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="displayName"), + pydantic.Field(alias="displayName", description="The Form name displayed on the site"), + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="Date that the Form was created on"), + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="Date that the Form was last updated on"), + ] = None fields: typing.Optional[FormField] = pydantic.Field(default=None) """ A collection of form field objects """ response_settings: typing_extensions.Annotated[ - typing.Optional[FormResponseSettings], FieldMetadata(alias="responseSettings") - ] = pydantic.Field(default=None) - """ - Settings for form responses - """ - + typing.Optional[FormResponseSettings], + FieldMetadata(alias="responseSettings"), + pydantic.Field(alias="responseSettings", description="Settings for form responses"), + ] = None id: typing.Optional[str] = pydantic.Field(default=None) """ The unique ID for the Form """ - site_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="siteId")] = pydantic.Field( - default=None - ) - """ - The unique ID of the Site the Form belongs to - """ - - site_domain_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="siteDomainId")] = ( - pydantic.Field(default=None) - ) - """ - The unique ID corresponding to the site's Domain name - """ - - page_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="pageId")] = pydantic.Field( - default=None - ) - """ - The unique ID for the Page on which the Form is placed - """ - - page_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="pageName")] = pydantic.Field( - default=None - ) - """ - The user-visible name of the Page where the Form is placed - """ - - form_element_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="formElementId")] = ( - pydantic.Field(default=None) - ) - """ - The unique ID of the Form element - """ - - workspace_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="workspaceId")] = ( - pydantic.Field(default=None) - ) - """ - The unique ID of the Workspace the Site belongs to - """ + site_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="siteId"), + pydantic.Field(alias="siteId", description="The unique ID of the Site the Form belongs to"), + ] = None + site_domain_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="siteDomainId"), + pydantic.Field(alias="siteDomainId", description="The unique ID corresponding to the site's Domain name"), + ] = None + page_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="pageId"), + pydantic.Field(alias="pageId", description="The unique ID for the Page on which the Form is placed"), + ] = None + page_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="pageName"), + pydantic.Field(alias="pageName", description="The user-visible name of the Page where the Form is placed"), + ] = None + form_element_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="formElementId"), + pydantic.Field(alias="formElementId", description="The unique ID of the Form element"), + ] = None + workspace_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="workspaceId"), + pydantic.Field(alias="workspaceId", description="The unique ID of the Workspace the Site belongs to"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/form_field.py b/src/webflow/types/form_field.py index d62b01e..f76bdcb 100644 --- a/src/webflow/types/form_field.py +++ b/src/webflow/types/form_field.py @@ -1,6 +1,7 @@ # This file was auto-generated by Fern from our API Definition. import typing + from .form_field_value import FormFieldValue FormField = typing.Dict[str, FormFieldValue] diff --git a/src/webflow/types/form_field_value.py b/src/webflow/types/form_field_value.py index 957624d..51e8102 100644 --- a/src/webflow/types/form_field_value.py +++ b/src/webflow/types/form_field_value.py @@ -1,12 +1,12 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions import typing -from ..core.serialization import FieldMetadata + import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata from .form_field_value_type import FormFieldValueType -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class FormFieldValue(UniversalBaseModel): @@ -14,13 +14,11 @@ class FormFieldValue(UniversalBaseModel): An object containing field info for a specific fieldID. """ - display_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="displayName")] = ( - pydantic.Field(default=None) - ) - """ - The field name displayed on the site - """ - + display_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="displayName"), + pydantic.Field(alias="displayName", description="The field name displayed on the site"), + ] = None type: typing.Optional[FormFieldValueType] = pydantic.Field(default=None) """ The field type @@ -31,12 +29,11 @@ class FormFieldValue(UniversalBaseModel): The placeholder text for the field """ - user_visible: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="userVisible")] = ( - pydantic.Field(default=None) - ) - """ - Whether the field is visible to the user - """ + user_visible: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="userVisible"), + pydantic.Field(alias="userVisible", description="Whether the field is visible to the user"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/form_list.py b/src/webflow/types/form_list.py index 17590c6..c8fe917 100644 --- a/src/webflow/types/form_list.py +++ b/src/webflow/types/form_list.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from .form import Form from .pagination import Pagination -from ..core.pydantic_utilities import IS_PYDANTIC_V2 -import pydantic class FormList(UniversalBaseModel): diff --git a/src/webflow/types/form_response_settings.py b/src/webflow/types/form_response_settings.py index c51d6b6..0acae41 100644 --- a/src/webflow/types/form_response_settings.py +++ b/src/webflow/types/form_response_settings.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions import typing -from ..core.serialization import FieldMetadata + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata class FormResponseSettings(UniversalBaseModel): @@ -13,33 +13,30 @@ class FormResponseSettings(UniversalBaseModel): Settings for form responses """ - redirect_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="redirectUrl")] = ( - pydantic.Field(default=None) - ) - """ - The url or path to redirect the user to after form submission - """ - - redirect_method: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="redirectMethod")] = ( - pydantic.Field(default=None) - ) - """ - The HTTP request method to use for the redirectUrl (eg. POST or GET) - """ - - redirect_action: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="redirectAction")] = ( - pydantic.Field(default=None) - ) - """ - The action to take after form submission - """ - + redirect_url: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="redirectUrl"), + pydantic.Field( + alias="redirectUrl", description="The url or path to redirect the user to after form submission" + ), + ] = None + redirect_method: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="redirectMethod"), + pydantic.Field( + alias="redirectMethod", description="The HTTP request method to use for the redirectUrl (eg. POST or GET)" + ), + ] = None + redirect_action: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="redirectAction"), + pydantic.Field(alias="redirectAction", description="The action to take after form submission"), + ] = None send_email_confirmation: typing_extensions.Annotated[ - typing.Optional[bool], FieldMetadata(alias="sendEmailConfirmation") - ] = pydantic.Field(default=None) - """ - Whether to send an email confirmation to the user - """ + typing.Optional[bool], + FieldMetadata(alias="sendEmailConfirmation"), + pydantic.Field(alias="sendEmailConfirmation", description="Whether to send an email confirmation to the user"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/form_submission.py b/src/webflow/types/form_submission.py index cd18202..adf12b7 100644 --- a/src/webflow/types/form_submission.py +++ b/src/webflow/types/form_submission.py @@ -1,12 +1,12 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel +import datetime as dt import typing + import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -import datetime as dt -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class FormSubmission(UniversalBaseModel): @@ -15,40 +15,31 @@ class FormSubmission(UniversalBaseModel): The unique ID of the Form submission """ - display_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="displayName")] = ( - pydantic.Field(default=None) - ) - """ - The Form name displayed on the site - """ - - site_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="siteId")] = pydantic.Field( - default=None - ) - """ - The unique ID of the Site the Form belongs to - """ - - workspace_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="workspaceId")] = ( - pydantic.Field(default=None) - ) - """ - The unique ID of the Workspace the Site belongs to - """ - - date_submitted: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="dateSubmitted")] = ( - pydantic.Field(default=None) - ) - """ - Date that the Form was submitted on - """ - + display_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="displayName"), + pydantic.Field(alias="displayName", description="The Form name displayed on the site"), + ] = None + site_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="siteId"), + pydantic.Field(alias="siteId", description="The unique ID of the Site the Form belongs to"), + ] = None + workspace_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="workspaceId"), + pydantic.Field(alias="workspaceId", description="The unique ID of the Workspace the Site belongs to"), + ] = None + date_submitted: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="dateSubmitted"), + pydantic.Field(alias="dateSubmitted", description="Date that the Form was submitted on"), + ] = None form_response: typing_extensions.Annotated[ - typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]], FieldMetadata(alias="formResponse") - ] = pydantic.Field(default=None) - """ - The data submitted in the Form - """ + typing.Optional[typing.Dict[str, typing.Any]], + FieldMetadata(alias="formResponse"), + pydantic.Field(alias="formResponse", description="The data submitted in the Form"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/form_submission_list.py b/src/webflow/types/form_submission_list.py index c9099a1..356c370 100644 --- a/src/webflow/types/form_submission_list.py +++ b/src/webflow/types/form_submission_list.py @@ -1,18 +1,20 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions import typing -from .form_submission import FormSubmission + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata +from .form_submission import FormSubmission from .pagination import Pagination -from ..core.pydantic_utilities import IS_PYDANTIC_V2 -import pydantic class FormSubmissionList(UniversalBaseModel): form_submissions: typing_extensions.Annotated[ - typing.Optional[typing.List[FormSubmission]], FieldMetadata(alias="formSubmissions") + typing.Optional[typing.List[FormSubmission]], + FieldMetadata(alias="formSubmissions"), + pydantic.Field(alias="formSubmissions"), ] = None pagination: typing.Optional[Pagination] = None diff --git a/src/webflow/types/form_submission_trigger.py b/src/webflow/types/form_submission_trigger.py new file mode 100644 index 0000000..f7c31f7 --- /dev/null +++ b/src/webflow/types/form_submission_trigger.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .form_submission_trigger_payload import FormSubmissionTriggerPayload + + +class FormSubmissionTrigger(UniversalBaseModel): + """ + The Webhook payload for when a form is submitted + """ + + trigger_type: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="triggerType"), + pydantic.Field(alias="triggerType", description="The type of event that triggered the request"), + ] = None + payload: typing.Optional[FormSubmissionTriggerPayload] = pydantic.Field(default=None) + """ + The payload of data sent from Webflow + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/form_submission_trigger_payload.py b/src/webflow/types/form_submission_trigger_payload.py new file mode 100644 index 0000000..d715049 --- /dev/null +++ b/src/webflow/types/form_submission_trigger_payload.py @@ -0,0 +1,65 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .form_submission_trigger_payload_schema_item import FormSubmissionTriggerPayloadSchemaItem + + +class FormSubmissionTriggerPayload(UniversalBaseModel): + """ + The payload of data sent from Webflow + """ + + name: typing.Optional[str] = pydantic.Field(default=None) + """ + The name of the form + """ + + site_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="siteId"), + pydantic.Field(alias="siteId", description="The ID of the site that the form was submitted from"), + ] = None + data: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None) + """ + The data submitted in the form + """ + + schema_: typing_extensions.Annotated[ + typing.Optional[typing.List[FormSubmissionTriggerPayloadSchemaItem]], + FieldMetadata(alias="schema"), + pydantic.Field(alias="schema", description="A list of fields from the submitted form"), + ] = None + submitted_at: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="submittedAt"), + pydantic.Field(alias="submittedAt", description="The timestamp the form was submitted"), + ] = None + id: typing.Optional[str] = pydantic.Field(default=None) + """ + the ID of the event + """ + + form_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="formId"), + pydantic.Field(alias="formId", description="The ID of the form submission"), + ] = None + form_element_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="formElementId"), + pydantic.Field(alias="formElementId", description="The uniqueID of the Form element"), + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/form_submission_trigger_payload_schema_item.py b/src/webflow/types/form_submission_trigger_payload_schema_item.py new file mode 100644 index 0000000..7550cfc --- /dev/null +++ b/src/webflow/types/form_submission_trigger_payload_schema_item.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .form_submission_trigger_payload_schema_item_field_type import FormSubmissionTriggerPayloadSchemaItemFieldType + + +class FormSubmissionTriggerPayloadSchemaItem(UniversalBaseModel): + field_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="fieldName"), + pydantic.Field(alias="fieldName", description="Form field name"), + ] = None + field_type: typing_extensions.Annotated[ + typing.Optional[FormSubmissionTriggerPayloadSchemaItemFieldType], + FieldMetadata(alias="fieldType"), + pydantic.Field(alias="fieldType", description="Form field type"), + ] = None + field_element_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="fieldElementId"), + pydantic.Field(alias="fieldElementId", description="Element ID of the Form Field"), + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/form_submission_trigger_payload_schema_item_field_type.py b/src/webflow/types/form_submission_trigger_payload_schema_item_field_type.py new file mode 100644 index 0000000..0ab97d1 --- /dev/null +++ b/src/webflow/types/form_submission_trigger_payload_schema_item_field_type.py @@ -0,0 +1,8 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +FormSubmissionTriggerPayloadSchemaItemFieldType = typing.Union[ + typing.Literal["FormTextInput", "FormTextarea", "FormCheckboxInput", "FormRadioInput", "FormFileUploadInput"], + typing.Any, +] diff --git a/src/webflow/types/image_node.py b/src/webflow/types/image_node.py index 2351cea..56cf7cc 100644 --- a/src/webflow/types/image_node.py +++ b/src/webflow/types/image_node.py @@ -1,10 +1,10 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from .image_node_image import ImageNodeImage -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class ImageNode(UniversalBaseModel): @@ -12,12 +12,16 @@ class ImageNode(UniversalBaseModel): Represents an image within the DOM. It contains details about the image, such as its alternative text (alt) for accessibility and an asset identifier for fetching the actual image resource. Additional attributes can be associated with the image for styling or other purposes. """ - id: typing.Optional[str] = pydantic.Field(default=None) + id: str = pydantic.Field() """ Node UUID """ - image: typing.Optional[ImageNodeImage] = None + image: ImageNodeImage = pydantic.Field() + """ + The image details of the node + """ + attributes: typing.Optional[typing.Dict[str, str]] = pydantic.Field(default=None) """ The custom attributes of the node diff --git a/src/webflow/types/image_node_image.py b/src/webflow/types/image_node_image.py index 2ef819f..1415afb 100644 --- a/src/webflow/types/image_node_image.py +++ b/src/webflow/types/image_node_image.py @@ -1,16 +1,22 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + +import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -from ..core.pydantic_utilities import IS_PYDANTIC_V2 -import pydantic class ImageNodeImage(UniversalBaseModel): + """ + The image details of the node + """ + alt: typing.Optional[str] = None - asset_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="assetId")] = None + asset_id: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="assetId"), pydantic.Field(alias="assetId") + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/invalid_domain.py b/src/webflow/types/invalid_domain.py index 60e64b7..304487f 100644 --- a/src/webflow/types/invalid_domain.py +++ b/src/webflow/types/invalid_domain.py @@ -2,4 +2,4 @@ import typing -InvalidDomain = typing.Optional[typing.Any] +InvalidDomain = typing.Any diff --git a/src/webflow/types/invalid_scopes.py b/src/webflow/types/invalid_scopes.py index 90edaa0..babfdd3 100644 --- a/src/webflow/types/invalid_scopes.py +++ b/src/webflow/types/invalid_scopes.py @@ -2,4 +2,4 @@ import typing -InvalidScopes = typing.Optional[typing.Any] +InvalidScopes = typing.Any diff --git a/src/webflow/types/inventory_item.py b/src/webflow/types/inventory_item.py index 3eda2d3..5db3ff3 100644 --- a/src/webflow/types/inventory_item.py +++ b/src/webflow/types/inventory_item.py @@ -1,12 +1,12 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic import typing_extensions -from .inventory_item_inventory_type import InventoryItemInventoryType +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from .inventory_item_inventory_type import InventoryItemInventoryType class InventoryItem(UniversalBaseModel): @@ -25,11 +25,10 @@ class InventoryItem(UniversalBaseModel): """ inventory_type: typing_extensions.Annotated[ - typing.Optional[InventoryItemInventoryType], FieldMetadata(alias="inventoryType") - ] = pydantic.Field(default=None) - """ - infinite or finite - """ + typing.Optional[InventoryItemInventoryType], + FieldMetadata(alias="inventoryType"), + pydantic.Field(alias="inventoryType", description="infinite or finite"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/items_list_items_live_request_last_published.py b/src/webflow/types/items_list_items_live_request_last_published.py new file mode 100644 index 0000000..ec7c86a --- /dev/null +++ b/src/webflow/types/items_list_items_live_request_last_published.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import datetime as dt +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class ItemsListItemsLiveRequestLastPublished(UniversalBaseModel): + lte: typing.Optional[dt.datetime] = pydantic.Field(default=None) + """ + Filter items last published before this date + """ + + gte: typing.Optional[dt.datetime] = pydantic.Field(default=None) + """ + Filter items last published after this date + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/items_list_items_request_last_published.py b/src/webflow/types/items_list_items_request_last_published.py new file mode 100644 index 0000000..05dc5c2 --- /dev/null +++ b/src/webflow/types/items_list_items_request_last_published.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import datetime as dt +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class ItemsListItemsRequestLastPublished(UniversalBaseModel): + lte: typing.Optional[dt.datetime] = pydantic.Field(default=None) + """ + Filter items last published before this date + """ + + gte: typing.Optional[dt.datetime] = pydantic.Field(default=None) + """ + Filter items last published after this date + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/list_custom_code_blocks.py b/src/webflow/types/list_custom_code_blocks.py index 417c456..9f5d58e 100644 --- a/src/webflow/types/list_custom_code_blocks.py +++ b/src/webflow/types/list_custom_code_blocks.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from .custom_code_block import CustomCodeBlock from .pagination import Pagination -from ..core.pydantic_utilities import IS_PYDANTIC_V2 -import pydantic class ListCustomCodeBlocks(UniversalBaseModel): diff --git a/src/webflow/types/locale.py b/src/webflow/types/locale.py index ba88d45..19df91b 100644 --- a/src/webflow/types/locale.py +++ b/src/webflow/types/locale.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class Locale(UniversalBaseModel): @@ -14,32 +14,28 @@ class Locale(UniversalBaseModel): The unique identifier for the locale. """ - cms_locale_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="cmsLocaleId")] = ( - pydantic.Field(default=None) - ) - """ - A CMS-specific identifier for the locale. - """ - + cms_locale_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="cmsLocaleId"), + pydantic.Field(alias="cmsLocaleId", description="A CMS-specific identifier for the locale."), + ] = None enabled: typing.Optional[bool] = pydantic.Field(default=None) """ Indicates if the locale is enabled. """ - display_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="displayName")] = ( - pydantic.Field(default=None) - ) - """ - The display name of the locale, typically in English. - """ - - display_image_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="displayImageId")] = ( - pydantic.Field(default=None) - ) - """ - An optional ID for an image associated with the locale, nullable. - """ - + display_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="displayName"), + pydantic.Field(alias="displayName", description="The display name of the locale, typically in English."), + ] = None + display_image_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="displayImageId"), + pydantic.Field( + alias="displayImageId", description="An optional ID for an image associated with the locale, nullable." + ), + ] = None redirect: typing.Optional[bool] = pydantic.Field(default=None) """ Determines if requests should redirect to the locale's subdirectory. diff --git a/src/webflow/types/locales.py b/src/webflow/types/locales.py index 7dad886..3d253a1 100644 --- a/src/webflow/types/locales.py +++ b/src/webflow/types/locales.py @@ -1,10 +1,10 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing -from .locale import Locale + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .locale import Locale class Locales(UniversalBaseModel): diff --git a/src/webflow/types/metadata.py b/src/webflow/types/metadata.py new file mode 100644 index 0000000..576efc7 --- /dev/null +++ b/src/webflow/types/metadata.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .metadata_options_item import MetadataOptionsItem + + +class Metadata(UniversalBaseModel): + """ + The metadata for the Option field. + """ + + options: typing.List[MetadataOptionsItem] = pydantic.Field() + """ + The option values for the Option field. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/metadata_options_item.py b/src/webflow/types/metadata_options_item.py new file mode 100644 index 0000000..5618523 --- /dev/null +++ b/src/webflow/types/metadata_options_item.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class MetadataOptionsItem(UniversalBaseModel): + """ + A single option value for the Option field. + """ + + name: str = pydantic.Field() + """ + The name of the option + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The unique identifier of the option + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/new_order.py b/src/webflow/types/new_order.py new file mode 100644 index 0000000..89296a7 --- /dev/null +++ b/src/webflow/types/new_order.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .order import Order + + +class NewOrder(UniversalBaseModel): + """ + The Webhook payload for when a new order is created + """ + + trigger_type: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="triggerType"), + pydantic.Field(alias="triggerType", description="The type of event that triggered the request"), + ] = None + payload: typing.Optional[Order] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/no_domains.py b/src/webflow/types/no_domains.py index 714031f..c9162ec 100644 --- a/src/webflow/types/no_domains.py +++ b/src/webflow/types/no_domains.py @@ -2,4 +2,4 @@ import typing -NoDomains = typing.Optional[typing.Any] +NoDomains = typing.Any diff --git a/src/webflow/types/node.py b/src/webflow/types/node.py index cd0942f..f413d08 100644 --- a/src/webflow/types/node.py +++ b/src/webflow/types/node.py @@ -1,15 +1,17 @@ # This file was auto-generated by Fern from our API Definition. from __future__ import annotations -from ..core.pydantic_utilities import UniversalBaseModel + import typing -from .text_node_text import TextNodeText -from ..core.pydantic_utilities import IS_PYDANTIC_V2 + import pydantic -from .image_node_image import ImageNodeImage import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata from .component_property import ComponentProperty +from .image_node_image import ImageNodeImage +from .select_node_choices_item import SelectNodeChoicesItem +from .text_node_text import TextNodeText class Node_Text(UniversalBaseModel): @@ -18,8 +20,8 @@ class Node_Text(UniversalBaseModel): """ type: typing.Literal["text"] = "text" - id: typing.Optional[str] = None - text: typing.Optional[TextNodeText] = None + id: str + text: TextNodeText attributes: typing.Optional[typing.Dict[str, str]] = None if IS_PYDANTIC_V2: @@ -38,8 +40,8 @@ class Node_Image(UniversalBaseModel): """ type: typing.Literal["image"] = "image" - id: typing.Optional[str] = None - image: typing.Optional[ImageNodeImage] = None + id: str + image: ImageNodeImage attributes: typing.Optional[typing.Dict[str, str]] = None if IS_PYDANTIC_V2: @@ -58,11 +60,98 @@ class Node_ComponentInstance(UniversalBaseModel): """ type: typing.Literal["component-instance"] = "component-instance" - id: typing.Optional[str] = None - component_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="componentId")] = None + id: str + component_id: typing_extensions.Annotated[ + str, FieldMetadata(alias="componentId"), pydantic.Field(alias="componentId") + ] property_overrides: typing_extensions.Annotated[ - typing.Optional[typing.List[ComponentProperty]], FieldMetadata(alias="propertyOverrides") - ] = None + typing.List[ComponentProperty], + FieldMetadata(alias="propertyOverrides"), + pydantic.Field(alias="propertyOverrides"), + ] + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +class Node_TextInput(UniversalBaseModel): + """ + A generic representation of a content element within the Document Object Model (DOM). Each node has a unique identifier and a specific type that determines its content structure and attributes. + """ + + type: typing.Literal["text-input"] = "text-input" + id: str + placeholder: str + attributes: typing.Optional[typing.Dict[str, str]] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +class Node_Select(UniversalBaseModel): + """ + A generic representation of a content element within the Document Object Model (DOM). Each node has a unique identifier and a specific type that determines its content structure and attributes. + """ + + type: typing.Literal["select"] = "select" + id: str + choices: typing.List[SelectNodeChoicesItem] + attributes: typing.Optional[typing.Dict[str, str]] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +class Node_SubmitButton(UniversalBaseModel): + """ + A generic representation of a content element within the Document Object Model (DOM). Each node has a unique identifier and a specific type that determines its content structure and attributes. + """ + + type: typing.Literal["submit-button"] = "submit-button" + id: str + value: str + waiting_text: typing_extensions.Annotated[ + str, FieldMetadata(alias="waitingText"), pydantic.Field(alias="waitingText") + ] + attributes: typing.Optional[typing.Dict[str, str]] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +class Node_SearchButton(UniversalBaseModel): + """ + A generic representation of a content element within the Document Object Model (DOM). Each node has a unique identifier and a specific type that determines its content structure and attributes. + """ + + type: typing.Literal["search-button"] = "search-button" + id: str + value: str + attributes: typing.Optional[typing.Dict[str, str]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 @@ -74,4 +163,9 @@ class Config: extra = pydantic.Extra.allow -Node = typing.Union[Node_Text, Node_Image, Node_ComponentInstance] +Node = typing_extensions.Annotated[ + typing.Union[ + Node_Text, Node_Image, Node_ComponentInstance, Node_TextInput, Node_Select, Node_SubmitButton, Node_SearchButton + ], + pydantic.Field(discriminator="type"), +] diff --git a/src/webflow/types/not_enterprise_plan_site.py b/src/webflow/types/not_enterprise_plan_site.py index 87003ce..1001cf8 100644 --- a/src/webflow/types/not_enterprise_plan_site.py +++ b/src/webflow/types/not_enterprise_plan_site.py @@ -2,4 +2,4 @@ import typing -NotEnterprisePlanSite = typing.Optional[typing.Any] +NotEnterprisePlanSite = typing.Any diff --git a/src/webflow/types/not_enterprise_plan_workspace.py b/src/webflow/types/not_enterprise_plan_workspace.py index e093b54..c945214 100644 --- a/src/webflow/types/not_enterprise_plan_workspace.py +++ b/src/webflow/types/not_enterprise_plan_workspace.py @@ -2,4 +2,4 @@ import typing -NotEnterprisePlanWorkspace = typing.Optional[typing.Any] +NotEnterprisePlanWorkspace = typing.Any diff --git a/src/webflow/types/option_field.py b/src/webflow/types/option_field.py new file mode 100644 index 0000000..ea1a98a --- /dev/null +++ b/src/webflow/types/option_field.py @@ -0,0 +1,50 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .metadata import Metadata + + +class OptionField(UniversalBaseModel): + id: typing.Optional[str] = pydantic.Field(default=None) + """ + Unique identifier for a Field + """ + + is_editable: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="isEditable"), + pydantic.Field(alias="isEditable", description="Define whether the field is editable"), + ] = None + is_required: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="isRequired"), + pydantic.Field(alias="isRequired", description="define whether a field is required in a collection"), + ] = None + type: typing.Literal["Option"] = pydantic.Field(default="Option") + """ + The [Option field type](/data/reference/field-types-item-values#option) + """ + + display_name: typing_extensions.Annotated[ + str, FieldMetadata(alias="displayName"), pydantic.Field(alias="displayName", description="The name of a field") + ] + help_text: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="helpText"), + pydantic.Field(alias="helpText", description="Additional text to help anyone filling out this field"), + ] = None + metadata: Metadata + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/order.py b/src/webflow/types/order.py index d45b1de..56f1196 100644 --- a/src/webflow/types/order.py +++ b/src/webflow/types/order.py @@ -1,36 +1,37 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions +import datetime as dt import typing -from ..core.serialization import FieldMetadata + import pydantic -from .order_status import OrderStatus -import datetime as dt -from .order_dispute_last_status import OrderDisputeLastStatus -from .order_price import OrderPrice +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata from .order_address import OrderAddress +from .order_billing_address import OrderBillingAddress from .order_customer_info import OrderCustomerInfo -from .order_purchased_item import OrderPurchasedItem -from .stripe_details import StripeDetails -from .stripe_card import StripeCard -from .paypal_details import PaypalDetails +from .order_dispute_last_status import OrderDisputeLastStatus +from .order_download_files_item import OrderDownloadFilesItem from .order_metadata import OrderMetadata +from .order_price import OrderPrice +from .order_purchased_item import OrderPurchasedItem +from .order_shipping_address import OrderShippingAddress +from .order_status import OrderStatus from .order_totals import OrderTotals -from .order_download_files_item import OrderDownloadFilesItem -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from .paypal_details import PaypalDetails +from .stripe_card import StripeCard +from .stripe_details import StripeDetails class Order(UniversalBaseModel): - order_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="orderId")] = pydantic.Field( - default=None - ) - """ - The order ID. Will usually be 6 hex characters, but can also be 9 - hex characters if the site has a very large number of Orders. - Randomly assigned. - """ - + order_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="orderId"), + pydantic.Field( + alias="orderId", + description="The order ID. Will usually be 6 hex characters, but can also be 9\nhex characters if the site has a very large number of Orders.\nRandomly assigned.", + ), + ] = None status: typing.Optional[OrderStatus] = pydantic.Field(default=None) """ The status of the Order @@ -41,189 +42,181 @@ class Order(UniversalBaseModel): A comment string for this Order, which is editable by API user (not used by Webflow). """ - order_comment: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="orderComment")] = ( - pydantic.Field(default=None) - ) - """ - A comment that the customer left when making their Order - """ - - accepted_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="acceptedOn")] = ( - pydantic.Field(default=None) - ) - """ - The ISO8601 timestamp that an Order was placed. - """ - - fulfilled_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="fulfilledOn")] = ( - pydantic.Field(default=None) - ) - """ - When an Order is marked as 'fulfilled', this field represents the timestamp of the fulfillment in ISO8601 format. Otherwise, it is null. - """ - - refunded_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="refundedOn")] = ( - pydantic.Field(default=None) - ) - """ - When an Order is marked as 'refunded', this field represents the timestamp of the fulfillment in ISO8601 format. Otherwise, it is null. - """ - - disputed_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="disputedOn")] = ( - pydantic.Field(default=None) - ) - """ - When an Order is marked as 'disputed', this field represents the timestamp of the fulfillment in ISO8601 format. Otherwise, it is null. - """ - + order_comment: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="orderComment"), + pydantic.Field(alias="orderComment", description="A comment that the customer left when making their Order"), + ] = None + accepted_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="acceptedOn"), + pydantic.Field(alias="acceptedOn", description="The ISO8601 timestamp that an Order was placed."), + ] = None + fulfilled_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="fulfilledOn"), + pydantic.Field( + alias="fulfilledOn", + description="When an Order is marked as 'fulfilled', this field represents the timestamp of the fulfillment in ISO8601 format. Otherwise, it is null.", + ), + ] = None + refunded_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="refundedOn"), + pydantic.Field( + alias="refundedOn", + description="When an Order is marked as 'refunded', this field represents the timestamp of the fulfillment in ISO8601 format. Otherwise, it is null.", + ), + ] = None + disputed_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="disputedOn"), + pydantic.Field( + alias="disputedOn", + description="When an Order is marked as 'disputed', this field represents the timestamp of the fulfillment in ISO8601 format. Otherwise, it is null.", + ), + ] = None dispute_updated_on: typing_extensions.Annotated[ - typing.Optional[dt.datetime], FieldMetadata(alias="disputeUpdatedOn") - ] = pydantic.Field(default=None) - """ - If an Order has been disputed by the customer, this key will be set to the ISO8601 timestamp of the last update received. If the Order is not disputed, the key will be null. - """ - + typing.Optional[dt.datetime], + FieldMetadata(alias="disputeUpdatedOn"), + pydantic.Field( + alias="disputeUpdatedOn", + description="If an Order has been disputed by the customer, this key will be set to the ISO8601 timestamp of the last update received. If the Order is not disputed, the key will be null.", + ), + ] = None dispute_last_status: typing_extensions.Annotated[ - typing.Optional[OrderDisputeLastStatus], FieldMetadata(alias="disputeLastStatus") - ] = pydantic.Field(default=None) - """ - If an order was disputed by the customer, then this key will be set with the [dispute's status](https://stripe.com/docs/api#dispute_object-status). - """ - - customer_paid: typing_extensions.Annotated[typing.Optional[OrderPrice], FieldMetadata(alias="customerPaid")] = ( - pydantic.Field(default=None) - ) - """ - The total paid by the customer - """ - - net_amount: typing_extensions.Annotated[typing.Optional[OrderPrice], FieldMetadata(alias="netAmount")] = ( - pydantic.Field(default=None) - ) - """ - The net amount after application fees - """ - - application_fee: typing_extensions.Annotated[typing.Optional[OrderPrice], FieldMetadata(alias="applicationFee")] = ( - pydantic.Field(default=None) - ) - """ - The application fee assessed by the platform - """ - + typing.Optional[OrderDisputeLastStatus], + FieldMetadata(alias="disputeLastStatus"), + pydantic.Field( + alias="disputeLastStatus", + description="If an order was disputed by the customer, then this key will be set with the [dispute's status](https://stripe.com/docs/api#dispute_object-status).", + ), + ] = None + customer_paid: typing_extensions.Annotated[ + typing.Optional[OrderPrice], + FieldMetadata(alias="customerPaid"), + pydantic.Field(alias="customerPaid", description="The total paid by the customer"), + ] = None + net_amount: typing_extensions.Annotated[ + typing.Optional[OrderPrice], + FieldMetadata(alias="netAmount"), + pydantic.Field(alias="netAmount", description="The net amount after application fees"), + ] = None + application_fee: typing_extensions.Annotated[ + typing.Optional[OrderPrice], + FieldMetadata(alias="applicationFee"), + pydantic.Field(alias="applicationFee", description="The application fee assessed by the platform"), + ] = None all_addresses: typing_extensions.Annotated[ - typing.Optional[typing.List[OrderAddress]], FieldMetadata(alias="allAddresses") - ] = pydantic.Field(default=None) - """ - All addresses provided by the customer during the ordering flow. - """ - + typing.Optional[typing.List[OrderAddress]], + FieldMetadata(alias="allAddresses"), + pydantic.Field( + alias="allAddresses", description="All addresses provided by the customer during the ordering flow." + ), + ] = None shipping_address: typing_extensions.Annotated[ - typing.Optional[OrderAddress], FieldMetadata(alias="shippingAddress") - ] = pydantic.Field(default=None) - """ - The shipping address - """ - + typing.Optional[OrderShippingAddress], + FieldMetadata(alias="shippingAddress"), + pydantic.Field(alias="shippingAddress", description="The shipping address"), + ] = None billing_address: typing_extensions.Annotated[ - typing.Optional[OrderAddress], FieldMetadata(alias="billingAddress") - ] = pydantic.Field(default=None) - """ - The billing address - """ - - shipping_provider: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="shippingProvider")] = ( - pydantic.Field(default=None) - ) - """ - A string editable by the API user to note the shipping provider used (not used by Webflow). - """ - - shipping_tracking: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="shippingTracking")] = ( - pydantic.Field(default=None) - ) - """ - A string editable by the API user to note the shipping tracking number for the order (not used by Webflow). - """ - + typing.Optional[OrderBillingAddress], + FieldMetadata(alias="billingAddress"), + pydantic.Field(alias="billingAddress", description="The billing address"), + ] = None + shipping_provider: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="shippingProvider"), + pydantic.Field( + alias="shippingProvider", + description="A string editable by the API user to note the shipping provider used (not used by Webflow).", + ), + ] = None + shipping_tracking: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="shippingTracking"), + pydantic.Field( + alias="shippingTracking", + description="A string editable by the API user to note the shipping tracking number for the order (not used by Webflow).", + ), + ] = None shipping_tracking_url: typing_extensions.Annotated[ - typing.Optional[str], FieldMetadata(alias="shippingTrackingURL") + typing.Optional[str], FieldMetadata(alias="shippingTrackingURL"), pydantic.Field(alias="shippingTrackingURL") ] = None customer_info: typing_extensions.Annotated[ - typing.Optional[OrderCustomerInfo], FieldMetadata(alias="customerInfo") - ] = pydantic.Field(default=None) - """ - An object with the keys `fullName` and `email`. - """ - + typing.Optional[OrderCustomerInfo], + FieldMetadata(alias="customerInfo"), + pydantic.Field(alias="customerInfo", description="An object with the keys `fullName` and `email`."), + ] = None purchased_items: typing_extensions.Annotated[ - typing.Optional[typing.List[OrderPurchasedItem]], FieldMetadata(alias="purchasedItems") - ] = pydantic.Field(default=None) - """ - An array of all things that the Customer purchased. - """ - + typing.Optional[typing.List[OrderPurchasedItem]], + FieldMetadata(alias="purchasedItems"), + pydantic.Field(alias="purchasedItems", description="An array of all things that the Customer purchased."), + ] = None purchased_items_count: typing_extensions.Annotated[ - typing.Optional[float], FieldMetadata(alias="purchasedItemsCount") - ] = pydantic.Field(default=None) - """ - The sum of all 'count' fields in 'purchasedItems'. - """ - + typing.Optional[float], + FieldMetadata(alias="purchasedItemsCount"), + pydantic.Field(alias="purchasedItemsCount", description="The sum of all 'count' fields in 'purchasedItems'."), + ] = None stripe_details: typing_extensions.Annotated[ - typing.Optional[StripeDetails], FieldMetadata(alias="stripeDetails") + typing.Optional[StripeDetails], FieldMetadata(alias="stripeDetails"), pydantic.Field(alias="stripeDetails") + ] = None + stripe_card: typing_extensions.Annotated[ + typing.Optional[StripeCard], FieldMetadata(alias="stripeCard"), pydantic.Field(alias="stripeCard") ] = None - stripe_card: typing_extensions.Annotated[typing.Optional[StripeCard], FieldMetadata(alias="stripeCard")] = None paypal_details: typing_extensions.Annotated[ - typing.Optional[PaypalDetails], FieldMetadata(alias="paypalDetails") + typing.Optional[PaypalDetails], FieldMetadata(alias="paypalDetails"), pydantic.Field(alias="paypalDetails") ] = None custom_data: typing_extensions.Annotated[ - typing.Optional[typing.List[typing.Dict[str, typing.Optional[typing.Any]]]], FieldMetadata(alias="customData") - ] = pydantic.Field(default=None) - """ - An array of additional inputs for custom order data gathering. Each object in the array represents an input with a name, and a textInput, textArea, or checkbox value. - """ - + typing.Optional[typing.List[typing.Dict[str, typing.Any]]], + FieldMetadata(alias="customData"), + pydantic.Field( + alias="customData", + description="An array of additional inputs for custom order data gathering. Each object in the array represents an input with a name, and a textInput, textArea, or checkbox value.", + ), + ] = None metadata: typing.Optional[OrderMetadata] = None is_customer_deleted: typing_extensions.Annotated[ - typing.Optional[bool], FieldMetadata(alias="isCustomerDeleted") - ] = pydantic.Field(default=None) - """ - A boolean indicating whether the customer has been deleted from the site. - """ - + typing.Optional[bool], + FieldMetadata(alias="isCustomerDeleted"), + pydantic.Field( + alias="isCustomerDeleted", + description="A boolean indicating whether the customer has been deleted from the site.", + ), + ] = None is_shipping_required: typing_extensions.Annotated[ - typing.Optional[bool], FieldMetadata(alias="isShippingRequired") - ] = pydantic.Field(default=None) - """ - A boolean indicating whether the order contains one or more purchased items that require shipping. - """ - - has_downloads: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="hasDownloads")] = ( - pydantic.Field(default=None) - ) - """ - A boolean indicating whether the order contains one or more purchased items that are downloadable. - """ - - payment_processor: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="paymentProcessor")] = ( - pydantic.Field(default=None) - ) - """ - A string indicating the payment processor used for this order. - """ - + typing.Optional[bool], + FieldMetadata(alias="isShippingRequired"), + pydantic.Field( + alias="isShippingRequired", + description="A boolean indicating whether the order contains one or more purchased items that require shipping.", + ), + ] = None + has_downloads: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="hasDownloads"), + pydantic.Field( + alias="hasDownloads", + description="A boolean indicating whether the order contains one or more purchased items that are downloadable.", + ), + ] = None + payment_processor: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="paymentProcessor"), + pydantic.Field( + alias="paymentProcessor", description="A string indicating the payment processor used for this order." + ), + ] = None totals: typing.Optional[OrderTotals] = pydantic.Field(default=None) """ An object describing various pricing totals """ download_files: typing_extensions.Annotated[ - typing.Optional[typing.List[OrderDownloadFilesItem]], FieldMetadata(alias="downloadFiles") - ] = pydantic.Field(default=None) - """ - An array of downloadable file objects. - """ + typing.Optional[typing.List[OrderDownloadFilesItem]], + FieldMetadata(alias="downloadFiles"), + pydantic.Field(alias="downloadFiles", description="An array of downloadable file objects."), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/order_address.py b/src/webflow/types/order_address.py index f225bc3..ad31ad4 100644 --- a/src/webflow/types/order_address.py +++ b/src/webflow/types/order_address.py @@ -1,13 +1,13 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing -from .order_address_type import OrderAddressType + import pydantic import typing_extensions -from .order_address_japan_type import OrderAddressJapanType +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from .order_address_japan_type import OrderAddressJapanType +from .order_address_type import OrderAddressType class OrderAddress(UniversalBaseModel): @@ -21,31 +21,28 @@ class OrderAddress(UniversalBaseModel): """ japan_type: typing_extensions.Annotated[ - typing.Optional[OrderAddressJapanType], FieldMetadata(alias="japanType") - ] = pydantic.Field(default=None) - """ - Represents a Japan-only address format. This field will only appear on orders placed from Japan. - """ - + typing.Optional[OrderAddressJapanType], + FieldMetadata(alias="japanType"), + pydantic.Field( + alias="japanType", + description="Represents a Japan-only address format. This field will only appear on orders placed from Japan.", + ), + ] = None addressee: typing.Optional[str] = pydantic.Field(default=None) """ Display name on the address """ - line_1: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="line1")] = pydantic.Field( - default=None - ) - """ - The first line of the address - """ - - line_2: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="line2")] = pydantic.Field( - default=None - ) - """ - The second line of the address - """ - + line_1: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="line1"), + pydantic.Field(alias="line1", description="The first line of the address"), + ] = None + line_2: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="line2"), + pydantic.Field(alias="line2", description="The second line of the address"), + ] = None city: typing.Optional[str] = pydantic.Field(default=None) """ The city of the address. @@ -61,12 +58,11 @@ class OrderAddress(UniversalBaseModel): The country of the address """ - postal_code: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="postalCode")] = pydantic.Field( - default=None - ) - """ - The postal code of the address - """ + postal_code: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="postalCode"), + pydantic.Field(alias="postalCode", description="The postal code of the address"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/order_billing_address.py b/src/webflow/types/order_billing_address.py new file mode 100644 index 0000000..484d367 --- /dev/null +++ b/src/webflow/types/order_billing_address.py @@ -0,0 +1,74 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .order_billing_address_japan_type import OrderBillingAddressJapanType +from .order_billing_address_type import OrderBillingAddressType + + +class OrderBillingAddress(UniversalBaseModel): + """ + The billing address + """ + + type: typing.Optional[OrderBillingAddressType] = pydantic.Field(default=None) + """ + The type of the order address (billing or shipping) + """ + + japan_type: typing_extensions.Annotated[ + typing.Optional[OrderBillingAddressJapanType], + FieldMetadata(alias="japanType"), + pydantic.Field( + alias="japanType", + description="Represents a Japan-only address format. This field will only appear on orders placed from Japan.", + ), + ] = None + addressee: typing.Optional[str] = pydantic.Field(default=None) + """ + Display name on the address + """ + + line_1: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="line1"), + pydantic.Field(alias="line1", description="The first line of the address"), + ] = None + line_2: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="line2"), + pydantic.Field(alias="line2", description="The second line of the address"), + ] = None + city: typing.Optional[str] = pydantic.Field(default=None) + """ + The city of the address. + """ + + state: typing.Optional[str] = pydantic.Field(default=None) + """ + The state or province of the address + """ + + country: typing.Optional[str] = pydantic.Field(default=None) + """ + The country of the address + """ + + postal_code: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="postalCode"), + pydantic.Field(alias="postalCode", description="The postal code of the address"), + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/order_billing_address_japan_type.py b/src/webflow/types/order_billing_address_japan_type.py new file mode 100644 index 0000000..8c983bb --- /dev/null +++ b/src/webflow/types/order_billing_address_japan_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +OrderBillingAddressJapanType = typing.Union[typing.Literal["kana", "kanji"], typing.Any] diff --git a/src/webflow/types/order_billing_address_type.py b/src/webflow/types/order_billing_address_type.py new file mode 100644 index 0000000..6b03d6e --- /dev/null +++ b/src/webflow/types/order_billing_address_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +OrderBillingAddressType = typing.Union[typing.Literal["shipping", "billing"], typing.Any] diff --git a/src/webflow/types/order_customer_info.py b/src/webflow/types/order_customer_info.py index 2179d43..fe7d88c 100644 --- a/src/webflow/types/order_customer_info.py +++ b/src/webflow/types/order_customer_info.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions import typing -from ..core.serialization import FieldMetadata + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata class OrderCustomerInfo(UniversalBaseModel): @@ -13,13 +13,11 @@ class OrderCustomerInfo(UniversalBaseModel): An object with the keys `fullName` and `email`. """ - full_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="fullName")] = pydantic.Field( - default=None - ) - """ - The full name of the Customer - """ - + full_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="fullName"), + pydantic.Field(alias="fullName", description="The full name of the Customer"), + ] = None email: typing.Optional[str] = pydantic.Field(default=None) """ The Customer's email address diff --git a/src/webflow/types/order_download_files_item.py b/src/webflow/types/order_download_files_item.py index bb0b489..1b54068 100644 --- a/src/webflow/types/order_download_files_item.py +++ b/src/webflow/types/order_download_files_item.py @@ -1,9 +1,9 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel class OrderDownloadFilesItem(UniversalBaseModel): diff --git a/src/webflow/types/order_list.py b/src/webflow/types/order_list.py index 7e01a45..2ecc568 100644 --- a/src/webflow/types/order_list.py +++ b/src/webflow/types/order_list.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing -from .order import Order + import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .order import Order from .pagination import Pagination -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class OrderList(UniversalBaseModel): diff --git a/src/webflow/types/order_metadata.py b/src/webflow/types/order_metadata.py index 6b6de11..33d966b 100644 --- a/src/webflow/types/order_metadata.py +++ b/src/webflow/types/order_metadata.py @@ -1,15 +1,17 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions import typing -from ..core.serialization import FieldMetadata -from ..core.pydantic_utilities import IS_PYDANTIC_V2 + import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata class OrderMetadata(UniversalBaseModel): - is_buy_now: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="isBuyNow")] = None + is_buy_now: typing_extensions.Annotated[ + typing.Optional[bool], FieldMetadata(alias="isBuyNow"), pydantic.Field(alias="isBuyNow") + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/order_price.py b/src/webflow/types/order_price.py index 6414850..310ea28 100644 --- a/src/webflow/types/order_price.py +++ b/src/webflow/types/order_price.py @@ -1,9 +1,9 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel class OrderPrice(UniversalBaseModel): diff --git a/src/webflow/types/order_purchased_item.py b/src/webflow/types/order_purchased_item.py index ba51f76..01b815e 100644 --- a/src/webflow/types/order_purchased_item.py +++ b/src/webflow/types/order_purchased_item.py @@ -1,13 +1,13 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic import typing_extensions -from .order_price import OrderPrice +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata +from .order_price import OrderPrice from .order_purchased_item_variant_image import OrderPurchasedItemVariantImage -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class OrderPurchasedItem(UniversalBaseModel): @@ -20,72 +20,56 @@ class OrderPurchasedItem(UniversalBaseModel): Number of Item purchased. """ - row_total: typing_extensions.Annotated[typing.Optional[OrderPrice], FieldMetadata(alias="rowTotal")] = ( - pydantic.Field(default=None) - ) - """ - The total for the row - """ - - product_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="productId")] = pydantic.Field( - default=None - ) - """ - The unique identifier for the Product - """ - - product_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="productName")] = ( - pydantic.Field(default=None) - ) - """ - User-facing name of the Product - """ - - product_slug: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="productSlug")] = ( - pydantic.Field(default=None) - ) - """ - Slug for the Product - """ - - variant_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="variantId")] = pydantic.Field( - default=None - ) - """ - Identifier for the Product Variant (SKU) - """ - - variant_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="variantName")] = ( - pydantic.Field(default=None) - ) - """ - User-facing name of the Product Variant (SKU) - """ - - variant_slug: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="variantSlug")] = ( - pydantic.Field(default=None) - ) - """ - Slug for the Product Variant (SKU) - """ - - variant_sku: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="variantSKU")] = pydantic.Field( - default=None - ) - """ - The user-defined custom SKU of the Product Variant (SKU) - """ - + row_total: typing_extensions.Annotated[ + typing.Optional[OrderPrice], + FieldMetadata(alias="rowTotal"), + pydantic.Field(alias="rowTotal", description="The total for the row"), + ] = None + product_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="productId"), + pydantic.Field(alias="productId", description="The unique identifier for the Product"), + ] = None + product_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="productName"), + pydantic.Field(alias="productName", description="User-facing name of the Product"), + ] = None + product_slug: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="productSlug"), + pydantic.Field(alias="productSlug", description="Slug for the Product"), + ] = None + variant_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="variantId"), + pydantic.Field(alias="variantId", description="Identifier for the Product Variant (SKU)"), + ] = None + variant_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="variantName"), + pydantic.Field(alias="variantName", description="User-facing name of the Product Variant (SKU)"), + ] = None + variant_slug: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="variantSlug"), + pydantic.Field(alias="variantSlug", description="Slug for the Product Variant (SKU)"), + ] = None + variant_sku: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="variantSKU"), + pydantic.Field(alias="variantSKU", description="The user-defined custom SKU of the Product Variant (SKU)"), + ] = None variant_image: typing_extensions.Annotated[ - typing.Optional[OrderPurchasedItemVariantImage], FieldMetadata(alias="variantImage") + typing.Optional[OrderPurchasedItemVariantImage], + FieldMetadata(alias="variantImage"), + pydantic.Field(alias="variantImage"), + ] = None + variant_price: typing_extensions.Annotated[ + typing.Optional[OrderPrice], + FieldMetadata(alias="variantPrice"), + pydantic.Field(alias="variantPrice", description="The price corresponding to the variant"), ] = None - variant_price: typing_extensions.Annotated[typing.Optional[OrderPrice], FieldMetadata(alias="variantPrice")] = ( - pydantic.Field(default=None) - ) - """ - The price corresponding to the variant - """ - weight: typing.Optional[float] = pydantic.Field(default=None) """ The physical weight of the variant if provided, or null diff --git a/src/webflow/types/order_purchased_item_variant_image.py b/src/webflow/types/order_purchased_item_variant_image.py index 1444bdd..14b745f 100644 --- a/src/webflow/types/order_purchased_item_variant_image.py +++ b/src/webflow/types/order_purchased_item_variant_image.py @@ -1,10 +1,10 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from .order_purchased_item_variant_image_file import OrderPurchasedItemVariantImageFile -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class OrderPurchasedItemVariantImage(UniversalBaseModel): diff --git a/src/webflow/types/order_purchased_item_variant_image_file.py b/src/webflow/types/order_purchased_item_variant_image_file.py index e61c891..0dc2670 100644 --- a/src/webflow/types/order_purchased_item_variant_image_file.py +++ b/src/webflow/types/order_purchased_item_variant_image_file.py @@ -1,13 +1,13 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel +import datetime as dt import typing + import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -import datetime as dt from .order_purchased_item_variant_image_file_variants_item import OrderPurchasedItemVariantImageFileVariantsItem -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class OrderPurchasedItemVariantImageFile(UniversalBaseModel): @@ -16,27 +16,21 @@ class OrderPurchasedItemVariantImageFile(UniversalBaseModel): The image size in bytes """ - original_file_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="originalFileName")] = ( - pydantic.Field(default=None) - ) - """ - the original name of the image - """ - - created_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdOn")] = ( - pydantic.Field(default=None) - ) - """ - The creation timestamp of the image - """ - - content_type: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="contentType")] = ( - pydantic.Field(default=None) - ) - """ - The MIME type of the image - """ - + original_file_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="originalFileName"), + pydantic.Field(alias="originalFileName", description="the original name of the image"), + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="The creation timestamp of the image"), + ] = None + content_type: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="contentType"), + pydantic.Field(alias="contentType", description="The MIME type of the image"), + ] = None width: typing.Optional[int] = pydantic.Field(default=None) """ The image width in pixels diff --git a/src/webflow/types/order_purchased_item_variant_image_file_variants_item.py b/src/webflow/types/order_purchased_item_variant_image_file_variants_item.py index a49bb84..093c7df 100644 --- a/src/webflow/types/order_purchased_item_variant_image_file_variants_item.py +++ b/src/webflow/types/order_purchased_item_variant_image_file_variants_item.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class OrderPurchasedItemVariantImageFileVariantsItem(UniversalBaseModel): @@ -14,9 +14,9 @@ class OrderPurchasedItemVariantImageFileVariantsItem(UniversalBaseModel): The hosted location for the Variant's image """ - original_file_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="originalFileName")] = ( - None - ) + original_file_name: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="originalFileName"), pydantic.Field(alias="originalFileName") + ] = None size: typing.Optional[float] = pydantic.Field(default=None) """ The image size in bytes diff --git a/src/webflow/types/order_shipping_address.py b/src/webflow/types/order_shipping_address.py new file mode 100644 index 0000000..afa230a --- /dev/null +++ b/src/webflow/types/order_shipping_address.py @@ -0,0 +1,74 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .order_shipping_address_japan_type import OrderShippingAddressJapanType +from .order_shipping_address_type import OrderShippingAddressType + + +class OrderShippingAddress(UniversalBaseModel): + """ + The shipping address + """ + + type: typing.Optional[OrderShippingAddressType] = pydantic.Field(default=None) + """ + The type of the order address (billing or shipping) + """ + + japan_type: typing_extensions.Annotated[ + typing.Optional[OrderShippingAddressJapanType], + FieldMetadata(alias="japanType"), + pydantic.Field( + alias="japanType", + description="Represents a Japan-only address format. This field will only appear on orders placed from Japan.", + ), + ] = None + addressee: typing.Optional[str] = pydantic.Field(default=None) + """ + Display name on the address + """ + + line_1: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="line1"), + pydantic.Field(alias="line1", description="The first line of the address"), + ] = None + line_2: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="line2"), + pydantic.Field(alias="line2", description="The second line of the address"), + ] = None + city: typing.Optional[str] = pydantic.Field(default=None) + """ + The city of the address. + """ + + state: typing.Optional[str] = pydantic.Field(default=None) + """ + The state or province of the address + """ + + country: typing.Optional[str] = pydantic.Field(default=None) + """ + The country of the address + """ + + postal_code: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="postalCode"), + pydantic.Field(alias="postalCode", description="The postal code of the address"), + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/order_shipping_address_japan_type.py b/src/webflow/types/order_shipping_address_japan_type.py new file mode 100644 index 0000000..b5b548e --- /dev/null +++ b/src/webflow/types/order_shipping_address_japan_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +OrderShippingAddressJapanType = typing.Union[typing.Literal["kana", "kanji"], typing.Any] diff --git a/src/webflow/types/order_shipping_address_type.py b/src/webflow/types/order_shipping_address_type.py new file mode 100644 index 0000000..467ccbd --- /dev/null +++ b/src/webflow/types/order_shipping_address_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +OrderShippingAddressType = typing.Union[typing.Literal["shipping", "billing"], typing.Any] diff --git a/src/webflow/types/order_totals.py b/src/webflow/types/order_totals.py index 3abdc2e..deca73c 100644 --- a/src/webflow/types/order_totals.py +++ b/src/webflow/types/order_totals.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing -from .order_price import OrderPrice + import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .order_price import OrderPrice from .order_totals_extras_item import OrderTotalsExtrasItem -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class OrderTotals(UniversalBaseModel): diff --git a/src/webflow/types/order_totals_extras_item.py b/src/webflow/types/order_totals_extras_item.py index fa71f2f..55f9f65 100644 --- a/src/webflow/types/order_totals_extras_item.py +++ b/src/webflow/types/order_totals_extras_item.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing -from .order_totals_extras_item_type import OrderTotalsExtrasItemType + import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from .order_price import OrderPrice -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from .order_totals_extras_item_type import OrderTotalsExtrasItemType class OrderTotalsExtrasItem(UniversalBaseModel): diff --git a/src/webflow/types/page.py b/src/webflow/types/page.py index 56b32d3..f191daa 100644 --- a/src/webflow/types/page.py +++ b/src/webflow/types/page.py @@ -1,14 +1,14 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel +import datetime as dt +import typing + import pydantic import typing_extensions -import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -import datetime as dt -from .page_seo import PageSeo from .page_open_graph import PageOpenGraph -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from .page_seo import PageSeo class Page(UniversalBaseModel): @@ -21,13 +21,11 @@ class Page(UniversalBaseModel): Unique identifier for the Page """ - site_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="siteId")] = pydantic.Field( - default=None - ) - """ - Unique identifier for the Site - """ - + site_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="siteId"), + pydantic.Field(alias="siteId", description="Unique identifier for the Site"), + ] = None title: typing.Optional[str] = pydantic.Field(default=None) """ Title of the Page @@ -38,34 +36,29 @@ class Page(UniversalBaseModel): slug of the Page (derived from title) """ - parent_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="parentId")] = pydantic.Field( - default=None - ) - """ - Identifier of the parent folder - """ - - collection_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="collectionId")] = ( - pydantic.Field(default=None) - ) - """ - Unique identifier for a linked Collection, value will be null if the Page is not part of a Collection. - """ - - created_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdOn")] = ( - pydantic.Field(default=None) - ) - """ - The date the Page was created - """ - - last_updated: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastUpdated")] = ( - pydantic.Field(default=None) - ) - """ - The date the Page was most recently updated - """ - + parent_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="parentId"), + pydantic.Field(alias="parentId", description="Identifier of the parent folder"), + ] = None + collection_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="collectionId"), + pydantic.Field( + alias="collectionId", + description="Unique identifier for a linked Collection, value will be null if the Page is not part of a Collection.", + ), + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="The date the Page was created"), + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="The date the Page was most recently updated"), + ] = None archived: typing.Optional[bool] = pydantic.Field(default=None) """ Whether the Page has been archived @@ -76,52 +69,49 @@ class Page(UniversalBaseModel): Whether the Page is a draft """ - can_branch: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="canBranch")] = pydantic.Field( - default=None - ) - """ - Indicates whether the Page supports [Page Branching](https://university.webflow.com/lesson/page-branching) - """ - - is_branch: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="isBranch")] = pydantic.Field( - default=None - ) - """ - Indicates whether the Page is a Branch of another Page [Page Branching](https://university.webflow.com/lesson/page-branching) - """ - - is_members_only: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="isMembersOnly")] = ( - pydantic.Field(default=None) - ) - """ - Indicates whether the Page is restricted by [Memberships Controls](https://university.webflow.com/lesson/webflow-memberships-overview#how-to-manage-page-restrictions) - """ - + can_branch: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="canBranch"), + pydantic.Field( + alias="canBranch", + description="Indicates whether the Page supports [Page Branching](https://university.webflow.com/lesson/page-branching). Pages that are already branches cannot be branched again.", + ), + ] = None + is_branch: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="isBranch"), + pydantic.Field( + alias="isBranch", + description="Indicates whether the Page is a Branch of another Page [Page Branching](https://university.webflow.com/lesson/page-branching)", + ), + ] = None + branch_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="branchId"), + pydantic.Field( + alias="branchId", description="If the Page is a Branch of another Page, this is the ID of the Branch" + ), + ] = None seo: typing.Optional[PageSeo] = pydantic.Field(default=None) """ SEO-related fields for the Page """ - open_graph: typing_extensions.Annotated[typing.Optional[PageOpenGraph], FieldMetadata(alias="openGraph")] = ( - pydantic.Field(default=None) - ) - """ - Open Graph fields for the Page - """ - - locale_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="localeId")] = pydantic.Field( - default=None - ) - """ - Unique ID of the page locale - """ - - published_path: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="publishedPath")] = ( - pydantic.Field(default=None) - ) - """ - Relative path of the published page URL - """ + open_graph: typing_extensions.Annotated[ + typing.Optional[PageOpenGraph], + FieldMetadata(alias="openGraph"), + pydantic.Field(alias="openGraph", description="Open Graph fields for the Page"), + ] = None + locale_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="localeId"), + pydantic.Field(alias="localeId", description="Unique ID of the page locale"), + ] = None + published_path: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="publishedPath"), + pydantic.Field(alias="publishedPath", description="Relative path of the published page URL"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/page_created_webhook.py b/src/webflow/types/page_created_webhook.py new file mode 100644 index 0000000..14efaf3 --- /dev/null +++ b/src/webflow/types/page_created_webhook.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .page_created_webhook_payload import PageCreatedWebhookPayload + + +class PageCreatedWebhook(UniversalBaseModel): + """ + The Webhook payload for when a Page is created + """ + + trigger_type: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="triggerType"), + pydantic.Field(alias="triggerType", description="The type of event that triggered the request"), + ] = None + payload: typing.Optional[PageCreatedWebhookPayload] = pydantic.Field(default=None) + """ + The payload of data sent from Webflow + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/page_created_webhook_payload.py b/src/webflow/types/page_created_webhook_payload.py new file mode 100644 index 0000000..4dd3385 --- /dev/null +++ b/src/webflow/types/page_created_webhook_payload.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +import datetime as dt +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata + + +class PageCreatedWebhookPayload(UniversalBaseModel): + """ + The payload of data sent from Webflow + """ + + site_id: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="siteId"), pydantic.Field(alias="siteId") + ] = None + page_id: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="pageId"), pydantic.Field(alias="pageId") + ] = None + page_title: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="pageTitle"), pydantic.Field(alias="pageTitle") + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], FieldMetadata(alias="createdOn"), pydantic.Field(alias="createdOn") + ] = None + published_path: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="publishedPath"), pydantic.Field(alias="publishedPath") + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/page_deleted_webhook.py b/src/webflow/types/page_deleted_webhook.py new file mode 100644 index 0000000..247f4ae --- /dev/null +++ b/src/webflow/types/page_deleted_webhook.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .page_deleted_webhook_payload import PageDeletedWebhookPayload + + +class PageDeletedWebhook(UniversalBaseModel): + """ + The Webhook payload for when a Page is deleted + """ + + trigger_type: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="triggerType"), + pydantic.Field(alias="triggerType", description="The type of event that triggered the request"), + ] = None + payload: typing.Optional[PageDeletedWebhookPayload] = pydantic.Field(default=None) + """ + The payload of data sent from Webflow + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/page_deleted_webhook_payload.py b/src/webflow/types/page_deleted_webhook_payload.py new file mode 100644 index 0000000..e78f589 --- /dev/null +++ b/src/webflow/types/page_deleted_webhook_payload.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +import datetime as dt +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata + + +class PageDeletedWebhookPayload(UniversalBaseModel): + """ + The payload of data sent from Webflow + """ + + site_id: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="siteId"), pydantic.Field(alias="siteId") + ] = None + page_id: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="pageId"), pydantic.Field(alias="pageId") + ] = None + page_title: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="pageTitle"), pydantic.Field(alias="pageTitle") + ] = None + deleted_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], FieldMetadata(alias="deletedOn"), pydantic.Field(alias="deletedOn") + ] = None + published_path: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="publishedPath"), pydantic.Field(alias="publishedPath") + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/page_list.py b/src/webflow/types/page_list.py index 59e4e79..a392bea 100644 --- a/src/webflow/types/page_list.py +++ b/src/webflow/types/page_list.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from .page import Page from .pagination import Pagination -from ..core.pydantic_utilities import IS_PYDANTIC_V2 -import pydantic class PageList(UniversalBaseModel): diff --git a/src/webflow/types/page_metadata_updated_webhook.py b/src/webflow/types/page_metadata_updated_webhook.py new file mode 100644 index 0000000..0751f3a --- /dev/null +++ b/src/webflow/types/page_metadata_updated_webhook.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .page_metadata_updated_webhook_payload import PageMetadataUpdatedWebhookPayload + + +class PageMetadataUpdatedWebhook(UniversalBaseModel): + """ + The Webhook payload for when a Page's metadata is updated + """ + + trigger_type: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="triggerType"), + pydantic.Field(alias="triggerType", description="The type of event that triggered the request"), + ] = None + payload: typing.Optional[PageMetadataUpdatedWebhookPayload] = pydantic.Field(default=None) + """ + The payload of data sent from Webflow + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/page_metadata_updated_webhook_payload.py b/src/webflow/types/page_metadata_updated_webhook_payload.py new file mode 100644 index 0000000..d71cf47 --- /dev/null +++ b/src/webflow/types/page_metadata_updated_webhook_payload.py @@ -0,0 +1,40 @@ +# This file was auto-generated by Fern from our API Definition. + +import datetime as dt +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata + + +class PageMetadataUpdatedWebhookPayload(UniversalBaseModel): + """ + The payload of data sent from Webflow + """ + + site_id: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="siteId"), pydantic.Field(alias="siteId") + ] = None + page_id: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="pageId"), pydantic.Field(alias="pageId") + ] = None + page_title: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="pageTitle"), pydantic.Field(alias="pageTitle") + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[dt.datetime], FieldMetadata(alias="lastUpdated"), pydantic.Field(alias="lastUpdated") + ] = None + published_path: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="publishedPath"), pydantic.Field(alias="publishedPath") + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/page_open_graph.py b/src/webflow/types/page_open_graph.py index f6d48b1..63d6898 100644 --- a/src/webflow/types/page_open_graph.py +++ b/src/webflow/types/page_open_graph.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class PageOpenGraph(UniversalBaseModel): @@ -18,24 +18,24 @@ class PageOpenGraph(UniversalBaseModel): The title supplied to Open Graph annotations """ - title_copied: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="titleCopied")] = ( - pydantic.Field(default=None) - ) - """ - Indicates the Open Graph title was copied from the SEO title - """ - + title_copied: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="titleCopied"), + pydantic.Field(alias="titleCopied", description="Indicates the Open Graph title was copied from the SEO title"), + ] = None description: typing.Optional[str] = pydantic.Field(default=None) """ The description supplied to Open Graph annotations """ - description_copied: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="descriptionCopied")] = ( - pydantic.Field(default=None) - ) - """ - Indicates the Open Graph description was copied from the SEO description - """ + description_copied: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="descriptionCopied"), + pydantic.Field( + alias="descriptionCopied", + description="Indicates the Open Graph description was copied from the SEO description", + ), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/page_seo.py b/src/webflow/types/page_seo.py index 737e68c..4182b16 100644 --- a/src/webflow/types/page_seo.py +++ b/src/webflow/types/page_seo.py @@ -1,9 +1,9 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel class PageSeo(UniversalBaseModel): diff --git a/src/webflow/types/pagination.py b/src/webflow/types/pagination.py index aa38c46..72cd209 100644 --- a/src/webflow/types/pagination.py +++ b/src/webflow/types/pagination.py @@ -1,9 +1,9 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel class Pagination(UniversalBaseModel): @@ -11,17 +11,17 @@ class Pagination(UniversalBaseModel): Pagination object """ - limit: typing.Optional[float] = pydantic.Field(default=None) + limit: typing.Optional[int] = pydantic.Field(default=None) """ The limit used for pagination """ - offset: typing.Optional[float] = pydantic.Field(default=None) + offset: typing.Optional[int] = pydantic.Field(default=None) """ The offset used for pagination """ - total: typing.Optional[float] = pydantic.Field(default=None) + total: typing.Optional[int] = pydantic.Field(default=None) """ The total number of records """ diff --git a/src/webflow/types/payload.py b/src/webflow/types/payload.py new file mode 100644 index 0000000..efd0d48 --- /dev/null +++ b/src/webflow/types/payload.py @@ -0,0 +1,69 @@ +# This file was auto-generated by Fern from our API Definition. + +import datetime as dt +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .payload_field_data import PayloadFieldData + + +class Payload(UniversalBaseModel): + """ + The payload of data sent from Webflow + """ + + id: typing.Optional[str] = pydantic.Field(default=None) + """ + The ID of the collection item that was unpublished + """ + + site_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="siteId"), + pydantic.Field(alias="siteId", description="The ID of the site"), + ] = None + workspace_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="workspaceId"), + pydantic.Field(alias="workspaceId", description="The ID of the workspace"), + ] = None + collection_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="collectionId"), + pydantic.Field(alias="collectionId", description="The ID of the collection"), + ] = None + cms_locale_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="cmsLocaleId"), + pydantic.Field(alias="cmsLocaleId", description="Unique identifier of the CMS locale for this item"), + ] = None + last_published: typing_extensions.Annotated[ + typing.Optional[dt.datetime], FieldMetadata(alias="lastPublished"), pydantic.Field(alias="lastPublished") + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[dt.datetime], FieldMetadata(alias="lastUpdated"), pydantic.Field(alias="lastUpdated") + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], FieldMetadata(alias="createdOn"), pydantic.Field(alias="createdOn") + ] = None + is_archived: typing_extensions.Annotated[ + typing.Optional[bool], FieldMetadata(alias="isArchived"), pydantic.Field(alias="isArchived") + ] = None + is_draft: typing_extensions.Annotated[ + typing.Optional[bool], FieldMetadata(alias="isDraft"), pydantic.Field(alias="isDraft") + ] = None + field_data: typing_extensions.Annotated[ + typing.Optional[PayloadFieldData], FieldMetadata(alias="fieldData"), pydantic.Field(alias="fieldData") + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/payload_field_data.py b/src/webflow/types/payload_field_data.py new file mode 100644 index 0000000..c8c69ce --- /dev/null +++ b/src/webflow/types/payload_field_data.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class PayloadFieldData(UniversalBaseModel): + name: str + slug: str + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/paypal_details.py b/src/webflow/types/paypal_details.py index b98efef..9ed4a6e 100644 --- a/src/webflow/types/paypal_details.py +++ b/src/webflow/types/paypal_details.py @@ -1,55 +1,44 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions import typing -from ..core.serialization import FieldMetadata + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata class PaypalDetails(UniversalBaseModel): - order_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="orderId")] = pydantic.Field( - default=None - ) - """ - PayPal order identifier - """ - - payer_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="payerId")] = pydantic.Field( - default=None - ) - """ - PayPal payer identifier - """ - - capture_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="captureId")] = pydantic.Field( - default=None - ) - """ - PayPal capture identifier - """ - - refund_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="refundId")] = pydantic.Field( - default=None - ) - """ - PayPal refund identifier - """ - - refund_reason: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="refundReason")] = ( - pydantic.Field(default=None) - ) - """ - PayPal-issued reason for the refund - """ - - dispute_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="disputeId")] = pydantic.Field( - default=None - ) - """ - PayPal dispute identifier - """ + order_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="orderId"), + pydantic.Field(alias="orderId", description="PayPal order identifier"), + ] = None + payer_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="payerId"), + pydantic.Field(alias="payerId", description="PayPal payer identifier"), + ] = None + capture_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="captureId"), + pydantic.Field(alias="captureId", description="PayPal capture identifier"), + ] = None + refund_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="refundId"), + pydantic.Field(alias="refundId", description="PayPal refund identifier"), + ] = None + refund_reason: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="refundReason"), + pydantic.Field(alias="refundReason", description="PayPal-issued reason for the refund"), + ] = None + dispute_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="disputeId"), + pydantic.Field(alias="disputeId", description="PayPal dispute identifier"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/product.py b/src/webflow/types/product.py index a39ca3d..f0e48bd 100644 --- a/src/webflow/types/product.py +++ b/src/webflow/types/product.py @@ -1,13 +1,13 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel +import datetime as dt import typing + import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -import datetime as dt from .product_field_data import ProductFieldData -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class Product(UniversalBaseModel): @@ -20,49 +20,39 @@ class Product(UniversalBaseModel): Unique identifier for the Product """ - cms_locale_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="cmsLocaleId")] = ( - pydantic.Field(default=None) - ) - """ - Identifier for the locale of the CMS item - """ - - last_published: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastPublished")] = ( - pydantic.Field(default=None) - ) - """ - The date the Product was last published - """ - - last_updated: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastUpdated")] = ( - pydantic.Field(default=None) - ) - """ - The date the Product was last updated - """ - - created_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdOn")] = ( - pydantic.Field(default=None) - ) - """ - The date the Product was created - """ - - is_archived: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="isArchived")] = pydantic.Field( - default=None - ) - """ - Boolean determining if the Product is set to archived - """ - - is_draft: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="isDraft")] = pydantic.Field( - default=None - ) - """ - Boolean determining if the Product is set to draft - """ - - field_data: typing_extensions.Annotated[typing.Optional[ProductFieldData], FieldMetadata(alias="fieldData")] = None + cms_locale_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="cmsLocaleId"), + pydantic.Field(alias="cmsLocaleId", description="Identifier for the locale of the CMS item"), + ] = None + last_published: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="lastPublished"), + pydantic.Field(alias="lastPublished", description="The date the Product was last published"), + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="The date the Product was last updated"), + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="The date the Product was created"), + ] = None + is_archived: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="isArchived"), + pydantic.Field(alias="isArchived", description="Boolean determining if the Product is set to archived"), + ] = None + is_draft: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="isDraft"), + pydantic.Field(alias="isDraft", description="Boolean determining if the Product is set to draft"), + ] = None + field_data: typing_extensions.Annotated[ + typing.Optional[ProductFieldData], FieldMetadata(alias="fieldData"), pydantic.Field(alias="fieldData") + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/product_and_sk_us.py b/src/webflow/types/product_and_sk_us.py index 6aea2cb..42b5b62 100644 --- a/src/webflow/types/product_and_sk_us.py +++ b/src/webflow/types/product_and_sk_us.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from .product import Product from .sku import Sku -import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class ProductAndSkUs(UniversalBaseModel): diff --git a/src/webflow/types/product_and_sk_us_list.py b/src/webflow/types/product_and_sk_us_list.py index 6bdafd5..a2060d7 100644 --- a/src/webflow/types/product_and_sk_us_list.py +++ b/src/webflow/types/product_and_sk_us_list.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing -from .product_and_sk_us import ProductAndSkUs + import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from .pagination import Pagination -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from .product_and_sk_us import ProductAndSkUs class ProductAndSkUsList(UniversalBaseModel): diff --git a/src/webflow/types/product_field_data.py b/src/webflow/types/product_field_data.py index e58b83d..b9c15fb 100644 --- a/src/webflow/types/product_field_data.py +++ b/src/webflow/types/product_field_data.py @@ -1,19 +1,19 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic import typing_extensions -from .sku_property_list import SkuPropertyList +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -from .product_field_data_tax_category import ProductFieldDataTaxCategory from .product_field_data_ec_product_type import ProductFieldDataEcProductType -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from .product_field_data_tax_category import ProductFieldDataTaxCategory +from .sku_property_list import SkuPropertyList class ProductFieldData(UniversalBaseModel): """ - Contains content-specific details for a product, covering both standard (e.g., title, description) and custom fields tailored to the product setup. + Contains content-specific details for a product, covering both standard (e.g., title, description) and custom fields tailored to the product setup. """ name: typing.Optional[str] = pydantic.Field(default=None) @@ -37,37 +37,33 @@ class ProductFieldData(UniversalBaseModel): """ sku_properties: typing_extensions.Annotated[ - typing.Optional[typing.List[SkuPropertyList]], FieldMetadata(alias="sku-properties") - ] = pydantic.Field(default=None) - """ - Variant types to include in SKUs - """ - - categories: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + typing.Optional[typing.List[SkuPropertyList]], + FieldMetadata(alias="sku-properties"), + pydantic.Field(alias="sku-properties", description="Variant types to include in SKUs"), + ] = None + category: typing.Optional[typing.List[str]] = pydantic.Field(default=None) """ - The categories your product belongs to. + The category your product belongs to. """ tax_category: typing_extensions.Annotated[ - typing.Optional[ProductFieldDataTaxCategory], FieldMetadata(alias="tax-category") - ] = pydantic.Field(default=None) - """ - Product tax class - """ - - default_sku: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="default-sku")] = pydantic.Field( - default=None - ) - """ - The default SKU associated with this product. - """ - + typing.Optional[ProductFieldDataTaxCategory], + FieldMetadata(alias="tax-category"), + pydantic.Field(alias="tax-category", description="Product tax class"), + ] = None + default_sku: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="default-sku"), + pydantic.Field(alias="default-sku", description="The default SKU associated with this product."), + ] = None ec_product_type: typing_extensions.Annotated[ - typing.Optional[ProductFieldDataEcProductType], FieldMetadata(alias="ec-product-type") - ] = pydantic.Field(default=None) - """ - Product types. Enums reflect the following values in order: Physical, Digital, Service, Advanced" - """ + typing.Optional[ProductFieldDataEcProductType], + FieldMetadata(alias="ec-product-type"), + pydantic.Field( + alias="ec-product-type", + description='Product types. Enums reflect the following values in order: Physical, Digital, Service, Advanced"', + ), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/redirect.py b/src/webflow/types/redirect.py index 0205f34..4937365 100644 --- a/src/webflow/types/redirect.py +++ b/src/webflow/types/redirect.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class Redirect(UniversalBaseModel): @@ -18,19 +18,16 @@ class Redirect(UniversalBaseModel): The ID of the specific redirect rule """ - from_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="fromUrl")] = pydantic.Field( - default=None - ) - """ - The source URL path that will be redirected. - """ - - to_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="toUrl")] = pydantic.Field( - default=None - ) - """ - The target URL path where the user or client will be redirected. - """ + from_url: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="fromUrl"), + pydantic.Field(alias="fromUrl", description="The source URL path that will be redirected."), + ] = None + to_url: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="toUrl"), + pydantic.Field(alias="toUrl", description="The target URL path where the user or client will be redirected."), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/redirects.py b/src/webflow/types/redirects.py index bd466b2..5126ce1 100644 --- a/src/webflow/types/redirects.py +++ b/src/webflow/types/redirects.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing -from .redirect import Redirect + import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from .pagination import Pagination -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from .redirect import Redirect class Redirects(UniversalBaseModel): diff --git a/src/webflow/types/reference_field.py b/src/webflow/types/reference_field.py new file mode 100644 index 0000000..fa2efe6 --- /dev/null +++ b/src/webflow/types/reference_field.py @@ -0,0 +1,54 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .reference_field_metadata import ReferenceFieldMetadata +from .reference_field_type import ReferenceFieldType + + +class ReferenceField(UniversalBaseModel): + id: typing.Optional[str] = pydantic.Field(default=None) + """ + Unique identifier for a Field + """ + + is_editable: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="isEditable"), + pydantic.Field(alias="isEditable", description="Define whether the field is editable"), + ] = None + is_required: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="isRequired"), + pydantic.Field(alias="isRequired", description="define whether a field is required in a collection"), + ] = None + type: ReferenceFieldType = pydantic.Field() + """ + Choose these appropriate field type for your collection data + """ + + display_name: typing_extensions.Annotated[ + str, FieldMetadata(alias="displayName"), pydantic.Field(alias="displayName", description="The name of a field") + ] + help_text: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="helpText"), + pydantic.Field(alias="helpText", description="Additional text to help anyone filling out this field"), + ] = None + metadata: ReferenceFieldMetadata = pydantic.Field() + """ + The collectionId for the referenced collection. Only applicable for Reference and MultiReference fields. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/reference_field_metadata.py b/src/webflow/types/reference_field_metadata.py new file mode 100644 index 0000000..0a6bb01 --- /dev/null +++ b/src/webflow/types/reference_field_metadata.py @@ -0,0 +1,29 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata + + +class ReferenceFieldMetadata(UniversalBaseModel): + """ + The collectionId for the referenced collection. Only applicable for Reference and MultiReference fields. + """ + + collection_id: typing_extensions.Annotated[ + str, + FieldMetadata(alias="collectionId"), + pydantic.Field(alias="collectionId", description="The unique identifier of the collection"), + ] + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/reference_field_type.py b/src/webflow/types/reference_field_type.py new file mode 100644 index 0000000..b80f3e1 --- /dev/null +++ b/src/webflow/types/reference_field_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +ReferenceFieldType = typing.Union[typing.Literal["MultiReference", "Reference"], typing.Any] diff --git a/src/webflow/types/registered_script_list.py b/src/webflow/types/registered_script_list.py index ddfff8d..8822e68 100644 --- a/src/webflow/types/registered_script_list.py +++ b/src/webflow/types/registered_script_list.py @@ -1,12 +1,13 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions import typing -from .custom_code_hosted_response import CustomCodeHostedResponse -from ..core.serialization import FieldMetadata -from ..core.pydantic_utilities import IS_PYDANTIC_V2 + import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .custom_code_hosted_response import CustomCodeHostedResponse +from .pagination import Pagination class RegisteredScriptList(UniversalBaseModel): @@ -15,8 +16,11 @@ class RegisteredScriptList(UniversalBaseModel): """ registered_scripts: typing_extensions.Annotated[ - typing.Optional[typing.List[CustomCodeHostedResponse]], FieldMetadata(alias="registeredScripts") + typing.Optional[typing.List[CustomCodeHostedResponse]], + FieldMetadata(alias="registeredScripts"), + pydantic.Field(alias="registeredScripts"), ] = None + pagination: typing.Optional[Pagination] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/robots.py b/src/webflow/types/robots.py new file mode 100644 index 0000000..6a6170e --- /dev/null +++ b/src/webflow/types/robots.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .robots_rules_item import RobotsRulesItem + + +class Robots(UniversalBaseModel): + """ + The robots.txt file for a given site + """ + + rules: typing.Optional[typing.List[RobotsRulesItem]] = pydantic.Field(default=None) + """ + List of rules for user agents. + """ + + sitemap: typing.Optional[str] = pydantic.Field(default=None) + """ + URL to the sitemap. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/robots_rules_item.py b/src/webflow/types/robots_rules_item.py new file mode 100644 index 0000000..27c8a5e --- /dev/null +++ b/src/webflow/types/robots_rules_item.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata + + +class RobotsRulesItem(UniversalBaseModel): + user_agent: typing_extensions.Annotated[ + str, + FieldMetadata(alias="userAgent"), + pydantic.Field(alias="userAgent", description="The user agent the rules apply to."), + ] + allows: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + List of paths allowed for this user agent. + """ + + disallows: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + List of paths disallowed for this user agent. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/script_apply.py b/src/webflow/types/script_apply.py index 6ba1930..e2bd746 100644 --- a/src/webflow/types/script_apply.py +++ b/src/webflow/types/script_apply.py @@ -1,10 +1,10 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel +import typing + import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from .script_apply_location import ScriptApplyLocation -import typing -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class ScriptApply(UniversalBaseModel): @@ -23,7 +23,7 @@ class ScriptApply(UniversalBaseModel): Semantic Version String for the registered script *e.g. 0.0.1* """ - attributes: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = pydantic.Field(default=None) + attributes: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None) """ Developer-specified key/value pairs to be applied as attributes to the script """ diff --git a/src/webflow/types/script_apply_list.py b/src/webflow/types/script_apply_list.py index e89b54d..89c79f4 100644 --- a/src/webflow/types/script_apply_list.py +++ b/src/webflow/types/script_apply_list.py @@ -1,12 +1,12 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing -from .script_apply import ScriptApply + import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from .script_apply import ScriptApply class ScriptApplyList(UniversalBaseModel): @@ -15,19 +15,16 @@ class ScriptApplyList(UniversalBaseModel): A list of scripts applied to a Site or a Page """ - last_updated: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="lastUpdated")] = ( - pydantic.Field(default=None) - ) - """ - Date when the Site's scripts were last updated - """ - - created_on: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="createdOn")] = pydantic.Field( - default=None - ) - """ - Date when the Site's scripts were created - """ + last_updated: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="Date when the Site's scripts were last updated"), + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="Date when the Site's scripts were created"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/scripts.py b/src/webflow/types/scripts.py index 1f0c1c1..6ff9844 100644 --- a/src/webflow/types/scripts.py +++ b/src/webflow/types/scripts.py @@ -1,6 +1,7 @@ # This file was auto-generated by Fern from our API Definition. import typing + from .script_apply import ScriptApply Scripts = typing.List[ScriptApply] diff --git a/src/webflow/types/search_button_node.py b/src/webflow/types/search_button_node.py new file mode 100644 index 0000000..7e40c75 --- /dev/null +++ b/src/webflow/types/search_button_node.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class SearchButtonNode(UniversalBaseModel): + """ + Represents search button elements within the DOM. It contains the text of the button. Additional attributes can be associated with the text for styling or other purposes. + """ + + id: str = pydantic.Field() + """ + Node UUID + """ + + value: str = pydantic.Field() + """ + The text content of the search button. + """ + + attributes: typing.Optional[typing.Dict[str, str]] = pydantic.Field(default=None) + """ + The custom attributes of the node + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/search_button_node_write.py b/src/webflow/types/search_button_node_write.py new file mode 100644 index 0000000..532f4b3 --- /dev/null +++ b/src/webflow/types/search_button_node_write.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata + + +class SearchButtonNodeWrite(UniversalBaseModel): + """ + Update a search button node + """ + + node_id: typing_extensions.Annotated[ + str, FieldMetadata(alias="nodeId"), pydantic.Field(alias="nodeId", description="Node UUID") + ] + value: str = pydantic.Field() + """ + The text content of the search button. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/select.py b/src/webflow/types/select.py new file mode 100644 index 0000000..d39d5c3 --- /dev/null +++ b/src/webflow/types/select.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .select_node_write_choices_item import SelectNodeWriteChoicesItem + + +class Select(UniversalBaseModel): + """ + Update choices on a select node + """ + + node_id: typing_extensions.Annotated[ + str, FieldMetadata(alias="nodeId"), pydantic.Field(alias="nodeId", description="Node UUID") + ] + choices: typing.List[SelectNodeWriteChoicesItem] = pydantic.Field() + """ + The list of choices to set on the select node. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/select_node.py b/src/webflow/types/select_node.py new file mode 100644 index 0000000..17ca346 --- /dev/null +++ b/src/webflow/types/select_node.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .select_node_choices_item import SelectNodeChoicesItem + + +class SelectNode(UniversalBaseModel): + """ + Represents select elements within the DOM. It contains the list of choices in the select. Additional attributes can be associated with the text for styling or other purposes. + """ + + id: str = pydantic.Field() + """ + Node UUID + """ + + choices: typing.List[SelectNodeChoicesItem] = pydantic.Field() + """ + The list of choices in this select node. + """ + + attributes: typing.Optional[typing.Dict[str, str]] = pydantic.Field(default=None) + """ + The custom attributes of the node + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/user_data.py b/src/webflow/types/select_node_choices_item.py similarity index 57% rename from src/webflow/types/user_data.py rename to src/webflow/types/select_node_choices_item.py index 08e35ec..cb0bf0d 100644 --- a/src/webflow/types/user_data.py +++ b/src/webflow/types/select_node_choices_item.py @@ -1,18 +1,21 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing -from .user_data_data import UserDataData -from ..core.pydantic_utilities import IS_PYDANTIC_V2 + import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel -class UserData(UniversalBaseModel): +class SelectNodeChoicesItem(UniversalBaseModel): + value: str = pydantic.Field() """ - An object containing the User's basic info and custom fields + The value of the choice when selected. """ - data: typing.Optional[UserDataData] = None + text: str = pydantic.Field() + """ + The text to display for the choice. + """ if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/select_node_write_choices_item.py b/src/webflow/types/select_node_write_choices_item.py new file mode 100644 index 0000000..05f5108 --- /dev/null +++ b/src/webflow/types/select_node_write_choices_item.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class SelectNodeWriteChoicesItem(UniversalBaseModel): + value: str = pydantic.Field() + """ + The value of the choice when selected. + """ + + text: str = pydantic.Field() + """ + The text to display for the choice. + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/setting_change.py b/src/webflow/types/setting_change.py new file mode 100644 index 0000000..c2de45a --- /dev/null +++ b/src/webflow/types/setting_change.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .workspace_audit_log_item_payload_setting_change_method import WorkspaceAuditLogItemPayloadSettingChangeMethod + + +class SettingChange(UniversalBaseModel): + setting: typing.Optional[typing.Literal["ai_toggle"]] = None + previous_value: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="previousValue"), pydantic.Field(alias="previousValue") + ] = None + value: typing.Optional[str] = None + method: typing.Optional[WorkspaceAuditLogItemPayloadSettingChangeMethod] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/setting_change_audit_log_item.py b/src/webflow/types/setting_change_audit_log_item.py new file mode 100644 index 0000000..6846347 --- /dev/null +++ b/src/webflow/types/setting_change_audit_log_item.py @@ -0,0 +1,27 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .setting_change import SettingChange + + +class SettingChangeAuditLogItem(UniversalBaseModel): + event_sub_type: typing_extensions.Annotated[ + typing.Optional[typing.Literal["setting_updated"]], + FieldMetadata(alias="eventSubType"), + pydantic.Field(alias="eventSubType"), + ] = None + payload: typing.Optional[SettingChange] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/single_locale_created_payload.py b/src/webflow/types/single_locale_created_payload.py new file mode 100644 index 0000000..ea086d2 --- /dev/null +++ b/src/webflow/types/single_locale_created_payload.py @@ -0,0 +1,63 @@ +# This file was auto-generated by Fern from our API Definition. + +import datetime as dt +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .single_locale_created_payload_field_data import SingleLocaleCreatedPayloadFieldData + + +class SingleLocaleCreatedPayload(UniversalBaseModel): + id: str = pydantic.Field() + """ + Unique identifier for the Item + """ + + workspace_id: typing_extensions.Annotated[ + str, + FieldMetadata(alias="workspaceId"), + pydantic.Field(alias="workspaceId", description="Unique identifier of the workspace"), + ] + site_id: typing_extensions.Annotated[ + str, FieldMetadata(alias="siteId"), pydantic.Field(alias="siteId", description="Unique identifier of the site") + ] + collection_id: typing_extensions.Annotated[ + str, + FieldMetadata(alias="collectionId"), + pydantic.Field(alias="collectionId", description="Unique identifier of the collection"), + ] + cms_locale_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="cmsLocaleId"), + pydantic.Field(alias="cmsLocaleId", description="Unique identifier of the CMS locale for this item"), + ] = None + last_published: typing_extensions.Annotated[ + typing.Optional[dt.datetime], FieldMetadata(alias="lastPublished"), pydantic.Field(alias="lastPublished") + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[dt.datetime], FieldMetadata(alias="lastUpdated"), pydantic.Field(alias="lastUpdated") + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], FieldMetadata(alias="createdOn"), pydantic.Field(alias="createdOn") + ] = None + is_archived: typing_extensions.Annotated[ + typing.Optional[bool], FieldMetadata(alias="isArchived"), pydantic.Field(alias="isArchived") + ] = None + is_draft: typing_extensions.Annotated[ + typing.Optional[bool], FieldMetadata(alias="isDraft"), pydantic.Field(alias="isDraft") + ] = None + field_data: typing_extensions.Annotated[ + SingleLocaleCreatedPayloadFieldData, FieldMetadata(alias="fieldData"), pydantic.Field(alias="fieldData") + ] + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/single_locale_created_payload_field_data.py b/src/webflow/types/single_locale_created_payload_field_data.py new file mode 100644 index 0000000..7306bc9 --- /dev/null +++ b/src/webflow/types/single_locale_created_payload_field_data.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class SingleLocaleCreatedPayloadFieldData(UniversalBaseModel): + name: str + slug: str + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/site.py b/src/webflow/types/site.py index 96f66a1..15a4826 100644 --- a/src/webflow/types/site.py +++ b/src/webflow/types/site.py @@ -1,15 +1,15 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel +import datetime as dt +import typing + import pydantic import typing_extensions -import typing +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -import datetime as dt from .domain import Domain from .locales import Locales from .site_data_collection_type import SiteDataCollectionType -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class Site(UniversalBaseModel): @@ -18,86 +18,69 @@ class Site(UniversalBaseModel): Unique identifier for the Site """ - workspace_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="workspaceId")] = ( - pydantic.Field(default=None) - ) - """ - Unique identifier for the Workspace - """ - - created_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdOn")] = ( - pydantic.Field(default=None) - ) - """ - Date the Site was created - """ - - display_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="displayName")] = ( - pydantic.Field(default=None) - ) - """ - Name given to Site - """ - - short_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="shortName")] = pydantic.Field( - default=None - ) - """ - Slugified version of name - """ - - last_published: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastPublished")] = ( - pydantic.Field(default=None) - ) - """ - Date the Site was last published - """ - - last_updated: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastUpdated")] = ( - pydantic.Field(default=None) - ) - """ - Date the Site was last updated - """ - - preview_url: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="previewUrl")] = pydantic.Field( - default=None - ) - """ - URL of a generated image for the given Site - """ - - time_zone: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="timeZone")] = pydantic.Field( - default=None - ) - """ - Site timezone set under Site Settings - """ - - parent_folder_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="parentFolderId")] = ( - pydantic.Field(default=None) - ) - """ - The ID of the parent folder the Site exists in - """ - + workspace_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="workspaceId"), + pydantic.Field(alias="workspaceId", description="Unique identifier for the Workspace"), + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="Date the Site was created"), + ] = None + display_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="displayName"), + pydantic.Field(alias="displayName", description="Name given to Site"), + ] = None + short_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="shortName"), + pydantic.Field(alias="shortName", description="Slugified version of name"), + ] = None + last_published: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="lastPublished"), + pydantic.Field(alias="lastPublished", description="Date the Site was last published"), + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="Date the Site was last updated"), + ] = None + preview_url: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="previewUrl"), + pydantic.Field(alias="previewUrl", description="URL of a generated image for the given Site"), + ] = None + time_zone: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="timeZone"), + pydantic.Field(alias="timeZone", description="Site timezone set under Site Settings"), + ] = None + parent_folder_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="parentFolderId"), + pydantic.Field(alias="parentFolderId", description="The ID of the parent folder the Site exists in"), + ] = None custom_domains: typing_extensions.Annotated[ - typing.Optional[typing.List[Domain]], FieldMetadata(alias="customDomains") + typing.Optional[typing.List[Domain]], + FieldMetadata(alias="customDomains"), + pydantic.Field(alias="customDomains"), ] = None locales: typing.Optional[Locales] = None data_collection_enabled: typing_extensions.Annotated[ - typing.Optional[bool], FieldMetadata(alias="dataCollectionEnabled") - ] = pydantic.Field(default=None) - """ - Indicates if data collection is enabled for the site. - """ - + typing.Optional[bool], + FieldMetadata(alias="dataCollectionEnabled"), + pydantic.Field( + alias="dataCollectionEnabled", description="Indicates if data collection is enabled for the site." + ), + ] = None data_collection_type: typing_extensions.Annotated[ - typing.Optional[SiteDataCollectionType], FieldMetadata(alias="dataCollectionType") - ] = pydantic.Field(default=None) - """ - The type of data collection enabled for the site. - """ + typing.Optional[SiteDataCollectionType], + FieldMetadata(alias="dataCollectionType"), + pydantic.Field(alias="dataCollectionType", description="The type of data collection enabled for the site."), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/site_activity_log_item.py b/src/webflow/types/site_activity_log_item.py index 0ad70ea..cc07cef 100644 --- a/src/webflow/types/site_activity_log_item.py +++ b/src/webflow/types/site_activity_log_item.py @@ -1,31 +1,45 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel +import datetime as dt import typing + +import pydantic import typing_extensions -import datetime as dt +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata from .site_activity_log_item_event import SiteActivityLogItemEvent from .site_activity_log_item_resource_operation import SiteActivityLogItemResourceOperation from .site_activity_log_item_user import SiteActivityLogItemUser -from ..core.pydantic_utilities import IS_PYDANTIC_V2 -import pydantic class SiteActivityLogItem(UniversalBaseModel): id: typing.Optional[str] = None - created_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdOn")] = None - last_updated: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastUpdated")] = None + created_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], FieldMetadata(alias="createdOn"), pydantic.Field(alias="createdOn") + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[dt.datetime], FieldMetadata(alias="lastUpdated"), pydantic.Field(alias="lastUpdated") + ] = None event: typing.Optional[SiteActivityLogItemEvent] = None resource_operation: typing_extensions.Annotated[ - typing.Optional[SiteActivityLogItemResourceOperation], FieldMetadata(alias="resourceOperation") + typing.Optional[SiteActivityLogItemResourceOperation], + FieldMetadata(alias="resourceOperation"), + pydantic.Field(alias="resourceOperation"), ] = None user: typing.Optional[SiteActivityLogItemUser] = None - resource_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="resourceId")] = None - resource_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="resourceName")] = None - new_value: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="newValue")] = None - previous_value: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="previousValue")] = None - payload: typing.Optional[typing.Dict[str, typing.Optional[typing.Any]]] = None + resource_id: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="resourceId"), pydantic.Field(alias="resourceId") + ] = None + resource_name: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="resourceName"), pydantic.Field(alias="resourceName") + ] = None + new_value: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="newValue"), pydantic.Field(alias="newValue") + ] = None + previous_value: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="previousValue"), pydantic.Field(alias="previousValue") + ] = None + payload: typing.Optional[typing.Dict[str, typing.Any]] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/site_activity_log_item_user.py b/src/webflow/types/site_activity_log_item_user.py index b372c65..82457cc 100644 --- a/src/webflow/types/site_activity_log_item_user.py +++ b/src/webflow/types/site_activity_log_item_user.py @@ -1,16 +1,18 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + +import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -from ..core.pydantic_utilities import IS_PYDANTIC_V2 -import pydantic class SiteActivityLogItemUser(UniversalBaseModel): id: typing.Optional[str] = None - display_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="displayName")] = None + display_name: typing_extensions.Annotated[ + typing.Optional[str], FieldMetadata(alias="displayName"), pydantic.Field(alias="displayName") + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/site_activity_log_response.py b/src/webflow/types/site_activity_log_response.py index 32606a7..5d0cb51 100644 --- a/src/webflow/types/site_activity_log_response.py +++ b/src/webflow/types/site_activity_log_response.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing -from .site_activity_log_item import SiteActivityLogItem -from .pagination import Pagination -from ..core.pydantic_utilities import IS_PYDANTIC_V2 + import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .pagination import Pagination +from .site_activity_log_item import SiteActivityLogItem class SiteActivityLogResponse(UniversalBaseModel): diff --git a/src/webflow/types/site_membership.py b/src/webflow/types/site_membership.py new file mode 100644 index 0000000..b9def86 --- /dev/null +++ b/src/webflow/types/site_membership.py @@ -0,0 +1,58 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .workspace_audit_log_item_payload_site_membership_granular_access import ( + WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess, +) +from .workspace_audit_log_item_payload_site_membership_method import WorkspaceAuditLogItemPayloadSiteMembershipMethod +from .workspace_audit_log_item_payload_site_membership_site import WorkspaceAuditLogItemPayloadSiteMembershipSite +from .workspace_audit_log_item_payload_site_membership_target_user import ( + WorkspaceAuditLogItemPayloadSiteMembershipTargetUser, +) +from .workspace_audit_log_item_payload_site_membership_user_type import ( + WorkspaceAuditLogItemPayloadSiteMembershipUserType, +) + + +class SiteMembership(UniversalBaseModel): + site: typing.Optional[WorkspaceAuditLogItemPayloadSiteMembershipSite] = None + target_user: typing_extensions.Annotated[ + typing.Optional[WorkspaceAuditLogItemPayloadSiteMembershipTargetUser], + FieldMetadata(alias="targetUser"), + pydantic.Field(alias="targetUser"), + ] = None + method: typing.Optional[WorkspaceAuditLogItemPayloadSiteMembershipMethod] = None + user_type: typing_extensions.Annotated[ + typing.Optional[WorkspaceAuditLogItemPayloadSiteMembershipUserType], + FieldMetadata(alias="userType"), + pydantic.Field(alias="userType"), + ] = None + role_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="roleName"), + pydantic.Field(alias="roleName", description="The name of the role that was assigned to the user"), + ] = None + previous_role_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="previousRoleName"), + pydantic.Field(alias="previousRoleName", description="The previous role that the user had"), + ] = None + granular_access: typing_extensions.Annotated[ + typing.Optional[WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess], + FieldMetadata(alias="granularAccess"), + pydantic.Field(alias="granularAccess"), + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/site_membership_audit_log_item.py b/src/webflow/types/site_membership_audit_log_item.py new file mode 100644 index 0000000..6bb4bc5 --- /dev/null +++ b/src/webflow/types/site_membership_audit_log_item.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .site_membership import SiteMembership +from .site_membership_audit_log_item_event_sub_type import SiteMembershipAuditLogItemEventSubType + + +class SiteMembershipAuditLogItem(UniversalBaseModel): + event_sub_type: typing_extensions.Annotated[ + typing.Optional[SiteMembershipAuditLogItemEventSubType], + FieldMetadata(alias="eventSubType"), + pydantic.Field(alias="eventSubType"), + ] = None + payload: typing.Optional[SiteMembership] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/site_membership_audit_log_item_event_sub_type.py b/src/webflow/types/site_membership_audit_log_item_event_sub_type.py new file mode 100644 index 0000000..ff26017 --- /dev/null +++ b/src/webflow/types/site_membership_audit_log_item_event_sub_type.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +SiteMembershipAuditLogItemEventSubType = typing.Union[ + typing.Literal["user_added", "user_removed", "user_role_updated", "user_granular_access_updated"], typing.Any +] diff --git a/src/webflow/types/site_plan.py b/src/webflow/types/site_plan.py index a8feecc..f008979 100644 --- a/src/webflow/types/site_plan.py +++ b/src/webflow/types/site_plan.py @@ -1,13 +1,13 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing -from .site_plan_id import SitePlanId + import pydantic -from .site_plan_name import SitePlanName import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from .site_plan_id import SitePlanId +from .site_plan_name import SitePlanName class SitePlan(UniversalBaseModel): @@ -21,12 +21,11 @@ class SitePlan(UniversalBaseModel): Name of the hosting plan. """ - pricing_info: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="pricingInfo")] = ( - pydantic.Field(default=None) - ) - """ - URL for more information about Webflow hosting plan pricing. - """ + pricing_info: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="pricingInfo"), + pydantic.Field(alias="pricingInfo", description="URL for more information about Webflow hosting plan pricing."), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/site_publish.py b/src/webflow/types/site_publish.py new file mode 100644 index 0000000..0e94156 --- /dev/null +++ b/src/webflow/types/site_publish.py @@ -0,0 +1,34 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .site_publish_payload import SitePublishPayload + + +class SitePublish(UniversalBaseModel): + """ + The Webhook payload for when a Site is published + """ + + trigger_type: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="triggerType"), + pydantic.Field(alias="triggerType", description="The type of event that triggered the request"), + ] = None + payload: typing.Optional[SitePublishPayload] = pydantic.Field(default=None) + """ + The payload of data sent from Webflow + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/site_publish_payload.py b/src/webflow/types/site_publish_payload.py new file mode 100644 index 0000000..3e61145 --- /dev/null +++ b/src/webflow/types/site_publish_payload.py @@ -0,0 +1,45 @@ +# This file was auto-generated by Fern from our API Definition. + +import datetime as dt +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata + + +class SitePublishPayload(UniversalBaseModel): + """ + The payload of data sent from Webflow + """ + + site_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="siteId"), + pydantic.Field(alias="siteId", description="The ID of the site that was published"), + ] = None + published_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="publishedOn"), + pydantic.Field(alias="publishedOn", description="The timestamp of the publish event"), + ] = None + domains: typing.Optional[typing.List[str]] = pydantic.Field(default=None) + """ + The domains that were published + """ + + published_by: typing_extensions.Annotated[ + typing.Optional[typing.Dict[str, typing.Any]], + FieldMetadata(alias="publishedBy"), + pydantic.Field(alias="publishedBy", description="The name andID of the user who published the site"), + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/sites.py b/src/webflow/types/sites.py index d293ce2..f71410b 100644 --- a/src/webflow/types/sites.py +++ b/src/webflow/types/sites.py @@ -1,10 +1,10 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing -from .site import Site -from ..core.pydantic_utilities import IS_PYDANTIC_V2 + import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .site import Site class Sites(UniversalBaseModel): diff --git a/src/webflow/types/sku.py b/src/webflow/types/sku.py index 79f159a..f02c4c9 100644 --- a/src/webflow/types/sku.py +++ b/src/webflow/types/sku.py @@ -1,13 +1,13 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel +import datetime as dt import typing + import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -import datetime as dt from .sku_field_data import SkuFieldData -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class Sku(UniversalBaseModel): @@ -20,35 +20,29 @@ class Sku(UniversalBaseModel): Unique identifier for the Product """ - cms_locale_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="cmsLocaleId")] = ( - pydantic.Field(default=None) - ) - """ - Identifier for the locale of the CMS item - """ - - last_published: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastPublished")] = ( - pydantic.Field(default=None) - ) - """ - The date the Product was last published - """ - - last_updated: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastUpdated")] = ( - pydantic.Field(default=None) - ) - """ - The date the Product was last updated - """ - - created_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdOn")] = ( - pydantic.Field(default=None) - ) - """ - The date the Product was created - """ - - field_data: typing_extensions.Annotated[typing.Optional[SkuFieldData], FieldMetadata(alias="fieldData")] = None + cms_locale_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="cmsLocaleId"), + pydantic.Field(alias="cmsLocaleId", description="Identifier for the locale of the CMS item"), + ] = None + last_published: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="lastPublished"), + pydantic.Field(alias="lastPublished", description="The date the Product was last published"), + ] = None + last_updated: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="lastUpdated"), + pydantic.Field(alias="lastUpdated", description="The date the Product was last updated"), + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="The date the Product was created"), + ] = None + field_data: typing_extensions.Annotated[ + typing.Optional[SkuFieldData], FieldMetadata(alias="fieldData"), pydantic.Field(alias="fieldData") + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/sku_field_data.py b/src/webflow/types/sku_field_data.py index e20efdb..7cfb6df 100644 --- a/src/webflow/types/sku_field_data.py +++ b/src/webflow/types/sku_field_data.py @@ -1,16 +1,17 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions import typing -from .sku_value_list import SkuValueList -from ..core.serialization import FieldMetadata + import pydantic -from .sku_field_data_price import SkuFieldDataPrice +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata from .sku_field_data_compare_at_price import SkuFieldDataCompareAtPrice from .sku_field_data_ec_sku_billing_method import SkuFieldDataEcSkuBillingMethod from .sku_field_data_ec_sku_subscription_plan import SkuFieldDataEcSkuSubscriptionPlan -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from .sku_field_data_price import SkuFieldDataPrice +from .sku_property_list import SkuPropertyList +from .sku_value_list import SkuValueList class SkuFieldData(UniversalBaseModel): @@ -18,7 +19,9 @@ class SkuFieldData(UniversalBaseModel): Standard and Custom fields for a SKU """ - sku_values: typing_extensions.Annotated[typing.Optional[SkuValueList], FieldMetadata(alias="sku-values")] = None + sku_values: typing_extensions.Annotated[ + typing.Optional[SkuValueList], FieldMetadata(alias="sku-values"), pydantic.Field(alias="sku-values") + ] = None name: str = pydantic.Field() """ Name of the Product @@ -35,29 +38,41 @@ class SkuFieldData(UniversalBaseModel): """ compare_at_price: typing_extensions.Annotated[ - typing.Optional[SkuFieldDataCompareAtPrice], FieldMetadata(alias="compare-at-price") - ] = pydantic.Field(default=None) - """ - comparison price of SKU - """ - + typing.Optional[SkuFieldDataCompareAtPrice], + FieldMetadata(alias="compare-at-price"), + pydantic.Field(alias="compare-at-price", description="comparison price of SKU"), + ] = None ec_sku_billing_method: typing_extensions.Annotated[ - typing.Optional[SkuFieldDataEcSkuBillingMethod], FieldMetadata(alias="ec-sku-billing-method") + typing.Optional[SkuFieldDataEcSkuBillingMethod], + FieldMetadata(alias="ec-sku-billing-method"), + pydantic.Field( + alias="ec-sku-billing-method", + description="[Billing method](https://help.webflow.com/hc/en-us/articles/33961432087955-Add-and-manage-products-and-categories#billing-methods)for the SKU", + ), ] = None ec_sku_subscription_plan: typing_extensions.Annotated[ - typing.Optional[SkuFieldDataEcSkuSubscriptionPlan], FieldMetadata(alias="ec-sku-subscription-plan") + typing.Optional[SkuFieldDataEcSkuSubscriptionPlan], + FieldMetadata(alias="ec-sku-subscription-plan"), + pydantic.Field( + alias="ec-sku-subscription-plan", + description="[Subscription plan](https://help.webflow.com/hc/en-us/articles/33961432087955-Add-and-manage-products-and-categories#subscription) for the SKU", + ), ] = None - track_inventory: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="track-inventory")] = ( - pydantic.Field(default=None) - ) + main_image: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="main-image"), + pydantic.Field(alias="main-image", description="The URL for the main image of the SKU"), + ] = None + sku: typing.Optional[str] = pydantic.Field(default=None) """ - A boolean indicating whether inventory for this product should be tracked. + A unique identifier for the SKU """ - quantity: typing.Optional[float] = pydantic.Field(default=None) - """ - Quantity of SKU that will be tracked as items are ordered. - """ + sku_properties: typing_extensions.Annotated[ + typing.Optional[typing.List[SkuPropertyList]], + FieldMetadata(alias="sku-properties"), + pydantic.Field(alias="sku-properties", description="The properties of the SKU"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/sku_field_data_compare_at_price.py b/src/webflow/types/sku_field_data_compare_at_price.py index 6b2347f..ba520de 100644 --- a/src/webflow/types/sku_field_data_compare_at_price.py +++ b/src/webflow/types/sku_field_data_compare_at_price.py @@ -1,9 +1,9 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel class SkuFieldDataCompareAtPrice(UniversalBaseModel): diff --git a/src/webflow/types/sku_field_data_ec_sku_subscription_plan.py b/src/webflow/types/sku_field_data_ec_sku_subscription_plan.py index 24c85a7..30f60bc 100644 --- a/src/webflow/types/sku_field_data_ec_sku_subscription_plan.py +++ b/src/webflow/types/sku_field_data_ec_sku_subscription_plan.py @@ -1,14 +1,18 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing -from .sku_field_data_ec_sku_subscription_plan_interval import SkuFieldDataEcSkuSubscriptionPlanInterval + import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .sku_field_data_ec_sku_subscription_plan_interval import SkuFieldDataEcSkuSubscriptionPlanInterval from .sku_field_data_ec_sku_subscription_plan_plans_item import SkuFieldDataEcSkuSubscriptionPlanPlansItem -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class SkuFieldDataEcSkuSubscriptionPlan(UniversalBaseModel): + """ + [Subscription plan](https://help.webflow.com/hc/en-us/articles/33961432087955-Add-and-manage-products-and-categories#subscription) for the SKU + """ + interval: typing.Optional[SkuFieldDataEcSkuSubscriptionPlanInterval] = pydantic.Field(default=None) """ Interval of subscription renewal diff --git a/src/webflow/types/sku_field_data_ec_sku_subscription_plan_plans_item.py b/src/webflow/types/sku_field_data_ec_sku_subscription_plan_plans_item.py index 714642e..0b7c397 100644 --- a/src/webflow/types/sku_field_data_ec_sku_subscription_plan_plans_item.py +++ b/src/webflow/types/sku_field_data_ec_sku_subscription_plan_plans_item.py @@ -1,10 +1,10 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from .sku_field_data_ec_sku_subscription_plan_plans_item_status import SkuFieldDataEcSkuSubscriptionPlanPlansItemStatus -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class SkuFieldDataEcSkuSubscriptionPlanPlansItem(UniversalBaseModel): diff --git a/src/webflow/types/sku_field_data_price.py b/src/webflow/types/sku_field_data_price.py index 45ff611..17940d7 100644 --- a/src/webflow/types/sku_field_data_price.py +++ b/src/webflow/types/sku_field_data_price.py @@ -1,9 +1,9 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel class SkuFieldDataPrice(UniversalBaseModel): @@ -21,6 +21,11 @@ class SkuFieldDataPrice(UniversalBaseModel): Currency of Item """ + currency: typing.Optional[str] = pydantic.Field(default=None) + """ + Currency of Item (alternative representation) + """ + if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 else: diff --git a/src/webflow/types/sku_property_list.py b/src/webflow/types/sku_property_list.py index f4e0862..3602aa4 100644 --- a/src/webflow/types/sku_property_list.py +++ b/src/webflow/types/sku_property_list.py @@ -1,10 +1,10 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import pydantic import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from .sku_property_list_enum_item import SkuPropertyListEnumItem -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class SkuPropertyList(UniversalBaseModel): diff --git a/src/webflow/types/sku_property_list_enum_item.py b/src/webflow/types/sku_property_list_enum_item.py index f35e6d0..2666581 100644 --- a/src/webflow/types/sku_property_list_enum_item.py +++ b/src/webflow/types/sku_property_list_enum_item.py @@ -1,10 +1,10 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 import typing +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + class SkuPropertyListEnumItem(UniversalBaseModel): """ diff --git a/src/webflow/types/static_field.py b/src/webflow/types/static_field.py new file mode 100644 index 0000000..714dc5d --- /dev/null +++ b/src/webflow/types/static_field.py @@ -0,0 +1,49 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .static_field_type import StaticFieldType + + +class StaticField(UniversalBaseModel): + id: typing.Optional[str] = pydantic.Field(default=None) + """ + Unique identifier for a Field + """ + + is_editable: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="isEditable"), + pydantic.Field(alias="isEditable", description="Define whether the field is editable"), + ] = None + is_required: typing_extensions.Annotated[ + typing.Optional[bool], + FieldMetadata(alias="isRequired"), + pydantic.Field(alias="isRequired", description="define whether a field is required in a collection"), + ] = None + type: StaticFieldType = pydantic.Field() + """ + Choose these appropriate field type for your collection data + """ + + display_name: typing_extensions.Annotated[ + str, FieldMetadata(alias="displayName"), pydantic.Field(alias="displayName", description="The name of a field") + ] + help_text: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="helpText"), + pydantic.Field(alias="helpText", description="Additional text to help anyone filling out this field"), + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/resources/collections/resources/fields/types/field_create_type.py b/src/webflow/types/static_field_type.py similarity index 82% rename from src/webflow/resources/collections/resources/fields/types/field_create_type.py rename to src/webflow/types/static_field_type.py index c8ec44b..e7cadf0 100644 --- a/src/webflow/resources/collections/resources/fields/types/field_create_type.py +++ b/src/webflow/types/static_field_type.py @@ -2,12 +2,11 @@ import typing -FieldCreateType = typing.Union[ +StaticFieldType = typing.Union[ typing.Literal[ "Color", "DateTime", "Email", - "ExtFileRef", "File", "Image", "Link", @@ -17,7 +16,7 @@ "PlainText", "RichText", "Switch", - "Video", + "VideoLink", ], typing.Any, ] diff --git a/src/webflow/types/stripe_card.py b/src/webflow/types/stripe_card.py index ccc45ae..55580d9 100644 --- a/src/webflow/types/stripe_card.py +++ b/src/webflow/types/stripe_card.py @@ -1,13 +1,13 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions import typing -from ..core.serialization import FieldMetadata + import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata from .stripe_card_brand import StripeCardBrand from .stripe_card_expires import StripeCardExpires -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class StripeCard(UniversalBaseModel): @@ -15,25 +15,21 @@ class StripeCard(UniversalBaseModel): Details on the card used to fulfill this order, if this order was finalized with Stripe. """ - last_4: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="last4")] = pydantic.Field( - default=None - ) - """ - The last 4 digits on the card as a string - """ - + last_4: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="last4"), + pydantic.Field(alias="last4", description="The last 4 digits on the card as a string"), + ] = None brand: typing.Optional[StripeCardBrand] = pydantic.Field(default=None) """ The card's brand (ie. credit card network) """ - owner_name: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="ownerName")] = pydantic.Field( - default=None - ) - """ - The name on the card. - """ - + owner_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="ownerName"), + pydantic.Field(alias="ownerName", description="The name on the card."), + ] = None expires: typing.Optional[StripeCardExpires] = pydantic.Field(default=None) """ The card's expiration date. diff --git a/src/webflow/types/stripe_card_expires.py b/src/webflow/types/stripe_card_expires.py index 3ce14d9..9cf529f 100644 --- a/src/webflow/types/stripe_card_expires.py +++ b/src/webflow/types/stripe_card_expires.py @@ -1,9 +1,9 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel class StripeCardExpires(UniversalBaseModel): diff --git a/src/webflow/types/stripe_details.py b/src/webflow/types/stripe_details.py index 9bd170a..acd103a 100644 --- a/src/webflow/types/stripe_details.py +++ b/src/webflow/types/stripe_details.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel -import typing_extensions import typing -from ..core.serialization import FieldMetadata + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata class StripeDetails(UniversalBaseModel): @@ -13,61 +13,48 @@ class StripeDetails(UniversalBaseModel): An object with various Stripe IDs, useful for linking into the stripe dashboard. """ - subscription_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="subscriptionId")] = ( - pydantic.Field(default=None) - ) - """ - Stripe-generated identifier for the Subscription - """ - - payment_method: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="paymentMethod")] = ( - pydantic.Field(default=None) - ) - """ - Stripe-generated identifier for the PaymentMethod used - """ - - payment_intent_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="paymentIntentId")] = ( - pydantic.Field(default=None) - ) - """ - Stripe-generated identifier for the PaymentIntent, or null - """ - - customer_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="customerId")] = pydantic.Field( - default=None - ) - """ - Stripe-generated customer identifier, or null - """ - - charge_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="chargeId")] = pydantic.Field( - default=None - ) - """ - Stripe-generated charge identifier, or null - """ - - dispute_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="disputeId")] = pydantic.Field( - default=None - ) - """ - Stripe-generated dispute identifier, or null - """ - - refund_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="refundId")] = pydantic.Field( - default=None - ) - """ - Stripe-generated refund identifier, or null - """ - - refund_reason: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="refundReason")] = ( - pydantic.Field(default=None) - ) - """ - Stripe-generated refund reason, or null - """ + subscription_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="subscriptionId"), + pydantic.Field(alias="subscriptionId", description="Stripe-generated identifier for the Subscription"), + ] = None + payment_method: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="paymentMethod"), + pydantic.Field(alias="paymentMethod", description="Stripe-generated identifier for the PaymentMethod used"), + ] = None + payment_intent_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="paymentIntentId"), + pydantic.Field( + alias="paymentIntentId", description="Stripe-generated identifier for the PaymentIntent, or null" + ), + ] = None + customer_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="customerId"), + pydantic.Field(alias="customerId", description="Stripe-generated customer identifier, or null"), + ] = None + charge_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="chargeId"), + pydantic.Field(alias="chargeId", description="Stripe-generated charge identifier, or null"), + ] = None + dispute_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="disputeId"), + pydantic.Field(alias="disputeId", description="Stripe-generated dispute identifier, or null"), + ] = None + refund_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="refundId"), + pydantic.Field(alias="refundId", description="Stripe-generated refund identifier, or null"), + ] = None + refund_reason: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="refundReason"), + pydantic.Field(alias="refundReason", description="Stripe-generated refund reason, or null"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/submit_button_node.py b/src/webflow/types/submit_button_node.py new file mode 100644 index 0000000..7dc8c94 --- /dev/null +++ b/src/webflow/types/submit_button_node.py @@ -0,0 +1,43 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata + + +class SubmitButtonNode(UniversalBaseModel): + """ + Represents submit button elements within the DOM. It contains the text and waiting text of the button. Additional attributes can be associated with the text for styling or other purposes. + """ + + id: str = pydantic.Field() + """ + Node UUID + """ + + value: str = pydantic.Field() + """ + The text content of the submit button. + """ + + waiting_text: typing_extensions.Annotated[ + str, + FieldMetadata(alias="waitingText"), + pydantic.Field(alias="waitingText", description="The text to show while the form is submitting."), + ] + attributes: typing.Optional[typing.Dict[str, str]] = pydantic.Field(default=None) + """ + The custom attributes of the node + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/submit_button_node_write.py b/src/webflow/types/submit_button_node_write.py new file mode 100644 index 0000000..a3066da --- /dev/null +++ b/src/webflow/types/submit_button_node_write.py @@ -0,0 +1,37 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata + + +class SubmitButtonNodeWrite(UniversalBaseModel): + """ + Update a submit button node + """ + + node_id: typing_extensions.Annotated[ + str, FieldMetadata(alias="nodeId"), pydantic.Field(alias="nodeId", description="Node UUID") + ] + value: typing.Optional[str] = pydantic.Field(default=None) + """ + The text content of the submit button. + """ + + waiting_text: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="waitingText"), + pydantic.Field(alias="waitingText", description="The text to show while the form is submitting."), + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/text.py b/src/webflow/types/text.py index 18f8501..337db7c 100644 --- a/src/webflow/types/text.py +++ b/src/webflow/types/text.py @@ -1,12 +1,16 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel class Text(UniversalBaseModel): + """ + The text content of the node + """ + html: typing.Optional[str] = pydantic.Field(default=None) """ The HTML content of the text node. diff --git a/src/webflow/types/text_input_node.py b/src/webflow/types/text_input_node.py new file mode 100644 index 0000000..e884b3c --- /dev/null +++ b/src/webflow/types/text_input_node.py @@ -0,0 +1,36 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class TextInputNode(UniversalBaseModel): + """ + Represents text input and textarea elements within the DOM. It contains the placeholder text in the input. Additional attributes can be associated with the text for styling or other purposes. + """ + + id: str = pydantic.Field() + """ + Node UUID + """ + + placeholder: str = pydantic.Field() + """ + The placeholder text of the input node + """ + + attributes: typing.Optional[typing.Dict[str, str]] = pydantic.Field(default=None) + """ + The custom attributes of the node + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/text_input_node_write.py b/src/webflow/types/text_input_node_write.py new file mode 100644 index 0000000..12515e9 --- /dev/null +++ b/src/webflow/types/text_input_node_write.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata + + +class TextInputNodeWrite(UniversalBaseModel): + """ + Update placeholder text on a text input node + """ + + node_id: typing_extensions.Annotated[ + str, FieldMetadata(alias="nodeId"), pydantic.Field(alias="nodeId", description="Node UUID") + ] + placeholder: str = pydantic.Field() + """ + The placeholder text of the input node + """ + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/text_node.py b/src/webflow/types/text_node.py index 1e16717..c8fea4b 100644 --- a/src/webflow/types/text_node.py +++ b/src/webflow/types/text_node.py @@ -1,10 +1,10 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from .text_node_text import TextNodeText -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class TextNode(UniversalBaseModel): @@ -12,12 +12,16 @@ class TextNode(UniversalBaseModel): Represents text content within the DOM. It contains both the raw text and its HTML representation. Additional attributes can be associated with the text for styling or other purposes. """ - id: typing.Optional[str] = pydantic.Field(default=None) + id: str = pydantic.Field() """ Node UUID """ - text: typing.Optional[TextNodeText] = None + text: TextNodeText = pydantic.Field() + """ + The text content of the node + """ + attributes: typing.Optional[typing.Dict[str, str]] = pydantic.Field(default=None) """ The custom attributes of the node diff --git a/src/webflow/types/text_node_text.py b/src/webflow/types/text_node_text.py index 895dc0b..106d502 100644 --- a/src/webflow/types/text_node_text.py +++ b/src/webflow/types/text_node_text.py @@ -1,12 +1,16 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel class TextNodeText(UniversalBaseModel): + """ + The text content of the node + """ + html: typing.Optional[str] = pydantic.Field(default=None) """ The HTML content of the text node. diff --git a/src/webflow/types/text_node_write.py b/src/webflow/types/text_node_write.py index a16c800..b8ef694 100644 --- a/src/webflow/types/text_node_write.py +++ b/src/webflow/types/text_node_write.py @@ -1,11 +1,11 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel +import typing + +import pydantic import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata -import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 -import typing class TextNodeWrite(UniversalBaseModel): @@ -13,11 +13,9 @@ class TextNodeWrite(UniversalBaseModel): Update a text node """ - node_id: typing_extensions.Annotated[str, FieldMetadata(alias="nodeId")] = pydantic.Field() - """ - Node UUID - """ - + node_id: typing_extensions.Annotated[ + str, FieldMetadata(alias="nodeId"), pydantic.Field(alias="nodeId", description="Node UUID") + ] text: str = pydantic.Field() """ HTML content of the node, including the HTML tag. The HTML tags must be the same as what's returned from the Get Content endpoint. diff --git a/src/webflow/types/trigger_type.py b/src/webflow/types/trigger_type.py index e12b650..5b9e821 100644 --- a/src/webflow/types/trigger_type.py +++ b/src/webflow/types/trigger_type.py @@ -12,13 +12,12 @@ "ecomm_new_order", "ecomm_order_changed", "ecomm_inventory_changed", - "user_account_added", - "user_account_updated", - "user_account_deleted", "collection_item_created", "collection_item_changed", "collection_item_deleted", + "collection_item_published", "collection_item_unpublished", + "comment_created", ], typing.Any, ] diff --git a/src/webflow/types/updated_order.py b/src/webflow/types/updated_order.py new file mode 100644 index 0000000..08d0687 --- /dev/null +++ b/src/webflow/types/updated_order.py @@ -0,0 +1,31 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .order import Order + + +class UpdatedOrder(UniversalBaseModel): + """ + The Webhook payload for when an order is updated + """ + + trigger_type: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="triggerType"), + pydantic.Field(alias="triggerType", description="The type of event that triggered the request"), + ] = None + payload: typing.Optional[Order] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/user.py b/src/webflow/types/user.py deleted file mode 100644 index a27a063..0000000 --- a/src/webflow/types/user.py +++ /dev/null @@ -1,81 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from ..core.pydantic_utilities import UniversalBaseModel -import typing -import pydantic -import typing_extensions -from ..core.serialization import FieldMetadata -import datetime as dt -from .user_status import UserStatus -from .user_access_groups_item import UserAccessGroupsItem -from .user_data import UserData -from ..core.pydantic_utilities import IS_PYDANTIC_V2 - - -class User(UniversalBaseModel): - """ - The fields that define the schema for a given Item are based on the Collection that Item belongs to. Beyond the user defined fields, there are a handful of additional fields that are automatically created for all items - """ - - id: typing.Optional[str] = pydantic.Field(default=None) - """ - Unique identifier for the User - """ - - is_email_verified: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="isEmailVerified")] = ( - pydantic.Field(default=None) - ) - """ - Shows whether the user has verified their email address - """ - - last_updated: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastUpdated")] = ( - pydantic.Field(default=None) - ) - """ - The timestamp the user was updated - """ - - invited_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="invitedOn")] = ( - pydantic.Field(default=None) - ) - """ - The timestamp the user was invited - """ - - created_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdOn")] = ( - pydantic.Field(default=None) - ) - """ - The timestamp the user was created - """ - - last_login: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastLogin")] = ( - pydantic.Field(default=None) - ) - """ - The timestamp the user was logged in - """ - - status: typing.Optional[UserStatus] = pydantic.Field(default=None) - """ - The status of the user - """ - - access_groups: typing_extensions.Annotated[ - typing.Optional[typing.List[UserAccessGroupsItem]], FieldMetadata(alias="accessGroups") - ] = pydantic.Field(default=None) - """ - Access groups the user belongs to - """ - - data: typing.Optional[UserData] = None - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow diff --git a/src/webflow/types/user_access.py b/src/webflow/types/user_access.py new file mode 100644 index 0000000..0851cd6 --- /dev/null +++ b/src/webflow/types/user_access.py @@ -0,0 +1,32 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .workspace_audit_log_item_payload_user_access_method import WorkspaceAuditLogItemPayloadUserAccessMethod + + +class UserAccess(UniversalBaseModel): + method: typing.Optional[WorkspaceAuditLogItemPayloadUserAccessMethod] = None + location: typing.Optional[str] = pydantic.Field(default=None) + """ + The geolocation based on the logged IP address + """ + + ip_address: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="ipAddress"), + pydantic.Field(alias="ipAddress", description="The captured IP address of the user"), + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/user_access_audit_log_item.py b/src/webflow/types/user_access_audit_log_item.py new file mode 100644 index 0000000..2d4d877 --- /dev/null +++ b/src/webflow/types/user_access_audit_log_item.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .user_access import UserAccess +from .user_access_audit_log_item_event_sub_type import UserAccessAuditLogItemEventSubType + + +class UserAccessAuditLogItem(UniversalBaseModel): + event_sub_type: typing_extensions.Annotated[ + typing.Optional[UserAccessAuditLogItemEventSubType], + FieldMetadata(alias="eventSubType"), + pydantic.Field(alias="eventSubType"), + ] = None + payload: typing.Optional[UserAccess] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/user_access_audit_log_item_event_sub_type.py b/src/webflow/types/user_access_audit_log_item_event_sub_type.py new file mode 100644 index 0000000..382f247 --- /dev/null +++ b/src/webflow/types/user_access_audit_log_item_event_sub_type.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +UserAccessAuditLogItemEventSubType = typing.Union[typing.Literal["login", "logout"], typing.Any] diff --git a/src/webflow/types/user_access_groups_item.py b/src/webflow/types/user_access_groups_item.py deleted file mode 100644 index 55ab6b3..0000000 --- a/src/webflow/types/user_access_groups_item.py +++ /dev/null @@ -1,34 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from ..core.pydantic_utilities import UniversalBaseModel -import typing -import pydantic -from .user_access_groups_item_type import UserAccessGroupsItemType -from ..core.pydantic_utilities import IS_PYDANTIC_V2 - - -class UserAccessGroupsItem(UniversalBaseModel): - """ - Access group slugs and types - """ - - slug: typing.Optional[str] = pydantic.Field(default=None) - """ - Access group identifier for APIs - """ - - type: typing.Optional[UserAccessGroupsItemType] = pydantic.Field(default=None) - """ - The type of access group based on how it was assigned to the user. - * `admin` - Assigned to the user via API or in the designer - * `ecommerce` - Assigned to the user via an ecommerce purchase - """ - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow diff --git a/src/webflow/types/user_access_groups_item_type.py b/src/webflow/types/user_access_groups_item_type.py deleted file mode 100644 index 8d9c81c..0000000 --- a/src/webflow/types/user_access_groups_item_type.py +++ /dev/null @@ -1,5 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -UserAccessGroupsItemType = typing.Union[typing.Literal["admin", "ecommerce"], typing.Any] diff --git a/src/webflow/types/user_data_data.py b/src/webflow/types/user_data_data.py deleted file mode 100644 index 7bbf36b..0000000 --- a/src/webflow/types/user_data_data.py +++ /dev/null @@ -1,50 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from ..core.pydantic_utilities import UniversalBaseModel -import typing -import pydantic -import typing_extensions -from ..core.serialization import FieldMetadata -from ..core.pydantic_utilities import IS_PYDANTIC_V2 - - -class UserDataData(UniversalBaseModel): - name: typing.Optional[str] = pydantic.Field(default=None) - """ - The name of the user - """ - - email: typing.Optional[str] = pydantic.Field(default=None) - """ - The email address of the user - """ - - accept_privacy: typing_extensions.Annotated[typing.Optional[bool], FieldMetadata(alias="accept-privacy")] = ( - pydantic.Field(default=None) - ) - """ - Boolean indicating if the user has accepted the privacy policy - """ - - accept_communications: typing_extensions.Annotated[ - typing.Optional[bool], FieldMetadata(alias="accept-communications") - ] = pydantic.Field(default=None) - """ - Boolean indicating if the user has accepted to receive communications - """ - - additional_properties: typing_extensions.Annotated[ - typing.Optional[str], FieldMetadata(alias="additionalProperties") - ] = pydantic.Field(default=None) - """ - Custom user attributes - """ - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow diff --git a/src/webflow/types/user_limit_reached.py b/src/webflow/types/user_limit_reached.py deleted file mode 100644 index 7f149c2..0000000 --- a/src/webflow/types/user_limit_reached.py +++ /dev/null @@ -1,5 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -UserLimitReached = typing.Optional[typing.Any] diff --git a/src/webflow/types/user_list.py b/src/webflow/types/user_list.py deleted file mode 100644 index b482d69..0000000 --- a/src/webflow/types/user_list.py +++ /dev/null @@ -1,47 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from ..core.pydantic_utilities import UniversalBaseModel -import typing -import pydantic -from .user import User -from ..core.pydantic_utilities import IS_PYDANTIC_V2 - - -class UserList(UniversalBaseModel): - """ - The list users results - """ - - count: typing.Optional[float] = pydantic.Field(default=None) - """ - Number of users returned - """ - - limit: typing.Optional[float] = pydantic.Field(default=None) - """ - The limit specified in the request - """ - - offset: typing.Optional[float] = pydantic.Field(default=None) - """ - The offset specified for pagination - """ - - total: typing.Optional[float] = pydantic.Field(default=None) - """ - Total number of users in the collection - """ - - users: typing.Optional[typing.List[User]] = pydantic.Field(default=None) - """ - List of Users for a Site - """ - - if IS_PYDANTIC_V2: - model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 - else: - - class Config: - frozen = True - smart_union = True - extra = pydantic.Extra.allow diff --git a/src/webflow/types/user_status.py b/src/webflow/types/user_status.py deleted file mode 100644 index 9a0147b..0000000 --- a/src/webflow/types/user_status.py +++ /dev/null @@ -1,5 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing - -UserStatus = typing.Union[typing.Literal["invited", "verified", "unverified"], typing.Any] diff --git a/src/webflow/types/webhook.py b/src/webflow/types/webhook.py index 226c94f..43f561a 100644 --- a/src/webflow/types/webhook.py +++ b/src/webflow/types/webhook.py @@ -1,14 +1,14 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel +import datetime as dt import typing + import pydantic import typing_extensions -from .trigger_type import TriggerType +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from ..core.serialization import FieldMetadata +from .trigger_type import TriggerType from .webhook_filter import WebhookFilter -import datetime as dt -from ..core.pydantic_utilities import IS_PYDANTIC_V2 class Webhook(UniversalBaseModel): @@ -17,44 +17,41 @@ class Webhook(UniversalBaseModel): Unique identifier for the Webhook registration """ - trigger_type: typing_extensions.Annotated[typing.Optional[TriggerType], FieldMetadata(alias="triggerType")] = None + trigger_type: typing_extensions.Annotated[ + typing.Optional[TriggerType], FieldMetadata(alias="triggerType"), pydantic.Field(alias="triggerType") + ] = None url: typing.Optional[str] = pydantic.Field(default=None) """ URL to send the Webhook payload to """ - workspace_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="workspaceId")] = ( - pydantic.Field(default=None) - ) - """ - Unique identifier for the Workspace the Webhook is registered in - """ - - site_id: typing_extensions.Annotated[typing.Optional[str], FieldMetadata(alias="siteId")] = pydantic.Field( - default=None - ) - """ - Unique identifier for the Site the Webhook is registered in - """ - + workspace_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="workspaceId"), + pydantic.Field( + alias="workspaceId", description="Unique identifier for the Workspace the Webhook is registered in" + ), + ] = None + site_id: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="siteId"), + pydantic.Field(alias="siteId", description="Unique identifier for the Site the Webhook is registered in"), + ] = None filter: typing.Optional[WebhookFilter] = pydantic.Field(default=None) """ Only supported for the `form_submission` trigger type. Filter for the form you want Webhooks to be sent for. """ - last_triggered: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="lastTriggered")] = ( - pydantic.Field(default=None) - ) - """ - Date the Webhook instance was last triggered - """ - - created_on: typing_extensions.Annotated[typing.Optional[dt.datetime], FieldMetadata(alias="createdOn")] = ( - pydantic.Field(default=None) - ) - """ - Date the Webhook registration was created - """ + last_triggered: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="lastTriggered"), + pydantic.Field(alias="lastTriggered", description="Date the Webhook instance was last triggered"), + ] = None + created_on: typing_extensions.Annotated[ + typing.Optional[dt.datetime], + FieldMetadata(alias="createdOn"), + pydantic.Field(alias="createdOn", description="Date the Webhook registration was created"), + ] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/webhook_filter.py b/src/webflow/types/webhook_filter.py index ccffba5..2f47255 100644 --- a/src/webflow/types/webhook_filter.py +++ b/src/webflow/types/webhook_filter.py @@ -1,9 +1,9 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + import pydantic -from ..core.pydantic_utilities import IS_PYDANTIC_V2 +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel class WebhookFilter(UniversalBaseModel): diff --git a/src/webflow/types/webhook_list.py b/src/webflow/types/webhook_list.py index ea705c4..6d76207 100644 --- a/src/webflow/types/webhook_list.py +++ b/src/webflow/types/webhook_list.py @@ -1,16 +1,16 @@ # This file was auto-generated by Fern from our API Definition. -from ..core.pydantic_utilities import UniversalBaseModel import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel from .pagination import Pagination from .webhook import Webhook -from ..core.pydantic_utilities import IS_PYDANTIC_V2 -import pydantic class WebhookList(UniversalBaseModel): - pagination: typing.Optional[Pagination] = None webhooks: typing.Optional[typing.List[Webhook]] = None + pagination: typing.Optional[Pagination] = None if IS_PYDANTIC_V2: model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 diff --git a/src/webflow/types/workspace_audit_log_item.py b/src/webflow/types/workspace_audit_log_item.py new file mode 100644 index 0000000..7d3a3c5 --- /dev/null +++ b/src/webflow/types/workspace_audit_log_item.py @@ -0,0 +1,178 @@ +# This file was auto-generated by Fern from our API Definition. + +from __future__ import annotations + +import datetime as dt +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .custom_role import CustomRole +from .custom_role_audit_log_item_event_sub_type import CustomRoleAuditLogItemEventSubType +from .setting_change import SettingChange +from .site_membership import SiteMembership +from .site_membership_audit_log_item_event_sub_type import SiteMembershipAuditLogItemEventSubType +from .user_access import UserAccess +from .user_access_audit_log_item_event_sub_type import UserAccessAuditLogItemEventSubType +from .workspace_audit_log_item_actor import WorkspaceAuditLogItemActor +from .workspace_audit_log_item_workspace import WorkspaceAuditLogItemWorkspace +from .workspace_invitation import WorkspaceInvitation +from .workspace_invitation_audit_log_item_event_sub_type import WorkspaceInvitationAuditLogItemEventSubType +from .workspace_membership import WorkspaceMembership +from .workspace_membership_audit_log_item_event_sub_type import WorkspaceMembershipAuditLogItemEventSubType + + +class Base(UniversalBaseModel): + timestamp: typing.Optional[dt.datetime] = None + actor: typing.Optional[WorkspaceAuditLogItemActor] = None + workspace: typing.Optional[WorkspaceAuditLogItemWorkspace] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +class WorkspaceAuditLogItem_UserAccess(Base): + event_type: typing_extensions.Annotated[ + typing.Literal["user_access"], FieldMetadata(alias="eventType"), pydantic.Field(alias="eventType") + ] = "user_access" + event_sub_type: typing_extensions.Annotated[ + typing.Optional[UserAccessAuditLogItemEventSubType], + FieldMetadata(alias="eventSubType"), + pydantic.Field(alias="eventSubType"), + ] = None + payload: typing.Optional[UserAccess] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +class WorkspaceAuditLogItem_CustomRole(Base): + event_type: typing_extensions.Annotated[ + typing.Literal["custom_role"], FieldMetadata(alias="eventType"), pydantic.Field(alias="eventType") + ] = "custom_role" + event_sub_type: typing_extensions.Annotated[ + typing.Optional[CustomRoleAuditLogItemEventSubType], + FieldMetadata(alias="eventSubType"), + pydantic.Field(alias="eventSubType"), + ] = None + payload: typing.Optional[CustomRole] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +class WorkspaceAuditLogItem_WorkspaceMembership(Base): + event_type: typing_extensions.Annotated[ + typing.Literal["workspace_membership"], FieldMetadata(alias="eventType"), pydantic.Field(alias="eventType") + ] = "workspace_membership" + event_sub_type: typing_extensions.Annotated[ + typing.Optional[WorkspaceMembershipAuditLogItemEventSubType], + FieldMetadata(alias="eventSubType"), + pydantic.Field(alias="eventSubType"), + ] = None + payload: typing.Optional[WorkspaceMembership] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +class WorkspaceAuditLogItem_SiteMembership(Base): + event_type: typing_extensions.Annotated[ + typing.Literal["site_membership"], FieldMetadata(alias="eventType"), pydantic.Field(alias="eventType") + ] = "site_membership" + event_sub_type: typing_extensions.Annotated[ + typing.Optional[SiteMembershipAuditLogItemEventSubType], + FieldMetadata(alias="eventSubType"), + pydantic.Field(alias="eventSubType"), + ] = None + payload: typing.Optional[SiteMembership] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +class WorkspaceAuditLogItem_WorkspaceInvitation(Base): + event_type: typing_extensions.Annotated[ + typing.Literal["workspace_invitation"], FieldMetadata(alias="eventType"), pydantic.Field(alias="eventType") + ] = "workspace_invitation" + event_sub_type: typing_extensions.Annotated[ + typing.Optional[WorkspaceInvitationAuditLogItemEventSubType], + FieldMetadata(alias="eventSubType"), + pydantic.Field(alias="eventSubType"), + ] = None + payload: typing.Optional[WorkspaceInvitation] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +class WorkspaceAuditLogItem_WorkspaceSetting(Base): + event_type: typing_extensions.Annotated[ + typing.Literal["workspace_setting"], FieldMetadata(alias="eventType"), pydantic.Field(alias="eventType") + ] = "workspace_setting" + event_sub_type: typing_extensions.Annotated[ + typing.Optional[typing.Literal["setting_updated"]], + FieldMetadata(alias="eventSubType"), + pydantic.Field(alias="eventSubType"), + ] = None + payload: typing.Optional[SettingChange] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow + + +WorkspaceAuditLogItem = typing_extensions.Annotated[ + typing.Union[ + WorkspaceAuditLogItem_UserAccess, + WorkspaceAuditLogItem_CustomRole, + WorkspaceAuditLogItem_WorkspaceMembership, + WorkspaceAuditLogItem_SiteMembership, + WorkspaceAuditLogItem_WorkspaceInvitation, + WorkspaceAuditLogItem_WorkspaceSetting, + ], + pydantic.Field(discriminator="event_type"), +] diff --git a/src/webflow/types/workspace_audit_log_item_actor.py b/src/webflow/types/workspace_audit_log_item_actor.py new file mode 100644 index 0000000..ced7149 --- /dev/null +++ b/src/webflow/types/workspace_audit_log_item_actor.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class WorkspaceAuditLogItemActor(UniversalBaseModel): + id: typing.Optional[str] = None + email: typing.Optional[str] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/workspace_audit_log_item_payload_setting_change_method.py b/src/webflow/types/workspace_audit_log_item_payload_setting_change_method.py new file mode 100644 index 0000000..4b91759 --- /dev/null +++ b/src/webflow/types/workspace_audit_log_item_payload_setting_change_method.py @@ -0,0 +1,5 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +WorkspaceAuditLogItemPayloadSettingChangeMethod = typing.Union[typing.Literal["dashboard", "admin"], typing.Any] diff --git a/src/webflow/types/workspace_audit_log_item_payload_site_membership_granular_access.py b/src/webflow/types/workspace_audit_log_item_payload_site_membership_granular_access.py new file mode 100644 index 0000000..82f561d --- /dev/null +++ b/src/webflow/types/workspace_audit_log_item_payload_site_membership_granular_access.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class WorkspaceAuditLogItemPayloadSiteMembershipGranularAccess(UniversalBaseModel): + id: typing.Optional[str] = None + name: typing.Optional[str] = None + type: typing.Optional[typing.Literal["cms"]] = None + restricted: typing.Optional[bool] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/workspace_audit_log_item_payload_site_membership_method.py b/src/webflow/types/workspace_audit_log_item_payload_site_membership_method.py new file mode 100644 index 0000000..a13fbae --- /dev/null +++ b/src/webflow/types/workspace_audit_log_item_payload_site_membership_method.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +WorkspaceAuditLogItemPayloadSiteMembershipMethod = typing.Union[ + typing.Literal["sso", "invite", "scim", "dashboard", "admin", "access_request"], typing.Any +] diff --git a/src/webflow/types/workspace_audit_log_item_payload_site_membership_site.py b/src/webflow/types/workspace_audit_log_item_payload_site_membership_site.py new file mode 100644 index 0000000..bb6df69 --- /dev/null +++ b/src/webflow/types/workspace_audit_log_item_payload_site_membership_site.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class WorkspaceAuditLogItemPayloadSiteMembershipSite(UniversalBaseModel): + id: typing.Optional[str] = None + slug: typing.Optional[str] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/workspace_audit_log_item_payload_site_membership_target_user.py b/src/webflow/types/workspace_audit_log_item_payload_site_membership_target_user.py new file mode 100644 index 0000000..cf8e343 --- /dev/null +++ b/src/webflow/types/workspace_audit_log_item_payload_site_membership_target_user.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class WorkspaceAuditLogItemPayloadSiteMembershipTargetUser(UniversalBaseModel): + id: typing.Optional[str] = None + email: typing.Optional[str] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/workspace_audit_log_item_payload_site_membership_user_type.py b/src/webflow/types/workspace_audit_log_item_payload_site_membership_user_type.py new file mode 100644 index 0000000..47b5168 --- /dev/null +++ b/src/webflow/types/workspace_audit_log_item_payload_site_membership_user_type.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +WorkspaceAuditLogItemPayloadSiteMembershipUserType = typing.Union[ + typing.Literal["member", "guest", "reviewer", "client"], typing.Any +] diff --git a/src/webflow/types/workspace_audit_log_item_payload_user_access_method.py b/src/webflow/types/workspace_audit_log_item_payload_user_access_method.py new file mode 100644 index 0000000..5417cff --- /dev/null +++ b/src/webflow/types/workspace_audit_log_item_payload_user_access_method.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +WorkspaceAuditLogItemPayloadUserAccessMethod = typing.Union[ + typing.Literal["dashboard", "sso", "api", "google"], typing.Any +] diff --git a/src/webflow/types/workspace_audit_log_item_payload_workspace_invitation_method.py b/src/webflow/types/workspace_audit_log_item_payload_workspace_invitation_method.py new file mode 100644 index 0000000..79a3042 --- /dev/null +++ b/src/webflow/types/workspace_audit_log_item_payload_workspace_invitation_method.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +WorkspaceAuditLogItemPayloadWorkspaceInvitationMethod = typing.Union[ + typing.Literal["sso", "dashboard", "admin"], typing.Any +] diff --git a/src/webflow/types/workspace_audit_log_item_payload_workspace_invitation_target_user.py b/src/webflow/types/workspace_audit_log_item_payload_workspace_invitation_target_user.py new file mode 100644 index 0000000..9003721 --- /dev/null +++ b/src/webflow/types/workspace_audit_log_item_payload_workspace_invitation_target_user.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUser(UniversalBaseModel): + id: typing.Optional[str] = None + email: typing.Optional[str] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/workspace_audit_log_item_payload_workspace_invitation_target_users_item.py b/src/webflow/types/workspace_audit_log_item_payload_workspace_invitation_target_users_item.py new file mode 100644 index 0000000..c18c694 --- /dev/null +++ b/src/webflow/types/workspace_audit_log_item_payload_workspace_invitation_target_users_item.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUsersItem(UniversalBaseModel): + id: typing.Optional[str] = None + email: typing.Optional[str] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/workspace_audit_log_item_payload_workspace_invitation_user_type.py b/src/webflow/types/workspace_audit_log_item_payload_workspace_invitation_user_type.py new file mode 100644 index 0000000..980d3a9 --- /dev/null +++ b/src/webflow/types/workspace_audit_log_item_payload_workspace_invitation_user_type.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +WorkspaceAuditLogItemPayloadWorkspaceInvitationUserType = typing.Union[ + typing.Literal["member", "guest", "reviewer", "client"], typing.Any +] diff --git a/src/webflow/types/workspace_audit_log_item_payload_workspace_membership_method.py b/src/webflow/types/workspace_audit_log_item_payload_workspace_membership_method.py new file mode 100644 index 0000000..df8982f --- /dev/null +++ b/src/webflow/types/workspace_audit_log_item_payload_workspace_membership_method.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +WorkspaceAuditLogItemPayloadWorkspaceMembershipMethod = typing.Union[ + typing.Literal["sso", "dashboard", "admin", "access_request"], typing.Any +] diff --git a/src/webflow/types/workspace_audit_log_item_payload_workspace_membership_target_user.py b/src/webflow/types/workspace_audit_log_item_payload_workspace_membership_target_user.py new file mode 100644 index 0000000..b2adafa --- /dev/null +++ b/src/webflow/types/workspace_audit_log_item_payload_workspace_membership_target_user.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class WorkspaceAuditLogItemPayloadWorkspaceMembershipTargetUser(UniversalBaseModel): + id: typing.Optional[str] = None + email: typing.Optional[str] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/workspace_audit_log_item_payload_workspace_membership_user_type.py b/src/webflow/types/workspace_audit_log_item_payload_workspace_membership_user_type.py new file mode 100644 index 0000000..dad636f --- /dev/null +++ b/src/webflow/types/workspace_audit_log_item_payload_workspace_membership_user_type.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +WorkspaceAuditLogItemPayloadWorkspaceMembershipUserType = typing.Union[ + typing.Literal["member", "guest", "reviewer", "client"], typing.Any +] diff --git a/src/webflow/types/workspace_audit_log_item_workspace.py b/src/webflow/types/workspace_audit_log_item_workspace.py new file mode 100644 index 0000000..81c18ac --- /dev/null +++ b/src/webflow/types/workspace_audit_log_item_workspace.py @@ -0,0 +1,20 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel + + +class WorkspaceAuditLogItemWorkspace(UniversalBaseModel): + id: typing.Optional[str] = None + slug: typing.Optional[str] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/workspace_audit_log_response.py b/src/webflow/types/workspace_audit_log_response.py new file mode 100644 index 0000000..e31a69e --- /dev/null +++ b/src/webflow/types/workspace_audit_log_response.py @@ -0,0 +1,22 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from .pagination import Pagination +from .workspace_audit_log_item import WorkspaceAuditLogItem + + +class WorkspaceAuditLogResponse(UniversalBaseModel): + items: typing.Optional[typing.List[WorkspaceAuditLogItem]] = None + pagination: typing.Optional[Pagination] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/workspace_invitation.py b/src/webflow/types/workspace_invitation.py new file mode 100644 index 0000000..a8a99f5 --- /dev/null +++ b/src/webflow/types/workspace_invitation.py @@ -0,0 +1,58 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .workspace_audit_log_item_payload_workspace_invitation_method import ( + WorkspaceAuditLogItemPayloadWorkspaceInvitationMethod, +) +from .workspace_audit_log_item_payload_workspace_invitation_target_user import ( + WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUser, +) +from .workspace_audit_log_item_payload_workspace_invitation_target_users_item import ( + WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUsersItem, +) +from .workspace_audit_log_item_payload_workspace_invitation_user_type import ( + WorkspaceAuditLogItemPayloadWorkspaceInvitationUserType, +) + + +class WorkspaceInvitation(UniversalBaseModel): + target_user: typing_extensions.Annotated[ + typing.Optional[WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUser], + FieldMetadata(alias="targetUser"), + pydantic.Field(alias="targetUser"), + ] = None + method: typing.Optional[WorkspaceAuditLogItemPayloadWorkspaceInvitationMethod] = None + user_type: typing_extensions.Annotated[ + typing.Optional[WorkspaceAuditLogItemPayloadWorkspaceInvitationUserType], + FieldMetadata(alias="userType"), + pydantic.Field(alias="userType"), + ] = None + role_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="roleName"), + pydantic.Field(alias="roleName", description="The name of the role that was assigned to the user"), + ] = None + previous_role_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="previousRoleName"), + pydantic.Field(alias="previousRoleName", description="The previous role that the user had"), + ] = None + target_users: typing_extensions.Annotated[ + typing.Optional[typing.List[WorkspaceAuditLogItemPayloadWorkspaceInvitationTargetUsersItem]], + FieldMetadata(alias="targetUsers"), + pydantic.Field(alias="targetUsers"), + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/workspace_invitation_audit_log_item.py b/src/webflow/types/workspace_invitation_audit_log_item.py new file mode 100644 index 0000000..7b57c27 --- /dev/null +++ b/src/webflow/types/workspace_invitation_audit_log_item.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .workspace_invitation import WorkspaceInvitation +from .workspace_invitation_audit_log_item_event_sub_type import WorkspaceInvitationAuditLogItemEventSubType + + +class WorkspaceInvitationAuditLogItem(UniversalBaseModel): + event_sub_type: typing_extensions.Annotated[ + typing.Optional[WorkspaceInvitationAuditLogItemEventSubType], + FieldMetadata(alias="eventSubType"), + pydantic.Field(alias="eventSubType"), + ] = None + payload: typing.Optional[WorkspaceInvitation] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/workspace_invitation_audit_log_item_event_sub_type.py b/src/webflow/types/workspace_invitation_audit_log_item_event_sub_type.py new file mode 100644 index 0000000..07ccddb --- /dev/null +++ b/src/webflow/types/workspace_invitation_audit_log_item_event_sub_type.py @@ -0,0 +1,15 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +WorkspaceInvitationAuditLogItemEventSubType = typing.Union[ + typing.Literal[ + "invite_sent", + "invite_accepted", + "invite_updated", + "invite_canceled", + "invite_declined", + "access_request_accepted", + ], + typing.Any, +] diff --git a/src/webflow/types/workspace_membership.py b/src/webflow/types/workspace_membership.py new file mode 100644 index 0000000..b5996f7 --- /dev/null +++ b/src/webflow/types/workspace_membership.py @@ -0,0 +1,50 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .workspace_audit_log_item_payload_workspace_membership_method import ( + WorkspaceAuditLogItemPayloadWorkspaceMembershipMethod, +) +from .workspace_audit_log_item_payload_workspace_membership_target_user import ( + WorkspaceAuditLogItemPayloadWorkspaceMembershipTargetUser, +) +from .workspace_audit_log_item_payload_workspace_membership_user_type import ( + WorkspaceAuditLogItemPayloadWorkspaceMembershipUserType, +) + + +class WorkspaceMembership(UniversalBaseModel): + target_user: typing_extensions.Annotated[ + typing.Optional[WorkspaceAuditLogItemPayloadWorkspaceMembershipTargetUser], + FieldMetadata(alias="targetUser"), + pydantic.Field(alias="targetUser"), + ] = None + method: typing.Optional[WorkspaceAuditLogItemPayloadWorkspaceMembershipMethod] = None + user_type: typing_extensions.Annotated[ + typing.Optional[WorkspaceAuditLogItemPayloadWorkspaceMembershipUserType], + FieldMetadata(alias="userType"), + pydantic.Field(alias="userType"), + ] = None + role_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="roleName"), + pydantic.Field(alias="roleName", description="The name of the role that was assigned to the user"), + ] = None + previous_role_name: typing_extensions.Annotated[ + typing.Optional[str], + FieldMetadata(alias="previousRoleName"), + pydantic.Field(alias="previousRoleName", description="The previous role that the user had"), + ] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/workspace_membership_audit_log_item.py b/src/webflow/types/workspace_membership_audit_log_item.py new file mode 100644 index 0000000..20dab22 --- /dev/null +++ b/src/webflow/types/workspace_membership_audit_log_item.py @@ -0,0 +1,28 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +import pydantic +import typing_extensions +from ..core.pydantic_utilities import IS_PYDANTIC_V2, UniversalBaseModel +from ..core.serialization import FieldMetadata +from .workspace_membership import WorkspaceMembership +from .workspace_membership_audit_log_item_event_sub_type import WorkspaceMembershipAuditLogItemEventSubType + + +class WorkspaceMembershipAuditLogItem(UniversalBaseModel): + event_sub_type: typing_extensions.Annotated[ + typing.Optional[WorkspaceMembershipAuditLogItemEventSubType], + FieldMetadata(alias="eventSubType"), + pydantic.Field(alias="eventSubType"), + ] = None + payload: typing.Optional[WorkspaceMembership] = None + + if IS_PYDANTIC_V2: + model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True) # type: ignore # Pydantic v2 + else: + + class Config: + frozen = True + smart_union = True + extra = pydantic.Extra.allow diff --git a/src/webflow/types/workspace_membership_audit_log_item_event_sub_type.py b/src/webflow/types/workspace_membership_audit_log_item_event_sub_type.py new file mode 100644 index 0000000..4d90d7a --- /dev/null +++ b/src/webflow/types/workspace_membership_audit_log_item_event_sub_type.py @@ -0,0 +1,7 @@ +# This file was auto-generated by Fern from our API Definition. + +import typing + +WorkspaceMembershipAuditLogItemEventSubType = typing.Union[ + typing.Literal["user_added", "user_removed", "user_role_updated"], typing.Any +] diff --git a/tests/collections/test_fields.py b/tests/collections/test_fields.py deleted file mode 100644 index f64c447..0000000 --- a/tests/collections/test_fields.py +++ /dev/null @@ -1,97 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -from webflow import AsyncWebflow -import typing -from ..utilities import validate_response - - -async def test_create(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "75821f618da60c18383330bcc0ca488b", - "isRequired": False, - "isEditable": True, - "type": "RichText", - "slug": "post-body", - "displayName": "Post Body", - "helpText": "Add the body of your post here", - } - expected_types: typing.Any = { - "id": None, - "isRequired": None, - "isEditable": None, - "type": None, - "slug": None, - "displayName": None, - "helpText": None, - } - response = client.collections.fields.create( - collection_id="580e63fc8c9a982ac9b8b745", - is_required=False, - type="RichText", - display_name="Post Body", - help_text="Add the body of your post here", - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.collections.fields.create( - collection_id="580e63fc8c9a982ac9b8b745", - is_required=False, - type="RichText", - display_name="Post Body", - help_text="Add the body of your post here", - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_delete(client: Webflow, async_client: AsyncWebflow) -> None: - # Type ignore to avoid mypy complaining about the function not being meant to return a value - assert ( - client.collections.fields.delete(collection_id="580e63fc8c9a982ac9b8b745", field_id="580e63fc8c9a982ac9b8b745") # type: ignore[func-returns-value] - is None - ) - - assert ( - await async_client.collections.fields.delete( - collection_id="580e63fc8c9a982ac9b8b745", field_id="580e63fc8c9a982ac9b8b745" - ) # type: ignore[func-returns-value] - is None - ) - - -async def test_update(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "75821f618da60c18383330bcc0ca488b", - "isRequired": False, - "isEditable": True, - "type": "RichText", - "slug": "post-body", - "displayName": "Post Body", - "helpText": "Add the body of your post here", - } - expected_types: typing.Any = { - "id": None, - "isRequired": None, - "isEditable": None, - "type": None, - "slug": None, - "displayName": None, - "helpText": None, - } - response = client.collections.fields.update( - collection_id="580e63fc8c9a982ac9b8b745", - field_id="580e63fc8c9a982ac9b8b745", - is_required=False, - display_name="Post Body", - help_text="Add the body of your post here", - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.collections.fields.update( - collection_id="580e63fc8c9a982ac9b8b745", - field_id="580e63fc8c9a982ac9b8b745", - is_required=False, - display_name="Post Body", - help_text="Add the body of your post here", - ) - validate_response(async_response, expected_response, expected_types) diff --git a/tests/collections/test_items.py b/tests/collections/test_items.py deleted file mode 100644 index fc926a7..0000000 --- a/tests/collections/test_items.py +++ /dev/null @@ -1,810 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -from webflow import AsyncWebflow -import typing -from ..utilities import validate_response -from webflow import CollectionItemPostSingle -from webflow import CollectionItemPostSingleFieldData -from webflow import CollectionItemWithIdInput -from webflow import CollectionItemWithIdInputFieldData -from webflow import CollectionItem -from webflow import CollectionItemFieldData -from webflow.resources.collections.resources.items import SingleCmsItem -from webflow import CollectionItemPatchSingleFieldData - - -async def test_list_items(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "items": [ - { - "id": "62b720ef280c7a7a3be8cabe", - "cmsLocaleId": "66f6e966c9e1dc700a857ca3", - "lastPublished": "2022-06-30T13:35:20.878Z", - "lastUpdated": "2022-06-25T14:51:27.809Z", - "createdOn": "2022-06-25T14:51:27.809Z", - "isArchived": False, - "isDraft": False, - "fieldData": { - "name": "Senior Data Analyst", - "slug": "senior-data-analyst", - "url": "https://boards.greenhouse.io/webflow/jobs/26567701", - "department": "Data", - }, - }, - { - "id": "62c880ef281c7b7b4cf9dabc", - "cmsLocaleId": "66f6e966c9e1dc700a857ca3", - "lastPublished": "2023-04-15T10:25:18.123Z", - "lastUpdated": "2023-04-10T11:45:30.567Z", - "createdOn": "2023-04-10T11:45:30.567Z", - "isArchived": False, - "isDraft": False, - "fieldData": { - "name": "Product Manager", - "slug": "product-manager", - "url": "https://boards.greenhouse.io/webflow/jobs/31234567", - "department": "Product", - }, - }, - ], - "pagination": {"limit": 25, "offset": 0, "total": 2}, - } - expected_types: typing.Any = { - "items": ( - "list", - { - 0: { - "id": None, - "cmsLocaleId": None, - "lastPublished": None, - "lastUpdated": None, - "createdOn": None, - "isArchived": None, - "isDraft": None, - "fieldData": {"name": None, "slug": None}, - }, - 1: { - "id": None, - "cmsLocaleId": None, - "lastPublished": None, - "lastUpdated": None, - "createdOn": None, - "isArchived": None, - "isDraft": None, - "fieldData": {"name": None, "slug": None}, - }, - }, - ), - "pagination": {"limit": None, "offset": None, "total": None}, - } - response = client.collections.items.list_items(collection_id="580e63fc8c9a982ac9b8b745") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.collections.items.list_items(collection_id="580e63fc8c9a982ac9b8b745") - validate_response(async_response, expected_response, expected_types) - - -async def test_create_item(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "42b720ef280c7a7a3be8cabe", - "cmsLocaleId": "653ad57de882f528b32e810e", - "lastPublished": "2022-11-29T16:22:43.159Z", - "lastUpdated": "2022-11-17T17:19:43.282Z", - "createdOn": "2022-11-17T17:11:57.148Z", - "isArchived": False, - "isDraft": False, - "fieldData": { - "name": "Pan Galactic Gargle Blaster Recipe", - "slug": "pan-galactic-gargle-blaster", - "color": "#db4b68", - "date": "2022-11-18T00:00:00.000Z", - "featured": True, - }, - } - expected_types: typing.Any = { - "id": None, - "cmsLocaleId": None, - "lastPublished": None, - "lastUpdated": None, - "createdOn": None, - "isArchived": None, - "isDraft": None, - "fieldData": {"name": None, "slug": None}, - } - response = client.collections.items.create_item( - collection_id="580e63fc8c9a982ac9b8b745", - request=CollectionItemPostSingle( - is_archived=False, - is_draft=False, - field_data=CollectionItemPostSingleFieldData( - name="Pan Galactic Gargle Blaster Recipe", slug="pan-galactic-gargle-blaster" - ), - ), - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.collections.items.create_item( - collection_id="580e63fc8c9a982ac9b8b745", - request=CollectionItemPostSingle( - is_archived=False, - is_draft=False, - field_data=CollectionItemPostSingleFieldData( - name="Pan Galactic Gargle Blaster Recipe", slug="pan-galactic-gargle-blaster" - ), - ), - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_delete_items(client: Webflow, async_client: AsyncWebflow) -> None: - # Type ignore to avoid mypy complaining about the function not being meant to return a value - assert ( - client.collections.items.delete_items(collection_id="580e63fc8c9a982ac9b8b745") # type: ignore[func-returns-value] - is None - ) - - assert ( - await async_client.collections.items.delete_items(collection_id="580e63fc8c9a982ac9b8b745") # type: ignore[func-returns-value] - is None - ) - - -async def test_update_items(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "id", - "cmsLocaleId": "653ad57de882f528b32e810e", - "lastPublished": "2023-03-17T18:47:35.560Z", - "lastUpdated": "2023-03-17T18:47:35.560Z", - "createdOn": "2023-03-17T18:47:35.560Z", - "isArchived": True, - "isDraft": True, - "fieldData": { - "name": "My new item", - "slug": "my-new-item", - "date": "2022-11-18T00:00:00.000Z", - "featured": False, - "color": "#db4b68", - }, - } - expected_types: typing.Any = { - "id": None, - "cmsLocaleId": None, - "lastPublished": None, - "lastUpdated": None, - "createdOn": None, - "isArchived": None, - "isDraft": None, - "fieldData": {"name": None, "slug": None}, - } - response = client.collections.items.update_items( - collection_id="580e63fc8c9a982ac9b8b745", - items=[ - CollectionItemWithIdInput( - id="66f6ed9576ddacf3149d5ea6", - cms_locale_id="66f6e966c9e1dc700a857ca5", - field_data=CollectionItemWithIdInputFieldData(name="Ne Paniquez Pas", slug="ne-paniquez-pas"), - ), - CollectionItemWithIdInput( - id="66f6ed9576ddacf3149d5ea6", - cms_locale_id="66f6e966c9e1dc700a857ca4", - field_data=CollectionItemWithIdInputFieldData(name="No Entrar en Pánico", slug="no-entrar-en-panico"), - ), - CollectionItemWithIdInput( - id="66f6ed9576ddacf3149d5eaa", - cms_locale_id="66f6e966c9e1dc700a857ca5", - field_data=CollectionItemWithIdInputFieldData( - name="Au Revoir et Merci pour Tous les Poissons", slug="au-revoir-et-merci" - ), - ), - CollectionItemWithIdInput( - id="66f6ed9576ddacf3149d5eaa", - cms_locale_id="66f6e966c9e1dc700a857ca4", - field_data=CollectionItemWithIdInputFieldData( - name="Hasta Luego y Gracias por Todo el Pescado", slug="hasta-luego-y-gracias" - ), - ), - ], - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.collections.items.update_items( - collection_id="580e63fc8c9a982ac9b8b745", - items=[ - CollectionItemWithIdInput( - id="66f6ed9576ddacf3149d5ea6", - cms_locale_id="66f6e966c9e1dc700a857ca5", - field_data=CollectionItemWithIdInputFieldData(name="Ne Paniquez Pas", slug="ne-paniquez-pas"), - ), - CollectionItemWithIdInput( - id="66f6ed9576ddacf3149d5ea6", - cms_locale_id="66f6e966c9e1dc700a857ca4", - field_data=CollectionItemWithIdInputFieldData(name="No Entrar en Pánico", slug="no-entrar-en-panico"), - ), - CollectionItemWithIdInput( - id="66f6ed9576ddacf3149d5eaa", - cms_locale_id="66f6e966c9e1dc700a857ca5", - field_data=CollectionItemWithIdInputFieldData( - name="Au Revoir et Merci pour Tous les Poissons", slug="au-revoir-et-merci" - ), - ), - CollectionItemWithIdInput( - id="66f6ed9576ddacf3149d5eaa", - cms_locale_id="66f6e966c9e1dc700a857ca4", - field_data=CollectionItemWithIdInputFieldData( - name="Hasta Luego y Gracias por Todo el Pescado", slug="hasta-luego-y-gracias" - ), - ), - ], - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_list_items_live(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "items": [ - { - "id": "62b720ef280c7a7a3be8cabe", - "cmsLocaleId": "66f6e966c9e1dc700a857ca3", - "lastPublished": "2022-06-30T13:35:20.878Z", - "lastUpdated": "2022-06-25T14:51:27.809Z", - "createdOn": "2022-06-25T14:51:27.809Z", - "isArchived": False, - "isDraft": False, - "fieldData": { - "name": "Senior Data Analyst", - "slug": "senior-data-analyst", - "url": "https://boards.greenhouse.io/webflow/jobs/26567701", - "department": "Data", - }, - }, - { - "id": "62c880ef281c7b7b4cf9dabc", - "cmsLocaleId": "66f6e966c9e1dc700a857ca3", - "lastPublished": "2023-04-15T10:25:18.123Z", - "lastUpdated": "2023-04-10T11:45:30.567Z", - "createdOn": "2023-04-10T11:45:30.567Z", - "isArchived": False, - "isDraft": False, - "fieldData": { - "name": "Product Manager", - "slug": "product-manager", - "url": "https://boards.greenhouse.io/webflow/jobs/31234567", - "department": "Product", - }, - }, - ], - "pagination": {"limit": 25, "offset": 0, "total": 2}, - } - expected_types: typing.Any = { - "items": ( - "list", - { - 0: { - "id": None, - "cmsLocaleId": None, - "lastPublished": None, - "lastUpdated": None, - "createdOn": None, - "isArchived": None, - "isDraft": None, - "fieldData": {"name": None, "slug": None}, - }, - 1: { - "id": None, - "cmsLocaleId": None, - "lastPublished": None, - "lastUpdated": None, - "createdOn": None, - "isArchived": None, - "isDraft": None, - "fieldData": {"name": None, "slug": None}, - }, - }, - ), - "pagination": {"limit": None, "offset": None, "total": None}, - } - response = client.collections.items.list_items_live(collection_id="580e63fc8c9a982ac9b8b745") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.collections.items.list_items_live(collection_id="580e63fc8c9a982ac9b8b745") - validate_response(async_response, expected_response, expected_types) - - -async def test_create_item_live(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "42b720ef280c7a7a3be8cabe", - "cmsLocaleId": "653ad57de882f528b32e810e", - "lastPublished": "2022-11-29T16:22:43.159Z", - "lastUpdated": "2022-11-17T17:19:43.282Z", - "createdOn": "2022-11-17T17:11:57.148Z", - "isArchived": False, - "isDraft": False, - "fieldData": { - "name": "Pan Galactic Gargle Blaster Recipe", - "slug": "pan-galactic-gargle-blaster", - "color": "#db4b68", - "date": "2022-11-18T00:00:00.000Z", - "featured": True, - }, - } - expected_types: typing.Any = { - "id": None, - "cmsLocaleId": None, - "lastPublished": None, - "lastUpdated": None, - "createdOn": None, - "isArchived": None, - "isDraft": None, - "fieldData": {"name": None, "slug": None}, - } - response = client.collections.items.create_item_live( - collection_id="580e63fc8c9a982ac9b8b745", - request=CollectionItem( - is_archived=False, - is_draft=False, - field_data=CollectionItemFieldData( - name="Pan Galactic Gargle Blaster Recipe", slug="pan-galactic-gargle-blaster" - ), - ), - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.collections.items.create_item_live( - collection_id="580e63fc8c9a982ac9b8b745", - request=CollectionItem( - is_archived=False, - is_draft=False, - field_data=CollectionItemFieldData( - name="Pan Galactic Gargle Blaster Recipe", slug="pan-galactic-gargle-blaster" - ), - ), - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_delete_items_live(client: Webflow, async_client: AsyncWebflow) -> None: - # Type ignore to avoid mypy complaining about the function not being meant to return a value - assert ( - client.collections.items.delete_items_live(collection_id="580e63fc8c9a982ac9b8b745") # type: ignore[func-returns-value] - is None - ) - - assert ( - await async_client.collections.items.delete_items_live(collection_id="580e63fc8c9a982ac9b8b745") # type: ignore[func-returns-value] - is None - ) - - -async def test_update_items_live(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "items": [ - { - "id": "66f6ed9576ddacf3149d5ea6", - "cmsLocaleId": "66f6e966c9e1dc700a857ca5", - "lastPublished": "2023-03-17T18:47:35.560Z", - "lastUpdated": "2024-09-27T17:38:29.066Z", - "createdOn": "2024-09-27T17:38:29.066Z", - "isArchived": True, - "isDraft": True, - "fieldData": {"name": "Ne Paniquez Pas", "slug": "ne-paniquez-pas", "featured": False}, - }, - { - "id": "66f6ed9576ddacf3149d5ea6", - "cmsLocaleId": "66f6e966c9e1dc700a857ca4", - "lastPublished": "2023-03-17T18:47:35.560Z", - "lastUpdated": "2024-09-27T17:38:29.066Z", - "createdOn": "2024-09-27T17:38:29.066Z", - "isArchived": True, - "isDraft": True, - "fieldData": {"name": "No Entrar en Pánico", "slug": "no-entrar-en-panico", "featured": False}, - }, - { - "id": "66f6ed9576ddacf3149d5eaa", - "cmsLocaleId": "66f6e966c9e1dc700a857ca5", - "lastPublished": "2023-03-17T18:47:35.560Z", - "lastUpdated": "2024-09-27T17:38:29.066Z", - "createdOn": "2024-09-27T17:38:29.066Z", - "isArchived": True, - "isDraft": True, - "fieldData": { - "name": "Au Revoir et Merci pour Tous les Poissons", - "slug": "au-revoir-et-merci", - "featured": False, - }, - }, - { - "id": "66f6ed9576ddacf3149d5eaa", - "cmsLocaleId": "66f6e966c9e1dc700a857ca4", - "lastPublished": "2023-03-17T18:47:35.560Z", - "lastUpdated": "2024-09-27T17:38:29.066Z", - "createdOn": "2024-09-27T17:38:29.066Z", - "isArchived": True, - "isDraft": True, - "fieldData": { - "name": "Hasta Luego y Gracias por Todo el Pescado", - "slug": "hasta-luego-y-gracias", - "featured": False, - }, - }, - ] - } - expected_types: typing.Any = { - "items": ( - "list", - { - 0: { - "id": None, - "cmsLocaleId": None, - "lastPublished": None, - "lastUpdated": None, - "createdOn": None, - "isArchived": None, - "isDraft": None, - "fieldData": {"name": None, "slug": None}, - }, - 1: { - "id": None, - "cmsLocaleId": None, - "lastPublished": None, - "lastUpdated": None, - "createdOn": None, - "isArchived": None, - "isDraft": None, - "fieldData": {"name": None, "slug": None}, - }, - 2: { - "id": None, - "cmsLocaleId": None, - "lastPublished": None, - "lastUpdated": None, - "createdOn": None, - "isArchived": None, - "isDraft": None, - "fieldData": {"name": None, "slug": None}, - }, - 3: { - "id": None, - "cmsLocaleId": None, - "lastPublished": None, - "lastUpdated": None, - "createdOn": None, - "isArchived": None, - "isDraft": None, - "fieldData": {"name": None, "slug": None}, - }, - }, - ) - } - response = client.collections.items.update_items_live( - collection_id="580e63fc8c9a982ac9b8b745", - items=[ - CollectionItemWithIdInput( - id="66f6ed9576ddacf3149d5ea6", - cms_locale_id="66f6e966c9e1dc700a857ca5", - field_data=CollectionItemWithIdInputFieldData(name="Ne Paniquez Pas", slug="ne-paniquez-pas"), - ), - CollectionItemWithIdInput( - id="66f6ed9576ddacf3149d5ea6", - cms_locale_id="66f6e966c9e1dc700a857ca4", - field_data=CollectionItemWithIdInputFieldData(name="No Entrar en Pánico", slug="no-entrar-en-panico"), - ), - CollectionItemWithIdInput( - id="66f6ed9576ddacf3149d5eaa", - cms_locale_id="66f6e966c9e1dc700a857ca5", - field_data=CollectionItemWithIdInputFieldData( - name="Au Revoir et Merci pour Tous les Poissons", slug="au-revoir-et-merci" - ), - ), - CollectionItemWithIdInput( - id="66f6ed9576ddacf3149d5eaa", - cms_locale_id="66f6e966c9e1dc700a857ca4", - field_data=CollectionItemWithIdInputFieldData( - name="Hasta Luego y Gracias por Todo el Pescado", slug="hasta-luego-y-gracias" - ), - ), - ], - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.collections.items.update_items_live( - collection_id="580e63fc8c9a982ac9b8b745", - items=[ - CollectionItemWithIdInput( - id="66f6ed9576ddacf3149d5ea6", - cms_locale_id="66f6e966c9e1dc700a857ca5", - field_data=CollectionItemWithIdInputFieldData(name="Ne Paniquez Pas", slug="ne-paniquez-pas"), - ), - CollectionItemWithIdInput( - id="66f6ed9576ddacf3149d5ea6", - cms_locale_id="66f6e966c9e1dc700a857ca4", - field_data=CollectionItemWithIdInputFieldData(name="No Entrar en Pánico", slug="no-entrar-en-panico"), - ), - CollectionItemWithIdInput( - id="66f6ed9576ddacf3149d5eaa", - cms_locale_id="66f6e966c9e1dc700a857ca5", - field_data=CollectionItemWithIdInputFieldData( - name="Au Revoir et Merci pour Tous les Poissons", slug="au-revoir-et-merci" - ), - ), - CollectionItemWithIdInput( - id="66f6ed9576ddacf3149d5eaa", - cms_locale_id="66f6e966c9e1dc700a857ca4", - field_data=CollectionItemWithIdInputFieldData( - name="Hasta Luego y Gracias por Todo el Pescado", slug="hasta-luego-y-gracias" - ), - ), - ], - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_create_items(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "580e64008c9a982ac9b8b754", - "cmsLocaleIds": ["653ad57de882f528b32e810e", "6514390aea353fc691d69827", "65143930ea353fc691d69cd8"], - "lastPublished": "2023-03-17T18:47:35.560Z", - "lastUpdated": "2023-03-17T18:47:35.560Z", - "createdOn": "2023-03-17T18:47:35.560Z", - "isArchived": True, - "isDraft": True, - "fieldData": { - "name": "My new item", - "slug": "my-new-item", - "date": "2022-11-18T00:00:00.000Z", - "featured": False, - "color": "#db4b68", - }, - } - expected_types: typing.Any = { - "id": None, - "cmsLocaleIds": ("list", {0: None, 1: None, 2: None}), - "lastPublished": None, - "lastUpdated": None, - "createdOn": None, - "isArchived": None, - "isDraft": None, - "fieldData": {"name": None, "slug": None}, - } - response = client.collections.items.create_items( - collection_id="580e63fc8c9a982ac9b8b745", - cms_locale_ids=["66f6e966c9e1dc700a857ca3", "66f6e966c9e1dc700a857ca4", "66f6e966c9e1dc700a857ca5"], - is_archived=False, - is_draft=False, - field_data=SingleCmsItem(name="Don’t Panic", slug="dont-panic"), - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.collections.items.create_items( - collection_id="580e63fc8c9a982ac9b8b745", - cms_locale_ids=["66f6e966c9e1dc700a857ca3", "66f6e966c9e1dc700a857ca4", "66f6e966c9e1dc700a857ca5"], - is_archived=False, - is_draft=False, - field_data=SingleCmsItem(name="Don’t Panic", slug="dont-panic"), - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_get_item(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "42b720ef280c7a7a3be8cabe", - "cmsLocaleId": "653ad57de882f528b32e810e", - "lastPublished": "2022-11-29T16:22:43.159Z", - "lastUpdated": "2022-11-17T17:19:43.282Z", - "createdOn": "2022-11-17T17:11:57.148Z", - "isArchived": False, - "isDraft": False, - "fieldData": { - "name": "Pan Galactic Gargle Blaster Recipe", - "slug": "pan-galactic-gargle-blaster", - "color": "#db4b68", - "date": "2022-11-18T00:00:00.000Z", - "featured": True, - }, - } - expected_types: typing.Any = { - "id": None, - "cmsLocaleId": None, - "lastPublished": None, - "lastUpdated": None, - "createdOn": None, - "isArchived": None, - "isDraft": None, - "fieldData": {"name": None, "slug": None}, - } - response = client.collections.items.get_item( - collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754" - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.collections.items.get_item( - collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754" - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_delete_item(client: Webflow, async_client: AsyncWebflow) -> None: - # Type ignore to avoid mypy complaining about the function not being meant to return a value - assert ( - client.collections.items.delete_item( - collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754" - ) # type: ignore[func-returns-value] - is None - ) - - assert ( - await async_client.collections.items.delete_item( - collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754" - ) # type: ignore[func-returns-value] - is None - ) - - -async def test_update_item(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "42b720ef280c7a7a3be8cabe", - "cmsLocaleId": "653ad57de882f528b32e810e", - "lastPublished": "2022-11-29T16:22:43.159Z", - "lastUpdated": "2022-11-17T17:19:43.282Z", - "createdOn": "2022-11-17T17:11:57.148Z", - "isArchived": False, - "isDraft": False, - "fieldData": { - "name": "Pan Galactic Gargle Blaster Recipe", - "slug": "pan-galactic-gargle-blaster", - "color": "#db4b68", - "date": "2022-11-18T00:00:00.000Z", - "featured": True, - }, - } - expected_types: typing.Any = { - "id": None, - "cmsLocaleId": None, - "lastPublished": None, - "lastUpdated": None, - "createdOn": None, - "isArchived": None, - "isDraft": None, - "fieldData": {"name": None, "slug": None}, - } - response = client.collections.items.update_item( - collection_id="580e63fc8c9a982ac9b8b745", - item_id="580e64008c9a982ac9b8b754", - is_archived=False, - is_draft=False, - field_data=CollectionItemPatchSingleFieldData( - name="Pan Galactic Gargle Blaster Recipe", slug="pan-galactic-gargle-blaster" - ), - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.collections.items.update_item( - collection_id="580e63fc8c9a982ac9b8b745", - item_id="580e64008c9a982ac9b8b754", - is_archived=False, - is_draft=False, - field_data=CollectionItemPatchSingleFieldData( - name="Pan Galactic Gargle Blaster Recipe", slug="pan-galactic-gargle-blaster" - ), - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_get_item_live(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "42b720ef280c7a7a3be8cabe", - "cmsLocaleId": "653ad57de882f528b32e810e", - "lastPublished": "2022-11-29T16:22:43.159Z", - "lastUpdated": "2022-11-17T17:19:43.282Z", - "createdOn": "2022-11-17T17:11:57.148Z", - "isArchived": False, - "isDraft": False, - "fieldData": { - "name": "Pan Galactic Gargle Blaster Recipe", - "slug": "pan-galactic-gargle-blaster", - "color": "#db4b68", - "date": "2022-11-18T00:00:00.000Z", - "featured": True, - }, - } - expected_types: typing.Any = { - "id": None, - "cmsLocaleId": None, - "lastPublished": None, - "lastUpdated": None, - "createdOn": None, - "isArchived": None, - "isDraft": None, - "fieldData": {"name": None, "slug": None}, - } - response = client.collections.items.get_item_live( - collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754" - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.collections.items.get_item_live( - collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754" - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_delete_item_live(client: Webflow, async_client: AsyncWebflow) -> None: - # Type ignore to avoid mypy complaining about the function not being meant to return a value - assert ( - client.collections.items.delete_item_live( - collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754" - ) # type: ignore[func-returns-value] - is None - ) - - assert ( - await async_client.collections.items.delete_item_live( - collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754" - ) # type: ignore[func-returns-value] - is None - ) - - -async def test_update_item_live(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "42b720ef280c7a7a3be8cabe", - "cmsLocaleId": "653ad57de882f528b32e810e", - "lastPublished": "2022-11-29T16:22:43.159Z", - "lastUpdated": "2022-11-17T17:19:43.282Z", - "createdOn": "2022-11-17T17:11:57.148Z", - "isArchived": False, - "isDraft": False, - "fieldData": { - "name": "Pan Galactic Gargle Blaster Recipe", - "slug": "pan-galactic-gargle-blaster", - "color": "#db4b68", - "date": "2022-11-18T00:00:00.000Z", - "featured": True, - }, - } - expected_types: typing.Any = { - "id": None, - "cmsLocaleId": None, - "lastPublished": None, - "lastUpdated": None, - "createdOn": None, - "isArchived": None, - "isDraft": None, - "fieldData": {"name": None, "slug": None}, - } - response = client.collections.items.update_item_live( - collection_id="580e63fc8c9a982ac9b8b745", - item_id="580e64008c9a982ac9b8b754", - is_archived=False, - is_draft=False, - field_data=CollectionItemPatchSingleFieldData( - name="Pan Galactic Gargle Blaster Recipe", slug="pan-galactic-gargle-blaster" - ), - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.collections.items.update_item_live( - collection_id="580e63fc8c9a982ac9b8b745", - item_id="580e64008c9a982ac9b8b754", - is_archived=False, - is_draft=False, - field_data=CollectionItemPatchSingleFieldData( - name="Pan Galactic Gargle Blaster Recipe", slug="pan-galactic-gargle-blaster" - ), - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_publish_item(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "publishedItemIds": ["643fd856d66b6528195ee2ca", "643fd856d66b6528195ee2cb"], - "errors": ["Staging item ID 643fd856d66b6528195ee2cf not found."], - } - expected_types: typing.Any = {"publishedItemIds": ("list", {0: None, 1: None}), "errors": ("list", {0: None})} - response = client.collections.items.publish_item(collection_id="580e63fc8c9a982ac9b8b745", item_ids=["itemIds"]) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.collections.items.publish_item( - collection_id="580e63fc8c9a982ac9b8b745", item_ids=["itemIds"] - ) - validate_response(async_response, expected_response, expected_types) diff --git a/tests/conftest.py b/tests/conftest.py deleted file mode 100644 index 019aab8..0000000 --- a/tests/conftest.py +++ /dev/null @@ -1,20 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -import os -import pytest -from webflow import AsyncWebflow - - -@pytest.fixture -def client() -> Webflow: - return Webflow( - access_token=os.getenv("ENV_ACCESS_TOKEN", "access_token"), base_url=os.getenv("TESTS_BASE_URL", "base_url") - ) - - -@pytest.fixture -def async_client() -> AsyncWebflow: - return AsyncWebflow( - access_token=os.getenv("ENV_ACCESS_TOKEN", "access_token"), base_url=os.getenv("TESTS_BASE_URL", "base_url") - ) diff --git a/tests/custom/test_client.py b/tests/custom/test_client.py index 73f811f..ab04ce6 100644 --- a/tests/custom/test_client.py +++ b/tests/custom/test_client.py @@ -4,4 +4,4 @@ # Get started with writing tests with pytest at https://docs.pytest.org @pytest.mark.skip(reason="Unimplemented") def test_client() -> None: - assert True == True + assert True diff --git a/tests/pages/__init__.py b/tests/pages/__init__.py deleted file mode 100644 index f3ea265..0000000 --- a/tests/pages/__init__.py +++ /dev/null @@ -1,2 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - diff --git a/tests/pages/test_scripts.py b/tests/pages/test_scripts.py deleted file mode 100644 index 0e553d2..0000000 --- a/tests/pages/test_scripts.py +++ /dev/null @@ -1,85 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -from webflow import AsyncWebflow -import typing -from ..utilities import validate_response -from webflow import ScriptApply - - -async def test_get_custom_code(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "scripts": [{"id": "id", "location": "header", "version": "version", "attributes": {"key": "value"}}], - "lastUpdated": "lastUpdated", - "createdOn": "createdOn", - } - expected_types: typing.Any = { - "scripts": ( - "list", - {0: {"id": None, "location": None, "version": None, "attributes": ("dict", {0: (None, None)})}}, - ), - "lastUpdated": None, - "createdOn": None, - } - response = client.pages.scripts.get_custom_code(page_id="63c720f9347c2139b248e552") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.pages.scripts.get_custom_code(page_id="63c720f9347c2139b248e552") - validate_response(async_response, expected_response, expected_types) - - -async def test_upsert_custom_code(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "scripts": [ - { - "id": "cms_slider", - "location": "header", - "version": "1.0.0", - "attributes": {"my-attribute": "some-value"}, - }, - {"id": "alert", "location": "header", "version": "0.0.1", "attributes": {"key": "value"}}, - ], - "lastUpdated": "2022-10-26T00:28:54.191Z", - "createdOn": "2022-10-26T00:28:54.191Z", - } - expected_types: typing.Any = { - "scripts": ( - "list", - { - 0: {"id": None, "location": None, "version": None, "attributes": ("dict", {0: (None, None)})}, - 1: {"id": None, "location": None, "version": None, "attributes": ("dict", {0: (None, None)})}, - }, - ), - "lastUpdated": None, - "createdOn": None, - } - response = client.pages.scripts.upsert_custom_code( - page_id="63c720f9347c2139b248e552", - scripts=[ - ScriptApply(id="cms_slider", location="header", version="1.0.0", attributes={"my-attribute": "some-value"}), - ScriptApply(id="alert", location="header", version="0.0.1"), - ], - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.pages.scripts.upsert_custom_code( - page_id="63c720f9347c2139b248e552", - scripts=[ - ScriptApply(id="cms_slider", location="header", version="1.0.0", attributes={"my-attribute": "some-value"}), - ScriptApply(id="alert", location="header", version="0.0.1"), - ], - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_delete_custom_code(client: Webflow, async_client: AsyncWebflow) -> None: - # Type ignore to avoid mypy complaining about the function not being meant to return a value - assert ( - client.pages.scripts.delete_custom_code(page_id="63c720f9347c2139b248e552") # type: ignore[func-returns-value] - is None - ) - - assert ( - await async_client.pages.scripts.delete_custom_code(page_id="63c720f9347c2139b248e552") # type: ignore[func-returns-value] - is None - ) diff --git a/tests/sites/test_activity_logs.py b/tests/sites/test_activity_logs.py deleted file mode 100644 index f289464..0000000 --- a/tests/sites/test_activity_logs.py +++ /dev/null @@ -1,53 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -from webflow import AsyncWebflow -import typing -from ..utilities import validate_response - - -async def test_list_(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "items": [ - { - "id": "654c16c7b229e56bcf26872d", - "createdOn": "2023-11-08T23:16:23Z", - "lastUpdated": "2023-11-08T23:16:23Z", - "event": "cms_collection", - "resourceOperation": "CREATED", - "user": {"id": "6509cd56e90eec668b009712", "displayName": "John Doe"}, - "resourceId": "654c16c7b229e56bcf26870c", - "resourceName": "foo-bar", - "newValue": "newValue", - "previousValue": "previousValue", - "payload": {"key": "value"}, - } - ], - "pagination": {"limit": 25, "offset": 0, "total": 1}, - } - expected_types: typing.Any = { - "items": ( - "list", - { - 0: { - "id": None, - "createdOn": "datetime", - "lastUpdated": "datetime", - "event": None, - "resourceOperation": None, - "user": {"id": None, "displayName": None}, - "resourceId": None, - "resourceName": None, - "newValue": None, - "previousValue": None, - "payload": ("dict", {0: (None, None)}), - } - }, - ), - "pagination": {"limit": None, "offset": None, "total": None}, - } - response = client.sites.activity_logs.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.sites.activity_logs.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) diff --git a/tests/sites/test_plans.py b/tests/sites/test_plans.py deleted file mode 100644 index 01c304e..0000000 --- a/tests/sites/test_plans.py +++ /dev/null @@ -1,20 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -from webflow import AsyncWebflow -import typing -from ..utilities import validate_response - - -async def test_get_site_plan(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "hosting-business-v4", - "name": "Business Hosting", - "pricingInfo": "https://webflow.com/pricing", - } - expected_types: typing.Any = {"id": None, "name": None, "pricingInfo": None} - response = client.sites.plans.get_site_plan(site_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.sites.plans.get_site_plan(site_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) diff --git a/tests/sites/test_redirects.py b/tests/sites/test_redirects.py deleted file mode 100644 index e10b50e..0000000 --- a/tests/sites/test_redirects.py +++ /dev/null @@ -1,88 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -from webflow import AsyncWebflow -import typing -from ..utilities import validate_response - - -async def test_list_(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "redirects": [ - {"id": "42e1a2b7aa1a13f768a0042a", "fromUrl": "/mostly-harmless", "toUrl": "/earth"}, - {"id": "6x9e7f8d9a4b1c2d3e4f5678", "fromUrl": "/babel-fish", "toUrl": "/translate"}, - ], - "pagination": {"limit": 100, "offset": 0, "total": 2}, - } - expected_types: typing.Any = { - "redirects": ( - "list", - {0: {"id": None, "fromUrl": None, "toUrl": None}, 1: {"id": None, "fromUrl": None, "toUrl": None}}, - ), - "pagination": {"limit": None, "offset": None, "total": None}, - } - response = client.sites.redirects.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.sites.redirects.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) - - -async def test_create(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = {"id": "42e1a2b7aa1a13f768a0042a", "fromUrl": "/mostly-harmless", "toUrl": "/earth"} - expected_types: typing.Any = {"id": None, "fromUrl": None, "toUrl": None} - response = client.sites.redirects.create( - site_id="580e63e98c9a982ac9b8b741", id="42e1a2b7aa1a13f768a0042a", from_url="/mostly-harmless", to_url="/earth" - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.sites.redirects.create( - site_id="580e63e98c9a982ac9b8b741", id="42e1a2b7aa1a13f768a0042a", from_url="/mostly-harmless", to_url="/earth" - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_delete(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "redirects": [ - {"id": "42e1a2b7aa1a13f768a0042a", "fromUrl": "/mostly-harmless", "toUrl": "/earth"}, - {"id": "6x9e7f8d9a4b1c2d3e4f5678", "fromUrl": "/babel-fish", "toUrl": "/translate"}, - ], - "pagination": {"limit": 100, "offset": 0, "total": 2}, - } - expected_types: typing.Any = { - "redirects": ( - "list", - {0: {"id": None, "fromUrl": None, "toUrl": None}, 1: {"id": None, "fromUrl": None, "toUrl": None}}, - ), - "pagination": {"limit": None, "offset": None, "total": None}, - } - response = client.sites.redirects.delete(site_id="580e63e98c9a982ac9b8b741", redirect_id="66c4cb9a20cac35ed19500e6") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.sites.redirects.delete( - site_id="580e63e98c9a982ac9b8b741", redirect_id="66c4cb9a20cac35ed19500e6" - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_update(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = {"id": "42e1a2b7aa1a13f768a0042a", "fromUrl": "/mostly-harmless", "toUrl": "/earth"} - expected_types: typing.Any = {"id": None, "fromUrl": None, "toUrl": None} - response = client.sites.redirects.update( - site_id="580e63e98c9a982ac9b8b741", - redirect_id="66c4cb9a20cac35ed19500e6", - id="42e1a2b7aa1a13f768a0042a", - from_url="/mostly-harmless", - to_url="/earth", - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.sites.redirects.update( - site_id="580e63e98c9a982ac9b8b741", - redirect_id="66c4cb9a20cac35ed19500e6", - id="42e1a2b7aa1a13f768a0042a", - from_url="/mostly-harmless", - to_url="/earth", - ) - validate_response(async_response, expected_response, expected_types) diff --git a/tests/sites/test_scripts.py b/tests/sites/test_scripts.py deleted file mode 100644 index cc5d71c..0000000 --- a/tests/sites/test_scripts.py +++ /dev/null @@ -1,154 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -from webflow import AsyncWebflow -import typing -from ..utilities import validate_response -from webflow import ScriptApply - - -async def test_get_custom_code(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "scripts": [ - { - "id": "cms_slider", - "location": "header", - "version": "1.0.0", - "attributes": {"my-attribute": "some-value"}, - }, - {"id": "alert", "location": "header", "version": "0.0.1", "attributes": {"key": "value"}}, - ], - "lastUpdated": "2022-10-26T00:28:54.191Z", - "createdOn": "2022-10-26T00:28:54.191Z", - } - expected_types: typing.Any = { - "scripts": ( - "list", - { - 0: {"id": None, "location": None, "version": None, "attributes": ("dict", {0: (None, None)})}, - 1: {"id": None, "location": None, "version": None, "attributes": ("dict", {0: (None, None)})}, - }, - ), - "lastUpdated": None, - "createdOn": None, - } - response = client.sites.scripts.get_custom_code(site_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.sites.scripts.get_custom_code(site_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) - - -async def test_upsert_custom_code(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "scripts": [ - { - "id": "cms_slider", - "location": "header", - "version": "1.0.0", - "attributes": {"my-attribute": "some-value"}, - }, - {"id": "alert", "location": "header", "version": "0.0.1", "attributes": {"key": "value"}}, - ], - "lastUpdated": "lastUpdated", - "createdOn": "createdOn", - } - expected_types: typing.Any = { - "scripts": ( - "list", - { - 0: {"id": None, "location": None, "version": None, "attributes": ("dict", {0: (None, None)})}, - 1: {"id": None, "location": None, "version": None, "attributes": ("dict", {0: (None, None)})}, - }, - ), - "lastUpdated": None, - "createdOn": None, - } - response = client.sites.scripts.upsert_custom_code( - site_id="580e63e98c9a982ac9b8b741", - scripts=[ - ScriptApply(id="cms_slider", location="header", version="1.0.0", attributes={"my-attribute": "some-value"}), - ScriptApply(id="alert", location="header", version="0.0.1"), - ], - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.sites.scripts.upsert_custom_code( - site_id="580e63e98c9a982ac9b8b741", - scripts=[ - ScriptApply(id="cms_slider", location="header", version="1.0.0", attributes={"my-attribute": "some-value"}), - ScriptApply(id="alert", location="header", version="0.0.1"), - ], - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_delete_custom_code(client: Webflow, async_client: AsyncWebflow) -> None: - # Type ignore to avoid mypy complaining about the function not being meant to return a value - assert ( - client.sites.scripts.delete_custom_code(site_id="580e63e98c9a982ac9b8b741") # type: ignore[func-returns-value] - is None - ) - - assert ( - await async_client.sites.scripts.delete_custom_code(site_id="580e63e98c9a982ac9b8b741") # type: ignore[func-returns-value] - is None - ) - - -async def test_list_custom_code_blocks(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "blocks": [ - { - "siteId": "6258612d1ee792848f805dcf", - "pageId": "pageId", - "type": "site", - "scripts": [ - {"id": "chartjs", "location": "header", "version": "4.4.2", "attributes": {"key": "value"}} - ], - "createdOn": "2024-04-03T16:49:15Z", - "lastUpdated": "2024-04-03T16:49:15Z", - }, - { - "siteId": "6390c49674a71f84b51a08d8", - "pageId": "6419db964a9c43f6a3af6348", - "type": "page", - "scripts": [{"id": "id", "location": "header", "version": "version"}], - "createdOn": "2022-10-26T00:28:54Z", - "lastUpdated": "2022-10-26T00:28:54Z", - }, - ], - "pagination": {"limit": 10, "offset": 0, "total": 1}, - } - expected_types: typing.Any = { - "blocks": ( - "list", - { - 0: { - "siteId": None, - "pageId": None, - "type": None, - "scripts": ( - "list", - {0: {"id": None, "location": None, "version": None, "attributes": ("dict", {0: (None, None)})}}, - ), - "createdOn": "datetime", - "lastUpdated": "datetime", - }, - 1: { - "siteId": None, - "pageId": None, - "type": None, - "scripts": ("list", {0: {"id": None, "location": None, "version": None}}), - "createdOn": "datetime", - "lastUpdated": "datetime", - }, - }, - ), - "pagination": {"limit": None, "offset": None, "total": None}, - } - response = client.sites.scripts.list_custom_code_blocks(site_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.sites.scripts.list_custom_code_blocks(site_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) diff --git a/tests/test_access_groups.py b/tests/test_access_groups.py deleted file mode 100644 index dfe7e19..0000000 --- a/tests/test_access_groups.py +++ /dev/null @@ -1,49 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -from webflow import AsyncWebflow -import typing -from .utilities import validate_response - - -async def test_list_(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "count": 1, - "limit": 10, - "offset": 0, - "total": 1, - "accessGroups": [ - { - "id": "62be58d404be8a6cc900c081", - "name": "Research Team", - "shortId": "rt", - "slug": "hitchhikers-guide-research-team", - "createdOn": "2022-08-01T19:41:48Z", - }, - { - "id": "65a96161991e77bbb4a6c573", - "name": "Admin", - "shortId": "ad", - "slug": "admin", - "createdOn": "2022-08-01T19:41:48Z", - }, - ], - } - expected_types: typing.Any = { - "count": None, - "limit": None, - "offset": None, - "total": None, - "accessGroups": ( - "list", - { - 0: {"id": None, "name": None, "shortId": None, "slug": None, "createdOn": "datetime"}, - 1: {"id": None, "name": None, "shortId": None, "slug": None, "createdOn": "datetime"}, - }, - ), - } - response = client.access_groups.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.access_groups.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) diff --git a/tests/test_assets.py b/tests/test_assets.py deleted file mode 100644 index af158ef..0000000 --- a/tests/test_assets.py +++ /dev/null @@ -1,358 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -from webflow import AsyncWebflow -import typing -from .utilities import validate_response - - -async def test_list_(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "assets": [ - { - "id": "63e5889e7fe4eafa7384cea4", - "contentType": "image/png", - "size": 2212772, - "siteId": "63938b302ea6b0aa6f3d8745", - "hostedUrl": "https://s3.amazonaws.com/webflow-prod-assets/63938b302ea6b0aa6f3d8745/63e5889e7fe4eafa7384cea4_Vectors-Wrapper.svg", - "originalFileName": "Candy-Wrapper.svg", - "displayName": "63e5889e7fe4eafa7384cea4_Candy-Wrapper.png", - "lastUpdated": "2023-03-01T23:42:57Z", - "createdOn": "2023-02-09T23:58:22Z", - "variants": [ - { - "hostedUrl": "https://s3.amazonaws.com/webflow-prod-assets/6258612d1ee792848f805dcf/660d83ce30f3a599ddb0bdb3_Screenshot%202024-03-20%20at%209.03.24%E2%80%AFPM-p-500.png", - "originalFileName": "Screenshot%202024-03-20%20at%209.03.24%E2%80%AFPM-p-500.png", - "displayName": "660d83ce30f3a599ddb0bdb3_Screenshot%202024-03-20%20at%209.03.24%E2%80%AFPM-p-500.png", - "format": "png", - "width": 500, - "height": 900, - "quality": 100, - } - ], - "altText": "A red chair", - } - ] - } - expected_types: typing.Any = { - "assets": ( - "list", - { - 0: { - "id": None, - "contentType": None, - "size": "integer", - "siteId": None, - "hostedUrl": None, - "originalFileName": None, - "displayName": None, - "lastUpdated": "datetime", - "createdOn": "datetime", - "variants": ( - "list", - { - 0: { - "hostedUrl": None, - "originalFileName": None, - "displayName": None, - "format": None, - "width": "integer", - "height": "integer", - "quality": "integer", - } - }, - ), - "altText": None, - } - }, - ) - } - response = client.assets.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.assets.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) - - -async def test_create(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "uploadDetails": { - "acl": "public-read", - "bucket": "webflow-bucket-name", - "X-Amz-Algorithm": "AWS4-HMAC-SHA256", - "X-Amz-Credential": "///s3/aws4_request", - "X-Amz-Date": "", - "key": "/_", - "Policy": "", - "X-Amz-Signature": "", - "success_action_status": "201", - "content-type": "image/png", - "Cache-Control": "max-age=31536000, must-revalidate", - }, - "contentType": "image/png", - "id": "64358b9544249dc43d37d2b7", - "parentFolder": "6436b1ce5281cace05b65aea", - "uploadUrl": "https://s3.amazonaws.com/webflow-dev-assets/643021114e290e0d3a0602b2/64358b9544249dc43d37d2b7_Screenshot%202023-04-11%20at%209.50.42%20AM.png", - "assetUrl": "https://s3.amazonaws.com/webflow-prod-assets/6258612d1ee792848f805dcf/660d907ab9e91e3e9f56385e_paranoidAndroid-2024.png", - "hostedUrl": "https://d1otoma47x30pg.cloudfront.net/643021114e290e0d3a0602b2/64358b9544249dc43d37d2b7_Screenshot%202023-04-11%20at%209.50.42%20AM.png", - "originalFileName": "file.png", - "createdOn": "2023-04-11T16:32:21Z", - "lastUpdated": "2023-04-12T20:31:03Z", - } - expected_types: typing.Any = { - "uploadDetails": { - "acl": None, - "bucket": None, - "X-Amz-Algorithm": None, - "X-Amz-Credential": None, - "X-Amz-Date": None, - "key": None, - "Policy": None, - "X-Amz-Signature": None, - "success_action_status": None, - "content-type": None, - "Cache-Control": None, - }, - "contentType": None, - "id": None, - "parentFolder": None, - "uploadUrl": None, - "assetUrl": None, - "hostedUrl": None, - "originalFileName": None, - "createdOn": "datetime", - "lastUpdated": "datetime", - } - response = client.assets.create( - site_id="580e63e98c9a982ac9b8b741", file_name="file.png", file_hash="3c7d87c9575702bc3b1e991f4d3c638e" - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.assets.create( - site_id="580e63e98c9a982ac9b8b741", file_name="file.png", file_hash="3c7d87c9575702bc3b1e991f4d3c638e" - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_get(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "55131cd036c09f7d07883dfc", - "contentType": "image/png", - "size": 1500, - "siteId": "62749158efef318abc8d5a0f", - "hostedUrl": "example.com/hostedimage.png", - "originalFileName": "image.png", - "displayName": "example-image-123.png", - "lastUpdated": "2016-09-06T21:12:22Z", - "createdOn": "2016-09-02T23:26:22Z", - "variants": [ - { - "hostedUrl": "example.com/hostedimage.png", - "originalFileName": "image.png", - "displayName": "A brown dog", - "format": "format", - "width": 1500, - "height": 900, - "quality": 1, - "error": "error", - } - ], - "altText": "A red chair", - } - expected_types: typing.Any = { - "id": None, - "contentType": None, - "size": "integer", - "siteId": None, - "hostedUrl": None, - "originalFileName": None, - "displayName": None, - "lastUpdated": "datetime", - "createdOn": "datetime", - "variants": ( - "list", - { - 0: { - "hostedUrl": None, - "originalFileName": None, - "displayName": None, - "format": None, - "width": "integer", - "height": "integer", - "quality": "integer", - "error": None, - } - }, - ), - "altText": None, - } - response = client.assets.get(asset_id="580e63fc8c9a982ac9b8b745") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.assets.get(asset_id="580e63fc8c9a982ac9b8b745") - validate_response(async_response, expected_response, expected_types) - - -async def test_delete(client: Webflow, async_client: AsyncWebflow) -> None: - # Type ignore to avoid mypy complaining about the function not being meant to return a value - assert ( - client.assets.delete(asset_id="580e63fc8c9a982ac9b8b745") # type: ignore[func-returns-value] - is None - ) - - assert ( - await async_client.assets.delete(asset_id="580e63fc8c9a982ac9b8b745") # type: ignore[func-returns-value] - is None - ) - - -async def test_update(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "55131cd036c09f7d07883dfc", - "contentType": "image/png", - "size": 1500, - "siteId": "62749158efef318abc8d5a0f", - "hostedUrl": "example.com/hostedimage.png", - "originalFileName": "image.png", - "displayName": "example-image-123.png", - "lastUpdated": "2016-09-06T21:12:22Z", - "createdOn": "2016-09-02T23:26:22Z", - "variants": [ - { - "hostedUrl": "example.com/hostedimage.png", - "originalFileName": "image.png", - "displayName": "A brown dog", - "format": "format", - "width": 1500, - "height": 900, - "quality": 1, - "error": "error", - } - ], - "altText": "A red chair", - } - expected_types: typing.Any = { - "id": None, - "contentType": None, - "size": "integer", - "siteId": None, - "hostedUrl": None, - "originalFileName": None, - "displayName": None, - "lastUpdated": "datetime", - "createdOn": "datetime", - "variants": ( - "list", - { - 0: { - "hostedUrl": None, - "originalFileName": None, - "displayName": None, - "format": None, - "width": "integer", - "height": "integer", - "quality": "integer", - "error": None, - } - }, - ), - "altText": None, - } - response = client.assets.update(asset_id="580e63fc8c9a982ac9b8b745") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.assets.update(asset_id="580e63fc8c9a982ac9b8b745") - validate_response(async_response, expected_response, expected_types) - - -async def test_list_folders(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "assetFolders": [ - { - "id": "6390c49774a71f0e3c1a08ee", - "displayName": "emoji icons", - "parentFolder": "6390c49774a71f99f21a08eb", - "assets": ["63e5889e7fe4eafa7384cea4", "659595234426a9fcbad57043"], - "siteId": "6390c49674a71f84b51a08d8", - "createdOn": "2018-10-14T21:55:49Z", - "lastUpdated": "2022-12-07T16:51:37Z", - } - ], - "pagination": {"limit": 1, "offset": 0, "total": 1}, - } - expected_types: typing.Any = { - "assetFolders": ( - "list", - { - 0: { - "id": None, - "displayName": None, - "parentFolder": None, - "assets": ("list", {0: None, 1: None}), - "siteId": None, - "createdOn": "datetime", - "lastUpdated": "datetime", - } - }, - ), - "pagination": {"limit": None, "offset": None, "total": None}, - } - response = client.assets.list_folders(site_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.assets.list_folders(site_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) - - -async def test_create_folder(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "6390c49774a71f0e3c1a08ee", - "displayName": "emoji icons", - "parentFolder": "6390c49774a71f99f21a08eb", - "assets": ["63e5889e7fe4eafa7384cea4", "659595234426a9fcbad57043"], - "siteId": "6390c49674a71f84b51a08d8", - "createdOn": "2018-10-14T21:55:49Z", - "lastUpdated": "2022-12-07T16:51:37Z", - } - expected_types: typing.Any = { - "id": None, - "displayName": None, - "parentFolder": None, - "assets": ("list", {0: None, 1: None}), - "siteId": None, - "createdOn": "datetime", - "lastUpdated": "datetime", - } - response = client.assets.create_folder(site_id="580e63e98c9a982ac9b8b741", display_name="my asset folder") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.assets.create_folder( - site_id="580e63e98c9a982ac9b8b741", display_name="my asset folder" - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_get_folder(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "6390c49774a71f0e3c1a08ee", - "displayName": "emoji icons", - "parentFolder": "6390c49774a71f99f21a08eb", - "assets": ["63e5889e7fe4eafa7384cea4", "659595234426a9fcbad57043"], - "siteId": "6390c49674a71f84b51a08d8", - "createdOn": "2018-10-14T21:55:49Z", - "lastUpdated": "2022-12-07T16:51:37Z", - } - expected_types: typing.Any = { - "id": None, - "displayName": None, - "parentFolder": None, - "assets": ("list", {0: None, 1: None}), - "siteId": None, - "createdOn": "datetime", - "lastUpdated": "datetime", - } - response = client.assets.get_folder(asset_folder_id="6390c49774a71f0e3c1a08ee") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.assets.get_folder(asset_folder_id="6390c49774a71f0e3c1a08ee") - validate_response(async_response, expected_response, expected_types) diff --git a/tests/test_collections.py b/tests/test_collections.py deleted file mode 100644 index 1e76945..0000000 --- a/tests/test_collections.py +++ /dev/null @@ -1,188 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -from webflow import AsyncWebflow -import typing -from .utilities import validate_response - - -async def test_list_(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "collections": [ - { - "id": "63692ab61fb2852f582ba8f5", - "displayName": "Products", - "singularName": "Product", - "slug": "product", - "createdOn": "2019-06-12T13:35:14Z", - "lastUpdated": "2022-11-17T15:08:50Z", - }, - { - "id": "63692ab61fb2856e6a2ba8f6", - "displayName": "Categories", - "singularName": "Category", - "slug": "category", - "createdOn": "2019-06-12T13:35:14Z", - "lastUpdated": "2022-11-17T15:08:50Z", - }, - { - "id": "63692ab61fb285a8562ba8f4", - "displayName": "SKUs", - "singularName": "SKU", - "slug": "sku", - "createdOn": "2019-06-12T13:35:14Z", - "lastUpdated": "2022-11-17T15:08:50Z", - }, - ] - } - expected_types: typing.Any = { - "collections": ( - "list", - { - 0: { - "id": None, - "displayName": None, - "singularName": None, - "slug": None, - "createdOn": "datetime", - "lastUpdated": "datetime", - }, - 1: { - "id": None, - "displayName": None, - "singularName": None, - "slug": None, - "createdOn": "datetime", - "lastUpdated": "datetime", - }, - 2: { - "id": None, - "displayName": None, - "singularName": None, - "slug": None, - "createdOn": "datetime", - "lastUpdated": "datetime", - }, - }, - ) - } - response = client.collections.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.collections.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) - - -async def test_create(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "580e63fc8c9a982ac9b8b745", - "displayName": "Blog Posts", - "singularName": "Blog Post", - "slug": "post", - "createdOn": "2016-10-24T19:41:48Z", - "lastUpdated": "2016-10-24T19:42:38Z", - "fields": [ - { - "id": "23cc2d952d4e4631ffd4345d2743db4e", - "isRequired": True, - "isEditable": True, - "type": "PlainText", - "slug": "name", - "displayName": "Name", - "helpText": "helpText", - } - ], - } - expected_types: typing.Any = { - "id": None, - "displayName": None, - "singularName": None, - "slug": None, - "createdOn": "datetime", - "lastUpdated": "datetime", - "fields": ( - "list", - { - 0: { - "id": None, - "isRequired": None, - "isEditable": None, - "type": None, - "slug": None, - "displayName": None, - "helpText": None, - } - }, - ), - } - response = client.collections.create( - site_id="580e63e98c9a982ac9b8b741", display_name="Blog Posts", singular_name="Blog Post", slug="posts" - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.collections.create( - site_id="580e63e98c9a982ac9b8b741", display_name="Blog Posts", singular_name="Blog Post", slug="posts" - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_get(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "580e63fc8c9a982ac9b8b745", - "displayName": "Blog Posts", - "singularName": "Blog Post", - "slug": "post", - "createdOn": "2016-10-24T19:41:48Z", - "lastUpdated": "2016-10-24T19:42:38Z", - "fields": [ - { - "id": "23cc2d952d4e4631ffd4345d2743db4e", - "isRequired": True, - "isEditable": True, - "type": "PlainText", - "slug": "name", - "displayName": "Name", - "helpText": "helpText", - } - ], - } - expected_types: typing.Any = { - "id": None, - "displayName": None, - "singularName": None, - "slug": None, - "createdOn": "datetime", - "lastUpdated": "datetime", - "fields": ( - "list", - { - 0: { - "id": None, - "isRequired": None, - "isEditable": None, - "type": None, - "slug": None, - "displayName": None, - "helpText": None, - } - }, - ), - } - response = client.collections.get(collection_id="580e63fc8c9a982ac9b8b745") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.collections.get(collection_id="580e63fc8c9a982ac9b8b745") - validate_response(async_response, expected_response, expected_types) - - -async def test_delete(client: Webflow, async_client: AsyncWebflow) -> None: - # Type ignore to avoid mypy complaining about the function not being meant to return a value - assert ( - client.collections.delete(collection_id="580e63fc8c9a982ac9b8b745") # type: ignore[func-returns-value] - is None - ) - - assert ( - await async_client.collections.delete(collection_id="580e63fc8c9a982ac9b8b745") # type: ignore[func-returns-value] - is None - ) diff --git a/tests/test_components.py b/tests/test_components.py deleted file mode 100644 index 2f5a42d..0000000 --- a/tests/test_components.py +++ /dev/null @@ -1,266 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -from webflow import AsyncWebflow -import typing -from .utilities import validate_response -from webflow import TextNodeWrite -from webflow import ComponentInstanceNodePropertyOverridesWrite -from webflow import ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem -from webflow.resources.components import ComponentPropertiesWritePropertiesItem - - -async def test_list_(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "components": [ - { - "id": "6596da6045e56dee495bcbba", - "name": "Primary Button", - "group": "Buttons", - "description": "A default button component that can be used across the site", - "readonly": True, - }, - { - "id": "658205daa3e8206a523b5ad4", - "name": "Secondary Button", - "group": "Buttons", - "description": "A secondary button component that can be used across the site", - "readonly": True, - }, - { - "id": "6258612d1ee792848f805dcf", - "name": "Card", - "group": "Buttons", - "description": "A button component that can be used across the site", - "readonly": True, - }, - { - "id": "68a2b1d1ee792848f805dcf", - "name": "Nav", - "group": "Buttons", - "description": "A button component that can be used across the site", - "readonly": True, - }, - ], - "pagination": {"limit": 20, "offset": 0, "total": 4}, - } - expected_types: typing.Any = { - "components": ( - "list", - { - 0: {"id": None, "name": None, "group": None, "description": None, "readonly": None}, - 1: {"id": None, "name": None, "group": None, "description": None, "readonly": None}, - 2: {"id": None, "name": None, "group": None, "description": None, "readonly": None}, - 3: {"id": None, "name": None, "group": None, "description": None, "readonly": None}, - }, - ), - "pagination": {"limit": None, "offset": None, "total": None}, - } - response = client.components.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.components.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) - - -async def test_get_content(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "componentId": "69118560-d0bc-15fc-bbf8-b8fe5f6535b5", - "nodes": [ - { - "type": "component-instance", - "id": "a245c12d-995b-55ee-5ec7-aa36a6cad623", - "componentId": "nodes", - "propertyOverrides": [{"propertyId": "7dd14c08-2e96-8d3d-2b19-b5c03642a0f0"}], - }, - { - "type": "component-instance", - "id": "a245c12d-995b-55ee-5ec7-aa36a6cad627", - "componentId": "nodes", - "propertyOverrides": [{"propertyId": "7dd14c08-2e96-8d3d-2b19-b5c03642a0f0"}], - }, - { - "type": "component-instance", - "id": "a245c12d-995b-55ee-5ec7-aa36a6cad629", - "componentId": "nodes", - "propertyOverrides": [{"propertyId": "7dd14c08-2e96-8d3d-2b19-b5c03642a0f0"}], - }, - { - "type": "component-instance", - "id": "a245c12d-995b-55ee-5ec7-aa36a6cad631", - "componentId": "6258612d1ee792848f805dcf", - "propertyOverrides": [ - { - "propertyId": "a245c12d-995b-55ee-5ec7-aa36a6cad633", - "type": "Plain Text", - "text": {"text": "Don't Panic!"}, - }, - { - "propertyId": "a245c12d-995b-55ee-5ec7-aa36a6cad635", - "type": "Rich Text", - "text": {"html": "

Always know where your towel is.

"}, - }, - ], - }, - ], - "pagination": {"limit": 4, "offset": 0, "total": 4}, - } - expected_types: typing.Any = { - "componentId": None, - "nodes": ("list", {0: "no_validate", 1: "no_validate", 2: "no_validate", 3: "no_validate"}), - "pagination": {"limit": None, "offset": None, "total": None}, - } - response = client.components.get_content( - site_id="580e63e98c9a982ac9b8b741", - component_id="8505ba55-ef72-629e-f85c-33e4b703d48b", - locale_id="65427cf400e02b306eaa04a0", - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.components.get_content( - site_id="580e63e98c9a982ac9b8b741", - component_id="8505ba55-ef72-629e-f85c-33e4b703d48b", - locale_id="65427cf400e02b306eaa04a0", - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_update_content(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = {"errors": ["errors"]} - expected_types: typing.Any = {"errors": ("list", {0: None})} - response = client.components.update_content( - site_id="580e63e98c9a982ac9b8b741", - component_id="8505ba55-ef72-629e-f85c-33e4b703d48b", - locale_id="65427cf400e02b306eaa04a0", - nodes=[ - TextNodeWrite( - node_id="a245c12d-995b-55ee-5ec7-aa36a6cad623", text="

The Hitchhiker's Guide to the Galaxy

" - ), - TextNodeWrite( - node_id="a245c12d-995b-55ee-5ec7-aa36a6cad627", - text="

Don't Panic!

Always know where your towel is.

", - ), - ComponentInstanceNodePropertyOverridesWrite( - node_id="a245c12d-995b-55ee-5ec7-aa36a6cad629", - property_overrides=[ - ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem( - property_id="7dd14c08-2e96-8d3d-2b19-b5c03642a0f0", - text="

Time is an illusion

", - ), - ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem( - property_id="7dd14c08-2e96-8d3d-2b19-b5c03642a0f1", text="Life, the Universe and Everything" - ), - ], - ), - ], - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.components.update_content( - site_id="580e63e98c9a982ac9b8b741", - component_id="8505ba55-ef72-629e-f85c-33e4b703d48b", - locale_id="65427cf400e02b306eaa04a0", - nodes=[ - TextNodeWrite( - node_id="a245c12d-995b-55ee-5ec7-aa36a6cad623", text="

The Hitchhiker's Guide to the Galaxy

" - ), - TextNodeWrite( - node_id="a245c12d-995b-55ee-5ec7-aa36a6cad627", - text="

Don't Panic!

Always know where your towel is.

", - ), - ComponentInstanceNodePropertyOverridesWrite( - node_id="a245c12d-995b-55ee-5ec7-aa36a6cad629", - property_overrides=[ - ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem( - property_id="7dd14c08-2e96-8d3d-2b19-b5c03642a0f0", - text="

Time is an illusion

", - ), - ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem( - property_id="7dd14c08-2e96-8d3d-2b19-b5c03642a0f1", text="Life, the Universe and Everything" - ), - ], - ), - ], - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_get_properties(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "componentId": "658205daa3e8206a523b5ad4", - "properties": [ - { - "propertyId": "a245c12d-995b-55ee-5ec7-aa36a6cad623", - "type": "Plain Text", - "label": "Title", - "text": {"text": "The Hitchhiker's Guide to the Galaxy"}, - }, - { - "propertyId": "a245c12d-995b-55ee-5ec7-aa36a6cad627", - "type": "Rich Text", - "label": "Content", - "text": {"html": "

Don't Panic!

Always know where your towel is.

"}, - }, - ], - "pagination": {"limit": 2, "offset": 0, "total": 2}, - } - expected_types: typing.Any = { - "componentId": None, - "properties": ( - "list", - { - 0: {"propertyId": None, "type": None, "label": None, "text": {"text": None}}, - 1: {"propertyId": None, "type": None, "label": None, "text": {"html": None}}, - }, - ), - "pagination": {"limit": None, "offset": None, "total": None}, - } - response = client.components.get_properties( - site_id="580e63e98c9a982ac9b8b741", - component_id="8505ba55-ef72-629e-f85c-33e4b703d48b", - locale_id="65427cf400e02b306eaa04a0", - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.components.get_properties( - site_id="580e63e98c9a982ac9b8b741", - component_id="8505ba55-ef72-629e-f85c-33e4b703d48b", - locale_id="65427cf400e02b306eaa04a0", - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_update_properties(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = {"errors": ["errors"]} - expected_types: typing.Any = {"errors": ("list", {0: None})} - response = client.components.update_properties( - site_id="580e63e98c9a982ac9b8b741", - component_id="8505ba55-ef72-629e-f85c-33e4b703d48b", - locale_id="65427cf400e02b306eaa04a0", - properties=[ - ComponentPropertiesWritePropertiesItem( - property_id="a245c12d-995b-55ee-5ec7-aa36a6cad623", text="The Hitchhiker’s Guide to the Galaxy" - ), - ComponentPropertiesWritePropertiesItem( - property_id="a245c12d-995b-55ee-5ec7-aa36a6cad627", - text="

Dont Panic!

Always know where your towel is.

", - ), - ], - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.components.update_properties( - site_id="580e63e98c9a982ac9b8b741", - component_id="8505ba55-ef72-629e-f85c-33e4b703d48b", - locale_id="65427cf400e02b306eaa04a0", - properties=[ - ComponentPropertiesWritePropertiesItem( - property_id="a245c12d-995b-55ee-5ec7-aa36a6cad623", text="The Hitchhiker’s Guide to the Galaxy" - ), - ComponentPropertiesWritePropertiesItem( - property_id="a245c12d-995b-55ee-5ec7-aa36a6cad627", - text="

Dont Panic!

Always know where your towel is.

", - ), - ], - ) - validate_response(async_response, expected_response, expected_types) diff --git a/tests/test_ecommerce.py b/tests/test_ecommerce.py deleted file mode 100644 index b33a06f..0000000 --- a/tests/test_ecommerce.py +++ /dev/null @@ -1,20 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -from webflow import AsyncWebflow -import typing -from .utilities import validate_response - - -async def test_get_settings(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "siteId": "5eb0b5583bf24e2d3a488969", - "createdOn": "2018-10-04T15:21:02Z", - "defaultCurrency": "USD", - } - expected_types: typing.Any = {"siteId": None, "createdOn": "datetime", "defaultCurrency": None} - response = client.ecommerce.get_settings(site_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.ecommerce.get_settings(site_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) diff --git a/tests/test_forms.py b/tests/test_forms.py deleted file mode 100644 index ee88977..0000000 --- a/tests/test_forms.py +++ /dev/null @@ -1,266 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -from webflow import AsyncWebflow -import typing -from .utilities import validate_response - - -async def test_list_(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "forms": [ - { - "displayName": "Email Form", - "createdOn": "2016-10-24T19:41:29Z", - "lastUpdated": "2016-10-24T19:43:17Z", - "fields": { - "0": {"displayName": "Email", "userVisible": True}, - "1": {"displayName": "Email", "userVisible": True}, - }, - "responseSettings": { - "redirectUrl": "https://example.com", - "redirectMethod": "GET", - "sendEmailConfirmation": True, - }, - "id": "589a331aa51e760df7ccb89e", - "siteId": "580e63e98c9a982ac9b8b741", - "siteDomainId": "6419db964a9c436a4baf6248", - "pageId": "6419db964a9c43f6a3af6348", - "pageName": "Home", - "formElementId": "4e038d2c-6a1e-4953-7be9-a59a2b453177", - "workspaceId": "580e63fc8c9a982ac9b8b744", - }, - { - "displayName": "Name Form", - "createdOn": "2016-10-24T19:41:29Z", - "lastUpdated": "2016-10-24T19:43:17Z", - "fields": {"0": {"displayName": "Email", "userVisible": True}}, - "responseSettings": { - "redirectUrl": "https://example.com", - "redirectMethod": "GET", - "sendEmailConfirmation": False, - }, - "id": "580ff8d7ba3e45ba9fe588e9", - "siteId": "580e63e98c9a982ac9b8b741", - "siteDomainId": "6419db964a9c436a4baf6248", - "pageId": "6419db964a9c43f6a3af6348", - "pageName": "Home", - "formElementId": "4e038d2c-6a1e-4953-7be9-a59a2b453177", - "workspaceId": "580e63fc8c9a982ac9b8b744", - }, - ], - "pagination": {"limit": 25, "offset": 0, "total": 2}, - } - expected_types: typing.Any = { - "forms": ( - "list", - { - 0: { - "displayName": None, - "createdOn": "datetime", - "lastUpdated": "datetime", - "fields": ( - "dict", - { - 0: (None, {"displayName": None, "userVisible": None}), - 1: (None, {"displayName": None, "userVisible": None}), - }, - ), - "responseSettings": {"redirectUrl": None, "redirectMethod": None, "sendEmailConfirmation": None}, - "id": None, - "siteId": None, - "siteDomainId": None, - "pageId": None, - "pageName": None, - "formElementId": None, - "workspaceId": None, - }, - 1: { - "displayName": None, - "createdOn": "datetime", - "lastUpdated": "datetime", - "fields": ("dict", {0: (None, {"displayName": None, "userVisible": None})}), - "responseSettings": {"redirectUrl": None, "redirectMethod": None, "sendEmailConfirmation": None}, - "id": None, - "siteId": None, - "siteDomainId": None, - "pageId": None, - "pageName": None, - "formElementId": None, - "workspaceId": None, - }, - }, - ), - "pagination": {"limit": None, "offset": None, "total": None}, - } - response = client.forms.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.forms.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) - - -async def test_get(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "displayName": "Email Form", - "createdOn": "2016-10-24T19:41:29Z", - "lastUpdated": "2016-10-24T19:43:17Z", - "fields": { - "660d5bcc9c0772150459dfb1": { - "displayName": "Name", - "type": "Plain", - "placeholder": "Enter your email", - "userVisible": True, - }, - "589a331aa51e760df7ccb89d": { - "displayName": "Email", - "type": "Email", - "placeholder": "Enter your email", - "userVisible": True, - }, - }, - "responseSettings": { - "redirectUrl": "https://example.com", - "redirectMethod": "GET", - "redirectAction": "POST https://example.com", - "sendEmailConfirmation": True, - }, - "id": "589a331aa51e760df7ccb89e", - "siteId": "580e63e98c9a982ac9b8b741", - "siteDomainId": "6419db964a9c436a4baf6248", - "pageId": "6419db964a9c43f6a3af6348", - "pageName": "Home", - "formElementId": "4e038d2c-6a1e-4953-7be9-a59a2b453177", - "workspaceId": "580e63fc8c9a982ac9b8b744", - } - expected_types: typing.Any = { - "displayName": None, - "createdOn": "datetime", - "lastUpdated": "datetime", - "fields": ( - "dict", - { - 0: (None, {"displayName": None, "type": None, "placeholder": None, "userVisible": None}), - 1: (None, {"displayName": None, "type": None, "placeholder": None, "userVisible": None}), - }, - ), - "responseSettings": { - "redirectUrl": None, - "redirectMethod": None, - "redirectAction": None, - "sendEmailConfirmation": None, - }, - "id": None, - "siteId": None, - "siteDomainId": None, - "pageId": None, - "pageName": None, - "formElementId": None, - "workspaceId": None, - } - response = client.forms.get(form_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.forms.get(form_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) - - -async def test_list_submissions(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "formSubmissions": [ - { - "id": "6321ca84df3949bfc6752327", - "displayName": "Sample Form", - "siteId": "62749158efef318abc8d5a0f", - "workspaceId": "62749158efef318abc8d5a0f", - "dateSubmitted": "2022-09-14T12:35:16Z", - "formResponse": {"First Name": "Arthur", "Last Name": "Dent"}, - }, - { - "id": "660d64fabf6e0a0d4edab981", - "displayName": "Sample Form", - "siteId": "62749158efef318abc8d5a0f", - "workspaceId": "62749158efef318abc8d5a0f", - "dateSubmitted": "2022-09-14T12:35:16Z", - "formResponse": {"First Name": "Ford", "Last Name": "Prefect"}, - }, - ], - "pagination": {"limit": 25, "offset": 0, "total": 2}, - } - expected_types: typing.Any = { - "formSubmissions": ( - "list", - { - 0: { - "id": None, - "displayName": None, - "siteId": None, - "workspaceId": None, - "dateSubmitted": "datetime", - "formResponse": ("dict", {0: (None, None), 1: (None, None)}), - }, - 1: { - "id": None, - "displayName": None, - "siteId": None, - "workspaceId": None, - "dateSubmitted": "datetime", - "formResponse": ("dict", {0: (None, None), 1: (None, None)}), - }, - }, - ), - "pagination": {"limit": None, "offset": None, "total": None}, - } - response = client.forms.list_submissions(form_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.forms.list_submissions(form_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) - - -async def test_get_submission(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "6321ca84df3949bfc6752327", - "displayName": "Sample Form", - "siteId": "62749158efef318abc8d5a0f", - "workspaceId": "62749158efef318abc8d5a0f", - "dateSubmitted": "2022-09-14T12:35:16Z", - "formResponse": {"First Name": "Arthur", "Last Name": "Dent"}, - } - expected_types: typing.Any = { - "id": None, - "displayName": None, - "siteId": None, - "workspaceId": None, - "dateSubmitted": "datetime", - "formResponse": ("dict", {0: (None, None), 1: (None, None)}), - } - response = client.forms.get_submission(form_submission_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.forms.get_submission(form_submission_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) - - -async def test_update_submission(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "6321ca84df3949bfc6752327", - "displayName": "Sample Form", - "siteId": "62749158efef318abc8d5a0f", - "workspaceId": "62749158efef318abc8d5a0f", - "dateSubmitted": "2022-09-14T12:35:16Z", - "formResponse": {"First Name": "Arthur", "Last Name": "Dent"}, - } - expected_types: typing.Any = { - "id": None, - "displayName": None, - "siteId": None, - "workspaceId": None, - "dateSubmitted": "datetime", - "formResponse": ("dict", {0: (None, None), 1: (None, None)}), - } - response = client.forms.update_submission(form_submission_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.forms.update_submission(form_submission_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) diff --git a/tests/test_inventory.py b/tests/test_inventory.py deleted file mode 100644 index a4f1518..0000000 --- a/tests/test_inventory.py +++ /dev/null @@ -1,32 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -from webflow import AsyncWebflow -import typing -from .utilities import validate_response - - -async def test_list_(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = {"id": "5bfedb42bab0ad90fa7dad39", "quantity": 100, "inventoryType": "finite"} - expected_types: typing.Any = {"id": None, "quantity": None, "inventoryType": None} - response = client.inventory.list(collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.inventory.list( - collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754" - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_update(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = {"id": "5bfedb42bab0ad90fa7dad39", "quantity": 100, "inventoryType": "finite"} - expected_types: typing.Any = {"id": None, "quantity": None, "inventoryType": None} - response = client.inventory.update( - collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754", inventory_type="infinite" - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.inventory.update( - collection_id="580e63fc8c9a982ac9b8b745", item_id="580e64008c9a982ac9b8b754", inventory_type="infinite" - ) - validate_response(async_response, expected_response, expected_types) diff --git a/tests/test_orders.py b/tests/test_orders.py deleted file mode 100644 index a874784..0000000 --- a/tests/test_orders.py +++ /dev/null @@ -1,2327 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -from webflow import AsyncWebflow -import typing -from .utilities import validate_response - - -async def test_list_(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "orders": [ - { - "orderId": "7c1-9fd", - "status": "unfulfilled", - "comment": "Customer requested gift wrapping and a personalized note saying: Happy Birthday, Ford! 🎉 Please ensure the item is packed with extra bubble wrap for safe transit.", - "orderComment": 'Please gift wrap with a personal note saying "Happy Birthday, Ford! 🎉', - "acceptedOn": "2024-04-10T13:16:21Z", - "fulfilledOn": "2018-12-03T22:06:15Z", - "refundedOn": "2018-12-03T22:06:15Z", - "disputedOn": "2018-12-03T22:06:15Z", - "disputeUpdatedOn": "2018-12-03T22:06:15Z", - "disputeLastStatus": "warning_needs_response", - "customerPaid": {"unit": "USD", "value": "5892", "string": " 211.55 USD"}, - "netAmount": {"unit": "USD", "value": "5892", "string": " 200.89 USD"}, - "applicationFee": {"unit": "USD", "value": "5892", "string": " 4.23 USD"}, - "allAddresses": [ - { - "type": "billing", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - { - "type": "shipping", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - ], - "shippingAddress": { - "type": "shipping", - "japanType": "kanji", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - "billingAddress": { - "type": "billing", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - "shippingProvider": "Shipping Company, Co.", - "shippingTracking": "tr00000000002", - "shippingTrackingURL": "https://www.shippingcompany.com/tracking/tr00000000002", - "customerInfo": {"fullName": "Arthur Dent", "email": "arthur.dent@example.com"}, - "purchasedItems": [ - { - "count": 2, - "rowTotal": {"unit": "USD", "value": "5892", "string": " 111.22 USD"}, - "productId": "66072fb61b89448912e26791", - "productName": "Luxurious Fresh Ball", - "productSlug": "luxurious-fresh-ball", - "variantId": "66072fb71b89448912e2683f", - "variantName": "Luxurious Fresh Ball Generic: Bronze, Practical: Plastic", - "variantSlug": "luxurious-fresh-ball-generic-bronze-practical-plastic", - "variantSKU": "luxurious-fresh-ball-generic-bronze-practical-plastic", - "variantImage": { - "url": "https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg" - }, - "variantPrice": {"unit": "USD", "value": "5892", "string": " 55.61 USD"}, - "weight": 11, - "width": 82, - "height": 70, - "length": 9, - }, - { - "count": 1, - "rowTotal": {"unit": "USD", "value": "5892", "string": " 83.09 USD"}, - "productId": "66072fb61b89448912e2678b", - "productName": "Incredible Bronze Towels", - "productSlug": "incredible-bronze-towels", - "variantId": "66072fb71b89448912e2681e", - "variantName": "Incredible Bronze Towels Sleek: Frozen, Incredible: Metal", - "variantSlug": "incredible-bronze-towels-sleek-frozen-incredible-metal", - "variantSKU": "incredible-bronze-towels-sleek-frozen-incredible-metal", - "variantImage": { - "url": "https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e26729_image16.jpeg" - }, - "variantPrice": {"unit": "USD", "value": "5892", "string": " 83.09 USD"}, - "width": 19, - "height": 72, - "length": 18, - }, - ], - "purchasedItemsCount": 3, - "stripeDetails": { - "paymentMethod": "pm_1P410gJYFi4lcbXWbeKghqjK", - "paymentIntentId": "pi_3P410iJYFi4lcbXW0EKKgcVg", - "customerId": "cus_Ptod8KJBiiPgnH", - "chargeId": "ch_3P410iJYFi4lcbXW0DxUkzCH", - }, - "stripeCard": { - "last4": "4242", - "brand": "Visa", - "ownerName": "Arthur Dent", - "expires": {"year": 2025, "month": 4}, - }, - "paypalDetails": { - "orderId": "1a2b3c4d5e6f7g8h9i0j", - "payerId": "9k8j7i6h5g4f3e2d1c0b", - "captureId": "qwe123rty456uio789p", - "refundId": "abcde12345fghij67890", - "refundReason": "Customer requested refund", - "disputeId": "zxcvbnm987poiuytrewq", - }, - "customData": [{"key": "value"}], - "metadata": {"isBuyNow": False}, - "isCustomerDeleted": False, - "isShippingRequired": False, - "hasDownloads": False, - "paymentProcessor": "stripe", - "totals": { - "extras": [ - { - "type": "tax", - "name": "State Taxes", - "description": "CA Taxes (6.25%)", - "price": {"unit": "USD", "value": "5892", "string": "3.44"}, - } - ] - }, - "downloadFiles": [ - { - "id": "5e9a5eba75e0ac242e1b6f64", - "name": "The modern web design process - Webflow Ebook.pdf", - "url": "https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa", - } - ], - }, - { - "orderId": "fc7-128", - "status": "refunded", - "comment": "Example comment to myself", - "orderComment": "", - "acceptedOn": "2024-03-29T21:29:21Z", - "fulfilledOn": "2018-12-03T22:06:15Z", - "refundedOn": "2024-04-08T18:25:04Z", - "disputedOn": "2018-12-03T22:06:15Z", - "disputeUpdatedOn": "2018-12-03T22:06:15Z", - "disputeLastStatus": "warning_needs_response", - "customerPaid": {"unit": "USD", "value": "5892", "string": " 118.73 USD"}, - "netAmount": {"unit": "USD", "value": "5892", "string": " 112.62 USD"}, - "applicationFee": {"unit": "USD", "value": "5892", "string": " 2.37 USD"}, - "allAddresses": [ - { - "type": "billing", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - { - "type": "shipping", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - ], - "shippingAddress": { - "type": "shipping", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - "billingAddress": { - "type": "billing", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - "shippingProvider": "Shipping Company, Co.", - "shippingTracking": "tr00000000001", - "shippingTrackingURL": "https://www.shippingcompany.com/tracking/tr00000000001", - "customerInfo": {"fullName": "Arthur Dent", "email": "arthur.dent@example.com"}, - "purchasedItems": [ - { - "count": 1, - "rowTotal": {"unit": "USD", "value": "5892", "string": " 55.61 USD"}, - "productId": "66072fb61b89448912e26791", - "productName": "Luxurious Fresh Ball", - "productSlug": "luxurious-fresh-ball", - "variantId": "66072fb71b89448912e2683f", - "variantName": "Luxurious Fresh Ball Generic: Bronze, Practical: Plastic", - "variantSlug": "luxurious-fresh-ball-generic-bronze-practical-plastic", - "variantSKU": "luxurious-fresh-ball-generic-bronze-practical-plastic", - "variantImage": { - "url": "https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg" - }, - "variantPrice": {"unit": "USD", "value": "5892", "string": " 55.61 USD"}, - "weight": 11, - "width": 82, - "height": 70, - "length": 9, - }, - { - "count": 1, - "rowTotal": {"unit": "USD", "value": "5892", "string": " 53.44 USD"}, - "productId": "66072fb61b89448912e26799", - "productName": "Recycled Steel Gloves", - "productSlug": "recycled-steel-gloves", - "variantId": "66072fb91b89448912e26ab9", - "variantName": "Recycled Steel Gloves Electronic: Granite, Handcrafted: grey", - "variantSlug": "recycled-steel-gloves-electronic-granite-handcrafted-grey", - "variantSKU": "recycled-steel-gloves-electronic-granite-handcrafted-grey", - "variantImage": { - "url": "https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg" - }, - "variantPrice": {"unit": "USD", "value": "5892", "string": " 53.44 USD"}, - "weight": 38, - "width": 76, - "height": 85, - "length": 40, - }, - ], - "purchasedItemsCount": 2, - "stripeDetails": { - "paymentMethod": "pm_1OzmzBJYFi4lcbXWHKNdXU7j", - "paymentIntentId": "pi_3OzmzDJYFi4lcbXW1hTBW6ft", - "customerId": "cus_PpRsNHwWdUoRKR", - "chargeId": "ch_3OzmzDJYFi4lcbXW1ndkkrH2", - "refundId": "re_3OzmzDJYFi4lcbXW1kFAmlBk", - "refundReason": "fraudulent", - }, - "stripeCard": { - "last4": "4242", - "brand": "Visa", - "ownerName": "Arthur Dent", - "expires": {"year": 2024, "month": 4}, - }, - "paypalDetails": { - "orderId": "1a2b3c4d5e6f7g8h9i0j", - "payerId": "9k8j7i6h5g4f3e2d1c0b", - "captureId": "qwe123rty456uio789p", - "refundId": "abcde12345fghij67890", - "refundReason": "Customer requested refund", - "disputeId": "zxcvbnm987poiuytrewq", - }, - "customData": [{"key": "value"}], - "metadata": {"isBuyNow": False}, - "isCustomerDeleted": False, - "isShippingRequired": True, - "hasDownloads": False, - "paymentProcessor": "stripe", - "totals": { - "subtotal": {"unit": "USD", "value": "5892", "string": " 109.05 USD"}, - "extras": [ - { - "type": "tax", - "name": "State Taxes", - "description": "NY Taxes (4.00%)", - "price": {"unit": "USD", "value": "5892", "string": " 4.36 USD"}, - }, - { - "type": "tax", - "name": "City Taxes", - "description": "NEW YORK Taxes (4.88%)", - "price": {"unit": "USD", "value": "5892", "string": " 5.32 USD"}, - }, - { - "type": "shipping", - "name": "Flat", - "description": "", - "price": {"unit": "USD", "value": "5892", "string": " 0.00 USD"}, - }, - ], - "total": {"unit": "USD", "value": "5892", "string": " 118.73 USD"}, - }, - "downloadFiles": [ - { - "id": "5e9a5eba75e0ac242e1b6f64", - "name": "New product guide", - "url": "https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa", - } - ], - }, - ], - "pagination": {"limit": 100, "offset": 0, "total": 2}, - } - expected_types: typing.Any = { - "orders": ( - "list", - { - 0: { - "orderId": None, - "status": None, - "comment": None, - "orderComment": None, - "acceptedOn": "datetime", - "fulfilledOn": "datetime", - "refundedOn": "datetime", - "disputedOn": "datetime", - "disputeUpdatedOn": "datetime", - "disputeLastStatus": None, - "customerPaid": {"unit": None, "value": None, "string": None}, - "netAmount": {"unit": None, "value": None, "string": None}, - "applicationFee": {"unit": None, "value": None, "string": None}, - "allAddresses": ( - "list", - { - 0: { - "type": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - 1: { - "type": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - }, - ), - "shippingAddress": { - "type": None, - "japanType": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - "billingAddress": { - "type": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - "shippingProvider": None, - "shippingTracking": None, - "shippingTrackingURL": None, - "customerInfo": {"fullName": None, "email": None}, - "purchasedItems": ( - "list", - { - 0: { - "count": None, - "rowTotal": {"unit": None, "value": None, "string": None}, - "productId": None, - "productName": None, - "productSlug": None, - "variantId": None, - "variantName": None, - "variantSlug": None, - "variantSKU": None, - "variantImage": {"url": None}, - "variantPrice": {"unit": None, "value": None, "string": None}, - "weight": None, - "width": None, - "height": None, - "length": None, - }, - 1: { - "count": None, - "rowTotal": {"unit": None, "value": None, "string": None}, - "productId": None, - "productName": None, - "productSlug": None, - "variantId": None, - "variantName": None, - "variantSlug": None, - "variantSKU": None, - "variantImage": {"url": None}, - "variantPrice": {"unit": None, "value": None, "string": None}, - "width": None, - "height": None, - "length": None, - }, - }, - ), - "purchasedItemsCount": None, - "stripeDetails": { - "paymentMethod": None, - "paymentIntentId": None, - "customerId": None, - "chargeId": None, - }, - "stripeCard": { - "last4": None, - "brand": None, - "ownerName": None, - "expires": {"year": None, "month": None}, - }, - "paypalDetails": { - "orderId": None, - "payerId": None, - "captureId": None, - "refundId": None, - "refundReason": None, - "disputeId": None, - }, - "customData": ("list", {0: ("dict", {0: (None, None)})}), - "metadata": {"isBuyNow": None}, - "isCustomerDeleted": None, - "isShippingRequired": None, - "hasDownloads": None, - "paymentProcessor": None, - "totals": { - "extras": ( - "list", - { - 0: { - "type": None, - "name": None, - "description": None, - "price": {"unit": None, "value": None, "string": None}, - } - }, - ) - }, - "downloadFiles": ("list", {0: {"id": None, "name": None, "url": None}}), - }, - 1: { - "orderId": None, - "status": None, - "comment": None, - "orderComment": None, - "acceptedOn": "datetime", - "fulfilledOn": "datetime", - "refundedOn": "datetime", - "disputedOn": "datetime", - "disputeUpdatedOn": "datetime", - "disputeLastStatus": None, - "customerPaid": {"unit": None, "value": None, "string": None}, - "netAmount": {"unit": None, "value": None, "string": None}, - "applicationFee": {"unit": None, "value": None, "string": None}, - "allAddresses": ( - "list", - { - 0: { - "type": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - 1: { - "type": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - }, - ), - "shippingAddress": { - "type": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - "billingAddress": { - "type": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - "shippingProvider": None, - "shippingTracking": None, - "shippingTrackingURL": None, - "customerInfo": {"fullName": None, "email": None}, - "purchasedItems": ( - "list", - { - 0: { - "count": None, - "rowTotal": {"unit": None, "value": None, "string": None}, - "productId": None, - "productName": None, - "productSlug": None, - "variantId": None, - "variantName": None, - "variantSlug": None, - "variantSKU": None, - "variantImage": {"url": None}, - "variantPrice": {"unit": None, "value": None, "string": None}, - "weight": None, - "width": None, - "height": None, - "length": None, - }, - 1: { - "count": None, - "rowTotal": {"unit": None, "value": None, "string": None}, - "productId": None, - "productName": None, - "productSlug": None, - "variantId": None, - "variantName": None, - "variantSlug": None, - "variantSKU": None, - "variantImage": {"url": None}, - "variantPrice": {"unit": None, "value": None, "string": None}, - "weight": None, - "width": None, - "height": None, - "length": None, - }, - }, - ), - "purchasedItemsCount": None, - "stripeDetails": { - "paymentMethod": None, - "paymentIntentId": None, - "customerId": None, - "chargeId": None, - "refundId": None, - "refundReason": None, - }, - "stripeCard": { - "last4": None, - "brand": None, - "ownerName": None, - "expires": {"year": None, "month": None}, - }, - "paypalDetails": { - "orderId": None, - "payerId": None, - "captureId": None, - "refundId": None, - "refundReason": None, - "disputeId": None, - }, - "customData": ("list", {0: ("dict", {0: (None, None)})}), - "metadata": {"isBuyNow": None}, - "isCustomerDeleted": None, - "isShippingRequired": None, - "hasDownloads": None, - "paymentProcessor": None, - "totals": { - "subtotal": {"unit": None, "value": None, "string": None}, - "extras": ( - "list", - { - 0: { - "type": None, - "name": None, - "description": None, - "price": {"unit": None, "value": None, "string": None}, - }, - 1: { - "type": None, - "name": None, - "description": None, - "price": {"unit": None, "value": None, "string": None}, - }, - 2: { - "type": None, - "name": None, - "description": None, - "price": {"unit": None, "value": None, "string": None}, - }, - }, - ), - "total": {"unit": None, "value": None, "string": None}, - }, - "downloadFiles": ("list", {0: {"id": None, "name": None, "url": None}}), - }, - }, - ), - "pagination": {"limit": None, "offset": None, "total": None}, - } - response = client.orders.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.orders.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) - - -async def test_get(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "orderId": "fc7-128", - "status": "refunded", - "comment": "Customer requested gift wrapping and a personalized note saying: Happy Birthday, Ford! 🎉 Please ensure the item is packed with extra bubble wrap for safe transit.", - "orderComment": 'Please gift wrap with a personal note saying "Happy Birthday, Ford! 🎉', - "acceptedOn": "2024-03-29T21:29:21Z", - "fulfilledOn": "2024-03-29T21:29:21Z", - "refundedOn": "2024-04-08T18:25:04Z", - "disputedOn": "2024-03-29T21:29:21Z", - "disputeUpdatedOn": "2024-03-29T21:29:21Z", - "disputeLastStatus": "charge_refunded", - "customerPaid": {"unit": "USD", "value": "5892", "string": " 118.73 USD"}, - "netAmount": {"unit": "USD", "value": "5892", "string": " 112.62 USD"}, - "applicationFee": {"unit": "USD", "value": "5892", "string": " 2.37 USD"}, - "allAddresses": [ - { - "type": "billing", - "japanType": "kana", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - { - "type": "shipping", - "japanType": "kana", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - ], - "shippingAddress": { - "type": "shipping", - "japanType": "kanji", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - "billingAddress": { - "type": "billing", - "japanType": "kana", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - "shippingProvider": "Shipping Company, Co.", - "shippingTracking": "tr00000000001", - "shippingTrackingURL": "https://www.shippingcompany.com/tracking/tr00000000001", - "customerInfo": {"fullName": "Arthur Dent", "email": "arthur.dent@example.com"}, - "purchasedItems": [ - { - "count": 1, - "rowTotal": {"unit": "USD", "value": "5892", "string": " 55.61 USD"}, - "productId": "66072fb61b89448912e26791", - "productName": "Luxurious Fresh Ball", - "productSlug": "luxurious-fresh-ball", - "variantId": "66072fb71b89448912e2683f", - "variantName": "Luxurious Fresh Ball Generic: Bronze, Practical: Plastic", - "variantSlug": "luxurious-fresh-ball-generic-bronze-practical-plastic", - "variantSKU": "luxurious-fresh-ball-generic-bronze-practical-plastic", - "variantImage": { - "url": "https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg" - }, - "variantPrice": {"unit": "USD", "value": "5892", "string": " 55.61 USD"}, - "weight": 11, - "width": 82, - "height": 70, - "length": 9, - }, - { - "count": 1, - "rowTotal": {"unit": "USD", "value": "5892", "string": " 53.44 USD"}, - "productId": "66072fb61b89448912e26799", - "productName": "Recycled Steel Gloves", - "productSlug": "recycled-steel-gloves", - "variantId": "66072fb91b89448912e26ab9", - "variantName": "Recycled Steel Gloves Electronic: Granite, Handcrafted: grey", - "variantSlug": "recycled-steel-gloves-electronic-granite-handcrafted-grey", - "variantSKU": "recycled-steel-gloves-electronic-granite-handcrafted-grey", - "variantImage": { - "url": "https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg" - }, - "variantPrice": {"unit": "USD", "value": "5892", "string": " 53.44 USD"}, - "weight": 38, - "width": 76, - "height": 85, - "length": 40, - }, - ], - "purchasedItemsCount": 2, - "stripeDetails": { - "subscriptionId": "sub_1J6xwG2eZvKYlo2CXu9Zt0Tn", - "paymentMethod": "pm_1OzmzBJYFi4lcbXWHKNdXU7j", - "paymentIntentId": "pi_3OzmzDJYFi4lcbXW1hTBW6ft", - "customerId": "cus_PpRsNHwWdUoRKR", - "chargeId": "ch_3OzmzDJYFi4lcbXW1ndkkrH2", - "disputeId": "disputeId", - "refundId": "re_3OzmzDJYFi4lcbXW1kFAmlBk", - "refundReason": "fraudulent", - }, - "stripeCard": { - "last4": "4242", - "brand": "Visa", - "ownerName": "Arthur Dent", - "expires": {"year": 2024, "month": 4}, - }, - "paypalDetails": { - "orderId": "1a2b3c4d5e6f7g8h9i0j", - "payerId": "9k8j7i6h5g4f3e2d1c0b", - "captureId": "qwe123rty456uio789p", - "refundId": "abcde12345fghij67890", - "refundReason": "Customer requested refund", - "disputeId": "zxcvbnm987poiuytrewq", - }, - "customData": [{"key": "value"}], - "metadata": {"isBuyNow": False}, - "isCustomerDeleted": False, - "isShippingRequired": True, - "hasDownloads": False, - "paymentProcessor": "stripe", - "totals": { - "subtotal": {"unit": "USD", "value": "5892", "string": " 109.05 USD"}, - "extras": [ - { - "type": "tax", - "name": "State Taxes", - "description": "NY Taxes (4.00%)", - "price": {"unit": "USD", "value": "5892", "string": " 4.36 USD"}, - }, - { - "type": "tax", - "name": "City Taxes", - "description": "NEW YORK Taxes (4.88%)", - "price": {"unit": "USD", "value": "5892", "string": " 5.32 USD"}, - }, - { - "type": "shipping", - "name": "Flat", - "description": "", - "price": {"unit": "USD", "value": "5892", "string": " 0.00 USD"}, - }, - ], - "total": {"unit": "USD", "value": "5892", "string": " 118.73 USD"}, - }, - "downloadFiles": [ - { - "id": "5e9a5eba75e0ac242e1b6f64", - "name": "New product guide", - "url": "https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa", - } - ], - } - expected_types: typing.Any = { - "orderId": None, - "status": None, - "comment": None, - "orderComment": None, - "acceptedOn": "datetime", - "fulfilledOn": "datetime", - "refundedOn": "datetime", - "disputedOn": "datetime", - "disputeUpdatedOn": "datetime", - "disputeLastStatus": None, - "customerPaid": {"unit": None, "value": None, "string": None}, - "netAmount": {"unit": None, "value": None, "string": None}, - "applicationFee": {"unit": None, "value": None, "string": None}, - "allAddresses": ( - "list", - { - 0: { - "type": None, - "japanType": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - 1: { - "type": None, - "japanType": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - }, - ), - "shippingAddress": { - "type": None, - "japanType": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - "billingAddress": { - "type": None, - "japanType": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - "shippingProvider": None, - "shippingTracking": None, - "shippingTrackingURL": None, - "customerInfo": {"fullName": None, "email": None}, - "purchasedItems": ( - "list", - { - 0: { - "count": None, - "rowTotal": {"unit": None, "value": None, "string": None}, - "productId": None, - "productName": None, - "productSlug": None, - "variantId": None, - "variantName": None, - "variantSlug": None, - "variantSKU": None, - "variantImage": {"url": None}, - "variantPrice": {"unit": None, "value": None, "string": None}, - "weight": None, - "width": None, - "height": None, - "length": None, - }, - 1: { - "count": None, - "rowTotal": {"unit": None, "value": None, "string": None}, - "productId": None, - "productName": None, - "productSlug": None, - "variantId": None, - "variantName": None, - "variantSlug": None, - "variantSKU": None, - "variantImage": {"url": None}, - "variantPrice": {"unit": None, "value": None, "string": None}, - "weight": None, - "width": None, - "height": None, - "length": None, - }, - }, - ), - "purchasedItemsCount": None, - "stripeDetails": { - "subscriptionId": None, - "paymentMethod": None, - "paymentIntentId": None, - "customerId": None, - "chargeId": None, - "disputeId": None, - "refundId": None, - "refundReason": None, - }, - "stripeCard": {"last4": None, "brand": None, "ownerName": None, "expires": {"year": None, "month": None}}, - "paypalDetails": { - "orderId": None, - "payerId": None, - "captureId": None, - "refundId": None, - "refundReason": None, - "disputeId": None, - }, - "customData": ("list", {0: ("dict", {0: (None, None)})}), - "metadata": {"isBuyNow": None}, - "isCustomerDeleted": None, - "isShippingRequired": None, - "hasDownloads": None, - "paymentProcessor": None, - "totals": { - "subtotal": {"unit": None, "value": None, "string": None}, - "extras": ( - "list", - { - 0: { - "type": None, - "name": None, - "description": None, - "price": {"unit": None, "value": None, "string": None}, - }, - 1: { - "type": None, - "name": None, - "description": None, - "price": {"unit": None, "value": None, "string": None}, - }, - 2: { - "type": None, - "name": None, - "description": None, - "price": {"unit": None, "value": None, "string": None}, - }, - }, - ), - "total": {"unit": None, "value": None, "string": None}, - }, - "downloadFiles": ("list", {0: {"id": None, "name": None, "url": None}}), - } - response = client.orders.get(site_id="580e63e98c9a982ac9b8b741", order_id="5e8518516e147040726cc415") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.orders.get( - site_id="580e63e98c9a982ac9b8b741", order_id="5e8518516e147040726cc415" - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_update(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "orderId": "fc7-128", - "status": "refunded", - "comment": "Customer requested gift wrapping and a personalized note saying: Happy Birthday, Ford! 🎉 Please ensure the item is packed with extra bubble wrap for safe transit.", - "orderComment": 'Please gift wrap with a personal note saying "Happy Birthday, Ford! 🎉', - "acceptedOn": "2024-03-29T21:29:21Z", - "fulfilledOn": "2024-03-29T21:29:21Z", - "refundedOn": "2024-04-08T18:25:04Z", - "disputedOn": "2024-03-29T21:29:21Z", - "disputeUpdatedOn": "2024-03-29T21:29:21Z", - "disputeLastStatus": "charge_refunded", - "customerPaid": {"unit": "USD", "value": "5892", "string": " 118.73 USD"}, - "netAmount": {"unit": "USD", "value": "5892", "string": " 112.62 USD"}, - "applicationFee": {"unit": "USD", "value": "5892", "string": " 2.37 USD"}, - "allAddresses": [ - { - "type": "billing", - "japanType": "kana", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - { - "type": "shipping", - "japanType": "kana", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - ], - "shippingAddress": { - "type": "shipping", - "japanType": "kanji", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - "billingAddress": { - "type": "billing", - "japanType": "kana", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - "shippingProvider": "Shipping Company, Co.", - "shippingTracking": "tr00000000001", - "shippingTrackingURL": "https://www.shippingcompany.com/tracking/tr00000000001", - "customerInfo": {"fullName": "Arthur Dent", "email": "arthur.dent@example.com"}, - "purchasedItems": [ - { - "count": 1, - "rowTotal": {"unit": "USD", "value": "5892", "string": " 55.61 USD"}, - "productId": "66072fb61b89448912e26791", - "productName": "Luxurious Fresh Ball", - "productSlug": "luxurious-fresh-ball", - "variantId": "66072fb71b89448912e2683f", - "variantName": "Luxurious Fresh Ball Generic: Bronze, Practical: Plastic", - "variantSlug": "luxurious-fresh-ball-generic-bronze-practical-plastic", - "variantSKU": "luxurious-fresh-ball-generic-bronze-practical-plastic", - "variantImage": { - "url": "https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg" - }, - "variantPrice": {"unit": "USD", "value": "5892", "string": " 55.61 USD"}, - "weight": 11, - "width": 82, - "height": 70, - "length": 9, - }, - { - "count": 1, - "rowTotal": {"unit": "USD", "value": "5892", "string": " 53.44 USD"}, - "productId": "66072fb61b89448912e26799", - "productName": "Recycled Steel Gloves", - "productSlug": "recycled-steel-gloves", - "variantId": "66072fb91b89448912e26ab9", - "variantName": "Recycled Steel Gloves Electronic: Granite, Handcrafted: grey", - "variantSlug": "recycled-steel-gloves-electronic-granite-handcrafted-grey", - "variantSKU": "recycled-steel-gloves-electronic-granite-handcrafted-grey", - "variantImage": { - "url": "https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg" - }, - "variantPrice": {"unit": "USD", "value": "5892", "string": " 53.44 USD"}, - "weight": 38, - "width": 76, - "height": 85, - "length": 40, - }, - ], - "purchasedItemsCount": 2, - "stripeDetails": { - "subscriptionId": "sub_1J6xwG2eZvKYlo2CXu9Zt0Tn", - "paymentMethod": "pm_1OzmzBJYFi4lcbXWHKNdXU7j", - "paymentIntentId": "pi_3OzmzDJYFi4lcbXW1hTBW6ft", - "customerId": "cus_PpRsNHwWdUoRKR", - "chargeId": "ch_3OzmzDJYFi4lcbXW1ndkkrH2", - "disputeId": "disputeId", - "refundId": "re_3OzmzDJYFi4lcbXW1kFAmlBk", - "refundReason": "fraudulent", - }, - "stripeCard": { - "last4": "4242", - "brand": "Visa", - "ownerName": "Arthur Dent", - "expires": {"year": 2024, "month": 4}, - }, - "paypalDetails": { - "orderId": "1a2b3c4d5e6f7g8h9i0j", - "payerId": "9k8j7i6h5g4f3e2d1c0b", - "captureId": "qwe123rty456uio789p", - "refundId": "abcde12345fghij67890", - "refundReason": "Customer requested refund", - "disputeId": "zxcvbnm987poiuytrewq", - }, - "customData": [{"key": "value"}], - "metadata": {"isBuyNow": False}, - "isCustomerDeleted": False, - "isShippingRequired": True, - "hasDownloads": False, - "paymentProcessor": "stripe", - "totals": { - "subtotal": {"unit": "USD", "value": "5892", "string": " 109.05 USD"}, - "extras": [ - { - "type": "tax", - "name": "State Taxes", - "description": "NY Taxes (4.00%)", - "price": {"unit": "USD", "value": "5892", "string": " 4.36 USD"}, - }, - { - "type": "tax", - "name": "City Taxes", - "description": "NEW YORK Taxes (4.88%)", - "price": {"unit": "USD", "value": "5892", "string": " 5.32 USD"}, - }, - { - "type": "shipping", - "name": "Flat", - "description": "", - "price": {"unit": "USD", "value": "5892", "string": " 0.00 USD"}, - }, - ], - "total": {"unit": "USD", "value": "5892", "string": " 118.73 USD"}, - }, - "downloadFiles": [ - { - "id": "5e9a5eba75e0ac242e1b6f64", - "name": "New product guide", - "url": "https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa", - } - ], - } - expected_types: typing.Any = { - "orderId": None, - "status": None, - "comment": None, - "orderComment": None, - "acceptedOn": "datetime", - "fulfilledOn": "datetime", - "refundedOn": "datetime", - "disputedOn": "datetime", - "disputeUpdatedOn": "datetime", - "disputeLastStatus": None, - "customerPaid": {"unit": None, "value": None, "string": None}, - "netAmount": {"unit": None, "value": None, "string": None}, - "applicationFee": {"unit": None, "value": None, "string": None}, - "allAddresses": ( - "list", - { - 0: { - "type": None, - "japanType": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - 1: { - "type": None, - "japanType": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - }, - ), - "shippingAddress": { - "type": None, - "japanType": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - "billingAddress": { - "type": None, - "japanType": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - "shippingProvider": None, - "shippingTracking": None, - "shippingTrackingURL": None, - "customerInfo": {"fullName": None, "email": None}, - "purchasedItems": ( - "list", - { - 0: { - "count": None, - "rowTotal": {"unit": None, "value": None, "string": None}, - "productId": None, - "productName": None, - "productSlug": None, - "variantId": None, - "variantName": None, - "variantSlug": None, - "variantSKU": None, - "variantImage": {"url": None}, - "variantPrice": {"unit": None, "value": None, "string": None}, - "weight": None, - "width": None, - "height": None, - "length": None, - }, - 1: { - "count": None, - "rowTotal": {"unit": None, "value": None, "string": None}, - "productId": None, - "productName": None, - "productSlug": None, - "variantId": None, - "variantName": None, - "variantSlug": None, - "variantSKU": None, - "variantImage": {"url": None}, - "variantPrice": {"unit": None, "value": None, "string": None}, - "weight": None, - "width": None, - "height": None, - "length": None, - }, - }, - ), - "purchasedItemsCount": None, - "stripeDetails": { - "subscriptionId": None, - "paymentMethod": None, - "paymentIntentId": None, - "customerId": None, - "chargeId": None, - "disputeId": None, - "refundId": None, - "refundReason": None, - }, - "stripeCard": {"last4": None, "brand": None, "ownerName": None, "expires": {"year": None, "month": None}}, - "paypalDetails": { - "orderId": None, - "payerId": None, - "captureId": None, - "refundId": None, - "refundReason": None, - "disputeId": None, - }, - "customData": ("list", {0: ("dict", {0: (None, None)})}), - "metadata": {"isBuyNow": None}, - "isCustomerDeleted": None, - "isShippingRequired": None, - "hasDownloads": None, - "paymentProcessor": None, - "totals": { - "subtotal": {"unit": None, "value": None, "string": None}, - "extras": ( - "list", - { - 0: { - "type": None, - "name": None, - "description": None, - "price": {"unit": None, "value": None, "string": None}, - }, - 1: { - "type": None, - "name": None, - "description": None, - "price": {"unit": None, "value": None, "string": None}, - }, - 2: { - "type": None, - "name": None, - "description": None, - "price": {"unit": None, "value": None, "string": None}, - }, - }, - ), - "total": {"unit": None, "value": None, "string": None}, - }, - "downloadFiles": ("list", {0: {"id": None, "name": None, "url": None}}), - } - response = client.orders.update(site_id="580e63e98c9a982ac9b8b741", order_id="5e8518516e147040726cc415") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.orders.update( - site_id="580e63e98c9a982ac9b8b741", order_id="5e8518516e147040726cc415" - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_update_fulfill(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "orderId": "fc7-128", - "status": "refunded", - "comment": "Customer requested gift wrapping and a personalized note saying: Happy Birthday, Ford! 🎉 Please ensure the item is packed with extra bubble wrap for safe transit.", - "orderComment": 'Please gift wrap with a personal note saying "Happy Birthday, Ford! 🎉', - "acceptedOn": "2024-03-29T21:29:21Z", - "fulfilledOn": "2024-03-29T21:29:21Z", - "refundedOn": "2024-04-08T18:25:04Z", - "disputedOn": "2024-03-29T21:29:21Z", - "disputeUpdatedOn": "2024-03-29T21:29:21Z", - "disputeLastStatus": "charge_refunded", - "customerPaid": {"unit": "USD", "value": "5892", "string": " 118.73 USD"}, - "netAmount": {"unit": "USD", "value": "5892", "string": " 112.62 USD"}, - "applicationFee": {"unit": "USD", "value": "5892", "string": " 2.37 USD"}, - "allAddresses": [ - { - "type": "billing", - "japanType": "kana", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - { - "type": "shipping", - "japanType": "kana", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - ], - "shippingAddress": { - "type": "shipping", - "japanType": "kanji", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - "billingAddress": { - "type": "billing", - "japanType": "kana", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - "shippingProvider": "Shipping Company, Co.", - "shippingTracking": "tr00000000001", - "shippingTrackingURL": "https://www.shippingcompany.com/tracking/tr00000000001", - "customerInfo": {"fullName": "Arthur Dent", "email": "arthur.dent@example.com"}, - "purchasedItems": [ - { - "count": 1, - "rowTotal": {"unit": "USD", "value": "5892", "string": " 55.61 USD"}, - "productId": "66072fb61b89448912e26791", - "productName": "Luxurious Fresh Ball", - "productSlug": "luxurious-fresh-ball", - "variantId": "66072fb71b89448912e2683f", - "variantName": "Luxurious Fresh Ball Generic: Bronze, Practical: Plastic", - "variantSlug": "luxurious-fresh-ball-generic-bronze-practical-plastic", - "variantSKU": "luxurious-fresh-ball-generic-bronze-practical-plastic", - "variantImage": { - "url": "https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg" - }, - "variantPrice": {"unit": "USD", "value": "5892", "string": " 55.61 USD"}, - "weight": 11, - "width": 82, - "height": 70, - "length": 9, - }, - { - "count": 1, - "rowTotal": {"unit": "USD", "value": "5892", "string": " 53.44 USD"}, - "productId": "66072fb61b89448912e26799", - "productName": "Recycled Steel Gloves", - "productSlug": "recycled-steel-gloves", - "variantId": "66072fb91b89448912e26ab9", - "variantName": "Recycled Steel Gloves Electronic: Granite, Handcrafted: grey", - "variantSlug": "recycled-steel-gloves-electronic-granite-handcrafted-grey", - "variantSKU": "recycled-steel-gloves-electronic-granite-handcrafted-grey", - "variantImage": { - "url": "https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg" - }, - "variantPrice": {"unit": "USD", "value": "5892", "string": " 53.44 USD"}, - "weight": 38, - "width": 76, - "height": 85, - "length": 40, - }, - ], - "purchasedItemsCount": 2, - "stripeDetails": { - "subscriptionId": "sub_1J6xwG2eZvKYlo2CXu9Zt0Tn", - "paymentMethod": "pm_1OzmzBJYFi4lcbXWHKNdXU7j", - "paymentIntentId": "pi_3OzmzDJYFi4lcbXW1hTBW6ft", - "customerId": "cus_PpRsNHwWdUoRKR", - "chargeId": "ch_3OzmzDJYFi4lcbXW1ndkkrH2", - "disputeId": "disputeId", - "refundId": "re_3OzmzDJYFi4lcbXW1kFAmlBk", - "refundReason": "fraudulent", - }, - "stripeCard": { - "last4": "4242", - "brand": "Visa", - "ownerName": "Arthur Dent", - "expires": {"year": 2024, "month": 4}, - }, - "paypalDetails": { - "orderId": "1a2b3c4d5e6f7g8h9i0j", - "payerId": "9k8j7i6h5g4f3e2d1c0b", - "captureId": "qwe123rty456uio789p", - "refundId": "abcde12345fghij67890", - "refundReason": "Customer requested refund", - "disputeId": "zxcvbnm987poiuytrewq", - }, - "customData": [{"key": "value"}], - "metadata": {"isBuyNow": False}, - "isCustomerDeleted": False, - "isShippingRequired": True, - "hasDownloads": False, - "paymentProcessor": "stripe", - "totals": { - "subtotal": {"unit": "USD", "value": "5892", "string": " 109.05 USD"}, - "extras": [ - { - "type": "tax", - "name": "State Taxes", - "description": "NY Taxes (4.00%)", - "price": {"unit": "USD", "value": "5892", "string": " 4.36 USD"}, - }, - { - "type": "tax", - "name": "City Taxes", - "description": "NEW YORK Taxes (4.88%)", - "price": {"unit": "USD", "value": "5892", "string": " 5.32 USD"}, - }, - { - "type": "shipping", - "name": "Flat", - "description": "", - "price": {"unit": "USD", "value": "5892", "string": " 0.00 USD"}, - }, - ], - "total": {"unit": "USD", "value": "5892", "string": " 118.73 USD"}, - }, - "downloadFiles": [ - { - "id": "5e9a5eba75e0ac242e1b6f64", - "name": "New product guide", - "url": "https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa", - } - ], - } - expected_types: typing.Any = { - "orderId": None, - "status": None, - "comment": None, - "orderComment": None, - "acceptedOn": "datetime", - "fulfilledOn": "datetime", - "refundedOn": "datetime", - "disputedOn": "datetime", - "disputeUpdatedOn": "datetime", - "disputeLastStatus": None, - "customerPaid": {"unit": None, "value": None, "string": None}, - "netAmount": {"unit": None, "value": None, "string": None}, - "applicationFee": {"unit": None, "value": None, "string": None}, - "allAddresses": ( - "list", - { - 0: { - "type": None, - "japanType": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - 1: { - "type": None, - "japanType": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - }, - ), - "shippingAddress": { - "type": None, - "japanType": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - "billingAddress": { - "type": None, - "japanType": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - "shippingProvider": None, - "shippingTracking": None, - "shippingTrackingURL": None, - "customerInfo": {"fullName": None, "email": None}, - "purchasedItems": ( - "list", - { - 0: { - "count": None, - "rowTotal": {"unit": None, "value": None, "string": None}, - "productId": None, - "productName": None, - "productSlug": None, - "variantId": None, - "variantName": None, - "variantSlug": None, - "variantSKU": None, - "variantImage": {"url": None}, - "variantPrice": {"unit": None, "value": None, "string": None}, - "weight": None, - "width": None, - "height": None, - "length": None, - }, - 1: { - "count": None, - "rowTotal": {"unit": None, "value": None, "string": None}, - "productId": None, - "productName": None, - "productSlug": None, - "variantId": None, - "variantName": None, - "variantSlug": None, - "variantSKU": None, - "variantImage": {"url": None}, - "variantPrice": {"unit": None, "value": None, "string": None}, - "weight": None, - "width": None, - "height": None, - "length": None, - }, - }, - ), - "purchasedItemsCount": None, - "stripeDetails": { - "subscriptionId": None, - "paymentMethod": None, - "paymentIntentId": None, - "customerId": None, - "chargeId": None, - "disputeId": None, - "refundId": None, - "refundReason": None, - }, - "stripeCard": {"last4": None, "brand": None, "ownerName": None, "expires": {"year": None, "month": None}}, - "paypalDetails": { - "orderId": None, - "payerId": None, - "captureId": None, - "refundId": None, - "refundReason": None, - "disputeId": None, - }, - "customData": ("list", {0: ("dict", {0: (None, None)})}), - "metadata": {"isBuyNow": None}, - "isCustomerDeleted": None, - "isShippingRequired": None, - "hasDownloads": None, - "paymentProcessor": None, - "totals": { - "subtotal": {"unit": None, "value": None, "string": None}, - "extras": ( - "list", - { - 0: { - "type": None, - "name": None, - "description": None, - "price": {"unit": None, "value": None, "string": None}, - }, - 1: { - "type": None, - "name": None, - "description": None, - "price": {"unit": None, "value": None, "string": None}, - }, - 2: { - "type": None, - "name": None, - "description": None, - "price": {"unit": None, "value": None, "string": None}, - }, - }, - ), - "total": {"unit": None, "value": None, "string": None}, - }, - "downloadFiles": ("list", {0: {"id": None, "name": None, "url": None}}), - } - response = client.orders.update_fulfill(site_id="580e63e98c9a982ac9b8b741", order_id="5e8518516e147040726cc415") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.orders.update_fulfill( - site_id="580e63e98c9a982ac9b8b741", order_id="5e8518516e147040726cc415" - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_update_unfulfill(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "orderId": "fc7-128", - "status": "refunded", - "comment": "Customer requested gift wrapping and a personalized note saying: Happy Birthday, Ford! 🎉 Please ensure the item is packed with extra bubble wrap for safe transit.", - "orderComment": 'Please gift wrap with a personal note saying "Happy Birthday, Ford! 🎉', - "acceptedOn": "2024-03-29T21:29:21Z", - "fulfilledOn": "2024-03-29T21:29:21Z", - "refundedOn": "2024-04-08T18:25:04Z", - "disputedOn": "2024-03-29T21:29:21Z", - "disputeUpdatedOn": "2024-03-29T21:29:21Z", - "disputeLastStatus": "charge_refunded", - "customerPaid": {"unit": "USD", "value": "5892", "string": " 118.73 USD"}, - "netAmount": {"unit": "USD", "value": "5892", "string": " 112.62 USD"}, - "applicationFee": {"unit": "USD", "value": "5892", "string": " 2.37 USD"}, - "allAddresses": [ - { - "type": "billing", - "japanType": "kana", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - { - "type": "shipping", - "japanType": "kana", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - ], - "shippingAddress": { - "type": "shipping", - "japanType": "kanji", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - "billingAddress": { - "type": "billing", - "japanType": "kana", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - "shippingProvider": "Shipping Company, Co.", - "shippingTracking": "tr00000000001", - "shippingTrackingURL": "https://www.shippingcompany.com/tracking/tr00000000001", - "customerInfo": {"fullName": "Arthur Dent", "email": "arthur.dent@example.com"}, - "purchasedItems": [ - { - "count": 1, - "rowTotal": {"unit": "USD", "value": "5892", "string": " 55.61 USD"}, - "productId": "66072fb61b89448912e26791", - "productName": "Luxurious Fresh Ball", - "productSlug": "luxurious-fresh-ball", - "variantId": "66072fb71b89448912e2683f", - "variantName": "Luxurious Fresh Ball Generic: Bronze, Practical: Plastic", - "variantSlug": "luxurious-fresh-ball-generic-bronze-practical-plastic", - "variantSKU": "luxurious-fresh-ball-generic-bronze-practical-plastic", - "variantImage": { - "url": "https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg" - }, - "variantPrice": {"unit": "USD", "value": "5892", "string": " 55.61 USD"}, - "weight": 11, - "width": 82, - "height": 70, - "length": 9, - }, - { - "count": 1, - "rowTotal": {"unit": "USD", "value": "5892", "string": " 53.44 USD"}, - "productId": "66072fb61b89448912e26799", - "productName": "Recycled Steel Gloves", - "productSlug": "recycled-steel-gloves", - "variantId": "66072fb91b89448912e26ab9", - "variantName": "Recycled Steel Gloves Electronic: Granite, Handcrafted: grey", - "variantSlug": "recycled-steel-gloves-electronic-granite-handcrafted-grey", - "variantSKU": "recycled-steel-gloves-electronic-granite-handcrafted-grey", - "variantImage": { - "url": "https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg" - }, - "variantPrice": {"unit": "USD", "value": "5892", "string": " 53.44 USD"}, - "weight": 38, - "width": 76, - "height": 85, - "length": 40, - }, - ], - "purchasedItemsCount": 2, - "stripeDetails": { - "subscriptionId": "sub_1J6xwG2eZvKYlo2CXu9Zt0Tn", - "paymentMethod": "pm_1OzmzBJYFi4lcbXWHKNdXU7j", - "paymentIntentId": "pi_3OzmzDJYFi4lcbXW1hTBW6ft", - "customerId": "cus_PpRsNHwWdUoRKR", - "chargeId": "ch_3OzmzDJYFi4lcbXW1ndkkrH2", - "disputeId": "disputeId", - "refundId": "re_3OzmzDJYFi4lcbXW1kFAmlBk", - "refundReason": "fraudulent", - }, - "stripeCard": { - "last4": "4242", - "brand": "Visa", - "ownerName": "Arthur Dent", - "expires": {"year": 2024, "month": 4}, - }, - "paypalDetails": { - "orderId": "1a2b3c4d5e6f7g8h9i0j", - "payerId": "9k8j7i6h5g4f3e2d1c0b", - "captureId": "qwe123rty456uio789p", - "refundId": "abcde12345fghij67890", - "refundReason": "Customer requested refund", - "disputeId": "zxcvbnm987poiuytrewq", - }, - "customData": [{"key": "value"}], - "metadata": {"isBuyNow": False}, - "isCustomerDeleted": False, - "isShippingRequired": True, - "hasDownloads": False, - "paymentProcessor": "stripe", - "totals": { - "subtotal": {"unit": "USD", "value": "5892", "string": " 109.05 USD"}, - "extras": [ - { - "type": "tax", - "name": "State Taxes", - "description": "NY Taxes (4.00%)", - "price": {"unit": "USD", "value": "5892", "string": " 4.36 USD"}, - }, - { - "type": "tax", - "name": "City Taxes", - "description": "NEW YORK Taxes (4.88%)", - "price": {"unit": "USD", "value": "5892", "string": " 5.32 USD"}, - }, - { - "type": "shipping", - "name": "Flat", - "description": "", - "price": {"unit": "USD", "value": "5892", "string": " 0.00 USD"}, - }, - ], - "total": {"unit": "USD", "value": "5892", "string": " 118.73 USD"}, - }, - "downloadFiles": [ - { - "id": "5e9a5eba75e0ac242e1b6f64", - "name": "New product guide", - "url": "https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa", - } - ], - } - expected_types: typing.Any = { - "orderId": None, - "status": None, - "comment": None, - "orderComment": None, - "acceptedOn": "datetime", - "fulfilledOn": "datetime", - "refundedOn": "datetime", - "disputedOn": "datetime", - "disputeUpdatedOn": "datetime", - "disputeLastStatus": None, - "customerPaid": {"unit": None, "value": None, "string": None}, - "netAmount": {"unit": None, "value": None, "string": None}, - "applicationFee": {"unit": None, "value": None, "string": None}, - "allAddresses": ( - "list", - { - 0: { - "type": None, - "japanType": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - 1: { - "type": None, - "japanType": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - }, - ), - "shippingAddress": { - "type": None, - "japanType": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - "billingAddress": { - "type": None, - "japanType": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - "shippingProvider": None, - "shippingTracking": None, - "shippingTrackingURL": None, - "customerInfo": {"fullName": None, "email": None}, - "purchasedItems": ( - "list", - { - 0: { - "count": None, - "rowTotal": {"unit": None, "value": None, "string": None}, - "productId": None, - "productName": None, - "productSlug": None, - "variantId": None, - "variantName": None, - "variantSlug": None, - "variantSKU": None, - "variantImage": {"url": None}, - "variantPrice": {"unit": None, "value": None, "string": None}, - "weight": None, - "width": None, - "height": None, - "length": None, - }, - 1: { - "count": None, - "rowTotal": {"unit": None, "value": None, "string": None}, - "productId": None, - "productName": None, - "productSlug": None, - "variantId": None, - "variantName": None, - "variantSlug": None, - "variantSKU": None, - "variantImage": {"url": None}, - "variantPrice": {"unit": None, "value": None, "string": None}, - "weight": None, - "width": None, - "height": None, - "length": None, - }, - }, - ), - "purchasedItemsCount": None, - "stripeDetails": { - "subscriptionId": None, - "paymentMethod": None, - "paymentIntentId": None, - "customerId": None, - "chargeId": None, - "disputeId": None, - "refundId": None, - "refundReason": None, - }, - "stripeCard": {"last4": None, "brand": None, "ownerName": None, "expires": {"year": None, "month": None}}, - "paypalDetails": { - "orderId": None, - "payerId": None, - "captureId": None, - "refundId": None, - "refundReason": None, - "disputeId": None, - }, - "customData": ("list", {0: ("dict", {0: (None, None)})}), - "metadata": {"isBuyNow": None}, - "isCustomerDeleted": None, - "isShippingRequired": None, - "hasDownloads": None, - "paymentProcessor": None, - "totals": { - "subtotal": {"unit": None, "value": None, "string": None}, - "extras": ( - "list", - { - 0: { - "type": None, - "name": None, - "description": None, - "price": {"unit": None, "value": None, "string": None}, - }, - 1: { - "type": None, - "name": None, - "description": None, - "price": {"unit": None, "value": None, "string": None}, - }, - 2: { - "type": None, - "name": None, - "description": None, - "price": {"unit": None, "value": None, "string": None}, - }, - }, - ), - "total": {"unit": None, "value": None, "string": None}, - }, - "downloadFiles": ("list", {0: {"id": None, "name": None, "url": None}}), - } - response = client.orders.update_unfulfill(site_id="580e63e98c9a982ac9b8b741", order_id="5e8518516e147040726cc415") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.orders.update_unfulfill( - site_id="580e63e98c9a982ac9b8b741", order_id="5e8518516e147040726cc415" - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_refund(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "orderId": "fc7-128", - "status": "refunded", - "comment": "Customer requested gift wrapping and a personalized note saying: Happy Birthday, Ford! 🎉 Please ensure the item is packed with extra bubble wrap for safe transit.", - "orderComment": 'Please gift wrap with a personal note saying "Happy Birthday, Ford! 🎉', - "acceptedOn": "2024-03-29T21:29:21Z", - "fulfilledOn": "2024-03-29T21:29:21Z", - "refundedOn": "2024-04-08T18:25:04Z", - "disputedOn": "2024-03-29T21:29:21Z", - "disputeUpdatedOn": "2024-03-29T21:29:21Z", - "disputeLastStatus": "charge_refunded", - "customerPaid": {"unit": "USD", "value": "5892", "string": " 118.73 USD"}, - "netAmount": {"unit": "USD", "value": "5892", "string": " 112.62 USD"}, - "applicationFee": {"unit": "USD", "value": "5892", "string": " 2.37 USD"}, - "allAddresses": [ - { - "type": "billing", - "japanType": "kana", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - { - "type": "shipping", - "japanType": "kana", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - ], - "shippingAddress": { - "type": "shipping", - "japanType": "kanji", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - "billingAddress": { - "type": "billing", - "japanType": "kana", - "addressee": "Arthur Dent", - "line1": "20 W 34th St", - "line2": "Empire State Building", - "city": "New York", - "state": "New York", - "country": "US", - "postalCode": "10118", - }, - "shippingProvider": "Shipping Company, Co.", - "shippingTracking": "tr00000000001", - "shippingTrackingURL": "https://www.shippingcompany.com/tracking/tr00000000001", - "customerInfo": {"fullName": "Arthur Dent", "email": "arthur.dent@example.com"}, - "purchasedItems": [ - { - "count": 1, - "rowTotal": {"unit": "USD", "value": "5892", "string": " 55.61 USD"}, - "productId": "66072fb61b89448912e26791", - "productName": "Luxurious Fresh Ball", - "productSlug": "luxurious-fresh-ball", - "variantId": "66072fb71b89448912e2683f", - "variantName": "Luxurious Fresh Ball Generic: Bronze, Practical: Plastic", - "variantSlug": "luxurious-fresh-ball-generic-bronze-practical-plastic", - "variantSKU": "luxurious-fresh-ball-generic-bronze-practical-plastic", - "variantImage": { - "url": "https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2672c_image14.jpeg" - }, - "variantPrice": {"unit": "USD", "value": "5892", "string": " 55.61 USD"}, - "weight": 11, - "width": 82, - "height": 70, - "length": 9, - }, - { - "count": 1, - "rowTotal": {"unit": "USD", "value": "5892", "string": " 53.44 USD"}, - "productId": "66072fb61b89448912e26799", - "productName": "Recycled Steel Gloves", - "productSlug": "recycled-steel-gloves", - "variantId": "66072fb91b89448912e26ab9", - "variantName": "Recycled Steel Gloves Electronic: Granite, Handcrafted: grey", - "variantSlug": "recycled-steel-gloves-electronic-granite-handcrafted-grey", - "variantSKU": "recycled-steel-gloves-electronic-granite-handcrafted-grey", - "variantImage": { - "url": "https://d1otoma47x30pg.cloudfront.net/66072f39417a2a35b2589cc7/66072fb51b89448912e2671e_image2.jpeg" - }, - "variantPrice": {"unit": "USD", "value": "5892", "string": " 53.44 USD"}, - "weight": 38, - "width": 76, - "height": 85, - "length": 40, - }, - ], - "purchasedItemsCount": 2, - "stripeDetails": { - "subscriptionId": "sub_1J6xwG2eZvKYlo2CXu9Zt0Tn", - "paymentMethod": "pm_1OzmzBJYFi4lcbXWHKNdXU7j", - "paymentIntentId": "pi_3OzmzDJYFi4lcbXW1hTBW6ft", - "customerId": "cus_PpRsNHwWdUoRKR", - "chargeId": "ch_3OzmzDJYFi4lcbXW1ndkkrH2", - "disputeId": "disputeId", - "refundId": "re_3OzmzDJYFi4lcbXW1kFAmlBk", - "refundReason": "fraudulent", - }, - "stripeCard": { - "last4": "4242", - "brand": "Visa", - "ownerName": "Arthur Dent", - "expires": {"year": 2024, "month": 4}, - }, - "paypalDetails": { - "orderId": "1a2b3c4d5e6f7g8h9i0j", - "payerId": "9k8j7i6h5g4f3e2d1c0b", - "captureId": "qwe123rty456uio789p", - "refundId": "abcde12345fghij67890", - "refundReason": "Customer requested refund", - "disputeId": "zxcvbnm987poiuytrewq", - }, - "customData": [{"key": "value"}], - "metadata": {"isBuyNow": False}, - "isCustomerDeleted": False, - "isShippingRequired": True, - "hasDownloads": False, - "paymentProcessor": "stripe", - "totals": { - "subtotal": {"unit": "USD", "value": "5892", "string": " 109.05 USD"}, - "extras": [ - { - "type": "tax", - "name": "State Taxes", - "description": "NY Taxes (4.00%)", - "price": {"unit": "USD", "value": "5892", "string": " 4.36 USD"}, - }, - { - "type": "tax", - "name": "City Taxes", - "description": "NEW YORK Taxes (4.88%)", - "price": {"unit": "USD", "value": "5892", "string": " 5.32 USD"}, - }, - { - "type": "shipping", - "name": "Flat", - "description": "", - "price": {"unit": "USD", "value": "5892", "string": " 0.00 USD"}, - }, - ], - "total": {"unit": "USD", "value": "5892", "string": " 118.73 USD"}, - }, - "downloadFiles": [ - { - "id": "5e9a5eba75e0ac242e1b6f64", - "name": "New product guide", - "url": "https://webflow.com/dashboard/download-digital-product?payload=5d93ba5e38c6b0160ab711d3;e7634a;5eb1aac72912ec06f561278c;5e9a5eba75e0ac242e1b6f63:ka2nehxy:4a1ee0a632feaab94294350087215ed89533f2f530903e3b933b638940e921aa", - } - ], - } - expected_types: typing.Any = { - "orderId": None, - "status": None, - "comment": None, - "orderComment": None, - "acceptedOn": "datetime", - "fulfilledOn": "datetime", - "refundedOn": "datetime", - "disputedOn": "datetime", - "disputeUpdatedOn": "datetime", - "disputeLastStatus": None, - "customerPaid": {"unit": None, "value": None, "string": None}, - "netAmount": {"unit": None, "value": None, "string": None}, - "applicationFee": {"unit": None, "value": None, "string": None}, - "allAddresses": ( - "list", - { - 0: { - "type": None, - "japanType": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - 1: { - "type": None, - "japanType": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - }, - ), - "shippingAddress": { - "type": None, - "japanType": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - "billingAddress": { - "type": None, - "japanType": None, - "addressee": None, - "line1": None, - "line2": None, - "city": None, - "state": None, - "country": None, - "postalCode": None, - }, - "shippingProvider": None, - "shippingTracking": None, - "shippingTrackingURL": None, - "customerInfo": {"fullName": None, "email": None}, - "purchasedItems": ( - "list", - { - 0: { - "count": None, - "rowTotal": {"unit": None, "value": None, "string": None}, - "productId": None, - "productName": None, - "productSlug": None, - "variantId": None, - "variantName": None, - "variantSlug": None, - "variantSKU": None, - "variantImage": {"url": None}, - "variantPrice": {"unit": None, "value": None, "string": None}, - "weight": None, - "width": None, - "height": None, - "length": None, - }, - 1: { - "count": None, - "rowTotal": {"unit": None, "value": None, "string": None}, - "productId": None, - "productName": None, - "productSlug": None, - "variantId": None, - "variantName": None, - "variantSlug": None, - "variantSKU": None, - "variantImage": {"url": None}, - "variantPrice": {"unit": None, "value": None, "string": None}, - "weight": None, - "width": None, - "height": None, - "length": None, - }, - }, - ), - "purchasedItemsCount": None, - "stripeDetails": { - "subscriptionId": None, - "paymentMethod": None, - "paymentIntentId": None, - "customerId": None, - "chargeId": None, - "disputeId": None, - "refundId": None, - "refundReason": None, - }, - "stripeCard": {"last4": None, "brand": None, "ownerName": None, "expires": {"year": None, "month": None}}, - "paypalDetails": { - "orderId": None, - "payerId": None, - "captureId": None, - "refundId": None, - "refundReason": None, - "disputeId": None, - }, - "customData": ("list", {0: ("dict", {0: (None, None)})}), - "metadata": {"isBuyNow": None}, - "isCustomerDeleted": None, - "isShippingRequired": None, - "hasDownloads": None, - "paymentProcessor": None, - "totals": { - "subtotal": {"unit": None, "value": None, "string": None}, - "extras": ( - "list", - { - 0: { - "type": None, - "name": None, - "description": None, - "price": {"unit": None, "value": None, "string": None}, - }, - 1: { - "type": None, - "name": None, - "description": None, - "price": {"unit": None, "value": None, "string": None}, - }, - 2: { - "type": None, - "name": None, - "description": None, - "price": {"unit": None, "value": None, "string": None}, - }, - }, - ), - "total": {"unit": None, "value": None, "string": None}, - }, - "downloadFiles": ("list", {0: {"id": None, "name": None, "url": None}}), - } - response = client.orders.refund(site_id="580e63e98c9a982ac9b8b741", order_id="5e8518516e147040726cc415") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.orders.refund( - site_id="580e63e98c9a982ac9b8b741", order_id="5e8518516e147040726cc415" - ) - validate_response(async_response, expected_response, expected_types) diff --git a/tests/test_pages.py b/tests/test_pages.py deleted file mode 100644 index 716c201..0000000 --- a/tests/test_pages.py +++ /dev/null @@ -1,403 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -from webflow import AsyncWebflow -import typing -from .utilities import validate_response -import datetime -from webflow import PageSeo -from webflow import PageOpenGraph -from webflow import TextNodeWrite -from webflow import ComponentInstanceNodePropertyOverridesWrite -from webflow import ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem - - -async def test_list_(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "pages": [ - { - "id": "6596da6045e56dee495bcbba", - "siteId": "6258612d1ee792848f805dcf", - "title": "Guide to the Galaxy", - "slug": "guide-to-the-galaxy", - "parentId": "6419db964a9c435aa3af6251", - "collectionId": "6390c49774a71f12831a08e3", - "createdOn": "2024-03-11T10:42:00Z", - "lastUpdated": "2024-03-11T10:42:42Z", - "archived": False, - "draft": False, - "canBranch": True, - "isBranch": False, - "isMembersOnly": False, - "seo": { - "title": "The Ultimate Hitchhiker's Guide to the Galaxy", - "description": "Everything you need to know about the galaxy, from avoiding Vogon poetry to the importance of towels.", - }, - "openGraph": { - "title": "Explore the Cosmos with The Ultimate Guide", - "titleCopied": False, - "description": "Dive deep into the mysteries of the universe with your guide to everything galactic.", - "descriptionCopied": False, - }, - "localeId": "653fd9af6a07fc9cfd7a5e57", - "publishedPath": "/en-us/guide-to-the-galaxy", - }, - { - "id": "6596da6045e56dee495bcbad", - "siteId": "6258612d1ee792848f805dcf", - "title": "Towel Day Celebrations", - "slug": "towel-day", - "parentId": "6419db964a9c435aa3af6251", - "collectionId": "6390c49774a71f12831a08e3", - "createdOn": "2024-05-25T09:00:00Z", - "lastUpdated": "2024-05-25T09:42:00Z", - "archived": False, - "draft": False, - "canBranch": True, - "isBranch": False, - "isMembersOnly": False, - "seo": { - "title": "Celebrate Towel Day - The Hitchhiker's Guide to the Galaxy", - "description": "A guide to celebrating Towel Day, in honor of the most massively useful thing an interstellar hitchhiker can have.", - }, - "openGraph": { - "title": "Towel Day - Don't Panic", - "titleCopied": False, - "description": "Join the galaxy in celebrating Towel Day, the day dedicated to carrying towels everywhere in memory of Douglas Adams.", - "descriptionCopied": False, - }, - "localeId": "653fd9af6a07fc9cfd7a5e57", - "publishedPath": "/en-us/towel-day", - }, - ], - "pagination": {"limit": 20, "offset": 0, "total": 2}, - } - expected_types: typing.Any = { - "pages": ( - "list", - { - 0: { - "id": None, - "siteId": None, - "title": None, - "slug": None, - "parentId": None, - "collectionId": None, - "createdOn": "datetime", - "lastUpdated": "datetime", - "archived": None, - "draft": None, - "canBranch": None, - "isBranch": None, - "isMembersOnly": None, - "seo": {"title": None, "description": None}, - "openGraph": {"title": None, "titleCopied": None, "description": None, "descriptionCopied": None}, - "localeId": None, - "publishedPath": None, - }, - 1: { - "id": None, - "siteId": None, - "title": None, - "slug": None, - "parentId": None, - "collectionId": None, - "createdOn": "datetime", - "lastUpdated": "datetime", - "archived": None, - "draft": None, - "canBranch": None, - "isBranch": None, - "isMembersOnly": None, - "seo": {"title": None, "description": None}, - "openGraph": {"title": None, "titleCopied": None, "description": None, "descriptionCopied": None}, - "localeId": None, - "publishedPath": None, - }, - }, - ), - "pagination": {"limit": None, "offset": None, "total": None}, - } - response = client.pages.list(site_id="580e63e98c9a982ac9b8b741", locale_id="65427cf400e02b306eaa04a0") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.pages.list( - site_id="580e63e98c9a982ac9b8b741", locale_id="65427cf400e02b306eaa04a0" - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_get_metadata(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "6596da6045e56dee495bcbba", - "siteId": "6258612d1ee792848f805dcf", - "title": "Guide to the Galaxy", - "slug": "guide-to-the-galaxy", - "parentId": "6419db964a9c435aa3af6251", - "collectionId": "6390c49774a71f12831a08e3", - "createdOn": "2024-03-11T10:42:00Z", - "lastUpdated": "2024-03-11T10:42:42Z", - "archived": False, - "draft": False, - "canBranch": True, - "isBranch": False, - "isMembersOnly": False, - "seo": { - "title": "The Ultimate Hitchhiker's Guide to the Galaxy", - "description": "Everything you need to know about the galaxy, from avoiding Vogon poetry to the importance of towels.", - }, - "openGraph": { - "title": "Explore the Cosmos with The Ultimate Guide", - "titleCopied": False, - "description": "Dive deep into the mysteries of the universe with your guide to everything galactic.", - "descriptionCopied": False, - }, - "localeId": "653fd9af6a07fc9cfd7a5e57", - "publishedPath": "/en-us/guide-to-the-galaxy", - } - expected_types: typing.Any = { - "id": None, - "siteId": None, - "title": None, - "slug": None, - "parentId": None, - "collectionId": None, - "createdOn": "datetime", - "lastUpdated": "datetime", - "archived": None, - "draft": None, - "canBranch": None, - "isBranch": None, - "isMembersOnly": None, - "seo": {"title": None, "description": None}, - "openGraph": {"title": None, "titleCopied": None, "description": None, "descriptionCopied": None}, - "localeId": None, - "publishedPath": None, - } - response = client.pages.get_metadata(page_id="63c720f9347c2139b248e552", locale_id="65427cf400e02b306eaa04a0") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.pages.get_metadata( - page_id="63c720f9347c2139b248e552", locale_id="65427cf400e02b306eaa04a0" - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_update_page_settings(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "6596da6045e56dee495bcbba", - "siteId": "6258612d1ee792848f805dcf", - "title": "Guide to the Galaxy", - "slug": "guide-to-the-galaxy", - "parentId": "6419db964a9c435aa3af6251", - "collectionId": "6390c49774a71f12831a08e3", - "createdOn": "2024-03-11T10:42:00Z", - "lastUpdated": "2024-03-11T10:42:42Z", - "archived": False, - "draft": False, - "canBranch": True, - "isBranch": False, - "isMembersOnly": False, - "seo": { - "title": "The Ultimate Hitchhiker's Guide to the Galaxy", - "description": "Everything you need to know about the galaxy, from avoiding Vogon poetry to the importance of towels.", - }, - "openGraph": { - "title": "Explore the Cosmos with The Ultimate Guide", - "titleCopied": False, - "description": "Dive deep into the mysteries of the universe with your guide to everything galactic.", - "descriptionCopied": False, - }, - "localeId": "653fd9af6a07fc9cfd7a5e57", - "publishedPath": "/en-us/guide-to-the-galaxy", - } - expected_types: typing.Any = { - "id": None, - "siteId": None, - "title": None, - "slug": None, - "parentId": None, - "collectionId": None, - "createdOn": "datetime", - "lastUpdated": "datetime", - "archived": None, - "draft": None, - "canBranch": None, - "isBranch": None, - "isMembersOnly": None, - "seo": {"title": None, "description": None}, - "openGraph": {"title": None, "titleCopied": None, "description": None, "descriptionCopied": None}, - "localeId": None, - "publishedPath": None, - } - response = client.pages.update_page_settings( - page_id="63c720f9347c2139b248e552", - locale_id="65427cf400e02b306eaa04a0", - id="6596da6045e56dee495bcbba", - site_id="6258612d1ee792848f805dcf", - title="Guide to the Galaxy", - slug="guide-to-the-galaxy", - created_on=datetime.datetime.fromisoformat("2024-03-11 10:42:00+00:00"), - last_updated=datetime.datetime.fromisoformat("2024-03-11 10:42:42+00:00"), - archived=False, - draft=False, - can_branch=True, - is_branch=False, - seo=PageSeo( - title="The Ultimate Hitchhiker's Guide to the Galaxy", - description="Everything you need to know about the galaxy, from avoiding Vogon poetry to the importance of towels.", - ), - open_graph=PageOpenGraph( - title="Explore the Cosmos with The Ultimate Guide", - title_copied=False, - description="Dive deep into the mysteries of the universe with your guide to everything galactic.", - description_copied=False, - ), - page_locale_id="653fd9af6a07fc9cfd7a5e57", - published_path="/en-us/guide-to-the-galaxy", - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.pages.update_page_settings( - page_id="63c720f9347c2139b248e552", - locale_id="65427cf400e02b306eaa04a0", - id="6596da6045e56dee495bcbba", - site_id="6258612d1ee792848f805dcf", - title="Guide to the Galaxy", - slug="guide-to-the-galaxy", - created_on=datetime.datetime.fromisoformat("2024-03-11 10:42:00+00:00"), - last_updated=datetime.datetime.fromisoformat("2024-03-11 10:42:42+00:00"), - archived=False, - draft=False, - can_branch=True, - is_branch=False, - seo=PageSeo( - title="The Ultimate Hitchhiker's Guide to the Galaxy", - description="Everything you need to know about the galaxy, from avoiding Vogon poetry to the importance of towels.", - ), - open_graph=PageOpenGraph( - title="Explore the Cosmos with The Ultimate Guide", - title_copied=False, - description="Dive deep into the mysteries of the universe with your guide to everything galactic.", - description_copied=False, - ), - page_locale_id="653fd9af6a07fc9cfd7a5e57", - published_path="/en-us/guide-to-the-galaxy", - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_get_content(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "pageId": "658205daa3e8206a523b5ad4", - "nodes": [ - { - "type": "component-instance", - "id": "a245c12d-995b-55ee-5ec7-aa36a6cad623", - "componentId": "nodes", - "propertyOverrides": [{"propertyId": "7dd14c08-2e96-8d3d-2b19-b5c03642a0f0"}], - }, - { - "type": "component-instance", - "id": "a245c12d-995b-55ee-5ec7-aa36a6cad627", - "componentId": "nodes", - "propertyOverrides": [{"propertyId": "7dd14c08-2e96-8d3d-2b19-b5c03642a0f0"}], - }, - { - "type": "component-instance", - "id": "a245c12d-995b-55ee-5ec7-aa36a6cad629", - "componentId": "nodes", - "propertyOverrides": [{"propertyId": "7dd14c08-2e96-8d3d-2b19-b5c03642a0f0"}], - }, - { - "type": "component-instance", - "id": "a245c12d-995b-55ee-5ec7-aa36a6cad631", - "componentId": "6258612d1ee792848f805dcf", - "propertyOverrides": [ - { - "propertyId": "a245c12d-995b-55ee-5ec7-aa36a6cad633", - "type": "Plain Text", - "label": "Catchphrase", - "text": {"text": "Don't Panic!"}, - }, - { - "propertyId": "a245c12d-995b-55ee-5ec7-aa36a6cad635", - "type": "Rich Text", - "label": "Tagline", - "text": {"html": "

Always know where your towel is.

"}, - }, - ], - }, - ], - "pagination": {"limit": 4, "offset": 0, "total": 4}, - } - expected_types: typing.Any = { - "pageId": None, - "nodes": ("list", {0: "no_validate", 1: "no_validate", 2: "no_validate", 3: "no_validate"}), - "pagination": {"limit": None, "offset": None, "total": None}, - } - response = client.pages.get_content(page_id="63c720f9347c2139b248e552", locale_id="65427cf400e02b306eaa04a0") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.pages.get_content( - page_id="63c720f9347c2139b248e552", locale_id="65427cf400e02b306eaa04a0" - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_update_static_content(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = {"errors": ["errors"]} - expected_types: typing.Any = {"errors": ("list", {0: None})} - response = client.pages.update_static_content( - page_id="63c720f9347c2139b248e552", - locale_id="localeId", - nodes=[ - TextNodeWrite( - node_id="a245c12d-995b-55ee-5ec7-aa36a6cad623", text="

The Hitchhiker's Guide to the Galaxy

" - ), - TextNodeWrite( - node_id="a245c12d-995b-55ee-5ec7-aa36a6cad627", - text="

Don't Panic!

Always know where your towel is.

", - ), - ComponentInstanceNodePropertyOverridesWrite( - node_id="a245c12d-995b-55ee-5ec7-aa36a6cad629", - property_overrides=[ - ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem( - property_id="7dd14c08-2e96-8d3d-2b19-b5c03642a0f0", - text="

Time is an illusion

", - ), - ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem( - property_id="7dd14c08-2e96-8d3d-2b19-b5c03642a0f1", text="Life, the Universe and Everything" - ), - ], - ), - ], - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.pages.update_static_content( - page_id="63c720f9347c2139b248e552", - locale_id="localeId", - nodes=[ - TextNodeWrite( - node_id="a245c12d-995b-55ee-5ec7-aa36a6cad623", text="

The Hitchhiker's Guide to the Galaxy

" - ), - TextNodeWrite( - node_id="a245c12d-995b-55ee-5ec7-aa36a6cad627", - text="

Don't Panic!

Always know where your towel is.

", - ), - ComponentInstanceNodePropertyOverridesWrite( - node_id="a245c12d-995b-55ee-5ec7-aa36a6cad629", - property_overrides=[ - ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem( - property_id="7dd14c08-2e96-8d3d-2b19-b5c03642a0f0", - text="

Time is an illusion

", - ), - ComponentInstanceNodePropertyOverridesWritePropertyOverridesItem( - property_id="7dd14c08-2e96-8d3d-2b19-b5c03642a0f1", text="Life, the Universe and Everything" - ), - ], - ), - ], - ) - validate_response(async_response, expected_response, expected_types) diff --git a/tests/test_products.py b/tests/test_products.py deleted file mode 100644 index 03d28db..0000000 --- a/tests/test_products.py +++ /dev/null @@ -1,465 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -from webflow import AsyncWebflow -import typing -from .utilities import validate_response -from webflow import Sku - - -async def test_list_(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "items": [ - { - "product": { - "id": "660eb7a486d1d6e0412292d7", - "cmsLocaleId": "653ad57de882f528b32e810e", - "lastPublished": "2024-04-04T14:24:19Z", - "lastUpdated": "2024-04-04T14:30:19Z", - "createdOn": "2024-04-04T14:22:28Z", - "isArchived": False, - "isDraft": False, - "fieldData": { - "name": "T-Shirt", - "slug": "t-shirt", - "description": "A plain cotton t-shirt.", - "shippable": True, - "sku-properties": [ - { - "id": "Color", - "name": "Color", - "enum": [{"id": "id", "name": "Royal Blue", "slug": "royal-blue"}], - } - ], - }, - }, - "skus": [ - { - "id": "580e63fc8c9a982ac9b8b745", - "cmsLocaleId": "653ad57de882f528b32e810e", - "lastPublished": "2023-03-17T18:47:35Z", - "lastUpdated": "2023-03-17T18:47:35Z", - "createdOn": "2023-03-17T18:47:35Z", - "fieldData": { - "sku-values": {"ff42fee0113744f693a764e3431a9cc2": "64a74715c456e36762fc39a1"}, - "name": "Blue T-shirt", - "slug": "t-shirt-blue", - "price": {"value": 100, "unit": "USD"}, - "quantity": 10, - }, - } - ], - } - ], - "pagination": {"limit": 100, "offset": 0, "total": 100}, - } - expected_types: typing.Any = { - "items": ( - "list", - { - 0: { - "product": { - "id": None, - "cmsLocaleId": None, - "lastPublished": "datetime", - "lastUpdated": "datetime", - "createdOn": "datetime", - "isArchived": None, - "isDraft": None, - "fieldData": { - "name": None, - "slug": None, - "description": None, - "shippable": None, - "sku-properties": ( - "list", - { - 0: { - "id": None, - "name": None, - "enum": ("list", {0: {"id": None, "name": None, "slug": None}}), - } - }, - ), - }, - }, - "skus": ( - "list", - { - 0: { - "id": None, - "cmsLocaleId": None, - "lastPublished": "datetime", - "lastUpdated": "datetime", - "createdOn": "datetime", - "fieldData": { - "sku-values": ("dict", {0: (None, None)}), - "name": None, - "slug": None, - "price": {"value": None, "unit": None}, - "quantity": None, - }, - } - }, - ), - } - }, - ), - "pagination": {"limit": None, "offset": None, "total": None}, - } - response = client.products.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.products.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) - - -async def test_create(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "product": { - "id": "660eb7a486d1d6e0412292d7", - "cmsLocaleId": "653ad57de882f528b32e810e", - "lastPublished": "2024-04-04T14:24:19Z", - "lastUpdated": "2024-04-04T14:30:19Z", - "createdOn": "2024-04-04T14:22:28Z", - "isArchived": False, - "isDraft": False, - "fieldData": { - "name": "T-Shirt", - "slug": "t-shirt", - "description": "A plain cotton t-shirt.", - "shippable": True, - "sku-properties": [ - {"id": "Color", "name": "Color", "enum": [{"id": "id", "name": "Royal Blue", "slug": "royal-blue"}]} - ], - "categories": ["categories"], - "tax-category": "standard-taxable", - "default-sku": "default-sku", - "ec-product-type": "ff42fee0113744f693a764e3431a9cc2", - }, - }, - "skus": [ - { - "id": "580e63fc8c9a982ac9b8b745", - "cmsLocaleId": "653ad57de882f528b32e810e", - "lastPublished": "2023-03-17T18:47:35Z", - "lastUpdated": "2023-03-17T18:47:35Z", - "createdOn": "2023-03-17T18:47:35Z", - "fieldData": { - "sku-values": {"ff42fee0113744f693a764e3431a9cc2": "64a74715c456e36762fc39a1"}, - "name": "Blue T-shirt", - "slug": "t-shirt-blue", - "price": {"value": 100, "unit": "USD"}, - "quantity": 10, - }, - } - ], - } - expected_types: typing.Any = { - "product": { - "id": None, - "cmsLocaleId": None, - "lastPublished": "datetime", - "lastUpdated": "datetime", - "createdOn": "datetime", - "isArchived": None, - "isDraft": None, - "fieldData": { - "name": None, - "slug": None, - "description": None, - "shippable": None, - "sku-properties": ( - "list", - {0: {"id": None, "name": None, "enum": ("list", {0: {"id": None, "name": None, "slug": None}})}}, - ), - "categories": ("list", {0: None}), - "tax-category": None, - "default-sku": None, - "ec-product-type": None, - }, - }, - "skus": ( - "list", - { - 0: { - "id": None, - "cmsLocaleId": None, - "lastPublished": "datetime", - "lastUpdated": "datetime", - "createdOn": "datetime", - "fieldData": { - "sku-values": ("dict", {0: (None, None)}), - "name": None, - "slug": None, - "price": {"value": None, "unit": None}, - "quantity": None, - }, - } - }, - ), - } - response = client.products.create(site_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.products.create(site_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) - - -async def test_get(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "product": { - "id": "660eb7a486d1d6e0412292d7", - "cmsLocaleId": "653ad57de882f528b32e810e", - "lastPublished": "2024-04-04T14:24:19Z", - "lastUpdated": "2024-04-04T14:30:19Z", - "createdOn": "2024-04-04T14:22:28Z", - "isArchived": False, - "isDraft": False, - "fieldData": { - "name": "T-Shirt", - "slug": "t-shirt", - "description": "A plain cotton t-shirt.", - "shippable": True, - "sku-properties": [ - {"id": "Color", "name": "Color", "enum": [{"id": "id", "name": "Royal Blue", "slug": "royal-blue"}]} - ], - "categories": ["categories"], - "tax-category": "standard-taxable", - "default-sku": "default-sku", - "ec-product-type": "ff42fee0113744f693a764e3431a9cc2", - }, - }, - "skus": [ - { - "id": "580e63fc8c9a982ac9b8b745", - "cmsLocaleId": "653ad57de882f528b32e810e", - "lastPublished": "2023-03-17T18:47:35Z", - "lastUpdated": "2023-03-17T18:47:35Z", - "createdOn": "2023-03-17T18:47:35Z", - "fieldData": { - "sku-values": {"ff42fee0113744f693a764e3431a9cc2": "64a74715c456e36762fc39a1"}, - "name": "Blue T-shirt", - "slug": "t-shirt-blue", - "price": {"value": 100, "unit": "USD"}, - "quantity": 10, - }, - } - ], - } - expected_types: typing.Any = { - "product": { - "id": None, - "cmsLocaleId": None, - "lastPublished": "datetime", - "lastUpdated": "datetime", - "createdOn": "datetime", - "isArchived": None, - "isDraft": None, - "fieldData": { - "name": None, - "slug": None, - "description": None, - "shippable": None, - "sku-properties": ( - "list", - {0: {"id": None, "name": None, "enum": ("list", {0: {"id": None, "name": None, "slug": None}})}}, - ), - "categories": ("list", {0: None}), - "tax-category": None, - "default-sku": None, - "ec-product-type": None, - }, - }, - "skus": ( - "list", - { - 0: { - "id": None, - "cmsLocaleId": None, - "lastPublished": "datetime", - "lastUpdated": "datetime", - "createdOn": "datetime", - "fieldData": { - "sku-values": ("dict", {0: (None, None)}), - "name": None, - "slug": None, - "price": {"value": None, "unit": None}, - "quantity": None, - }, - } - }, - ), - } - response = client.products.get(site_id="580e63e98c9a982ac9b8b741", product_id="580e63fc8c9a982ac9b8b745") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.products.get( - site_id="580e63e98c9a982ac9b8b741", product_id="580e63fc8c9a982ac9b8b745" - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_update(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "660eb7a486d1d6e0412292d7", - "cmsLocaleId": "653ad57de882f528b32e810e", - "lastPublished": "2024-04-04T14:24:19Z", - "lastUpdated": "2024-04-04T14:30:19Z", - "createdOn": "2024-04-04T14:22:28Z", - "isArchived": False, - "isDraft": False, - "fieldData": { - "name": "T-Shirt", - "slug": "t-shirt", - "description": "A plain cotton t-shirt.", - "shippable": True, - "sku-properties": [ - {"id": "Color", "name": "Color", "enum": [{"id": "id", "name": "Royal Blue", "slug": "royal-blue"}]} - ], - "categories": ["categories"], - "tax-category": "standard-taxable", - "default-sku": "default-sku", - "ec-product-type": "ff42fee0113744f693a764e3431a9cc2", - }, - } - expected_types: typing.Any = { - "id": None, - "cmsLocaleId": None, - "lastPublished": "datetime", - "lastUpdated": "datetime", - "createdOn": "datetime", - "isArchived": None, - "isDraft": None, - "fieldData": { - "name": None, - "slug": None, - "description": None, - "shippable": None, - "sku-properties": ( - "list", - {0: {"id": None, "name": None, "enum": ("list", {0: {"id": None, "name": None, "slug": None}})}}, - ), - "categories": ("list", {0: None}), - "tax-category": None, - "default-sku": None, - "ec-product-type": None, - }, - } - response = client.products.update(site_id="580e63e98c9a982ac9b8b741", product_id="580e63fc8c9a982ac9b8b745") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.products.update( - site_id="580e63e98c9a982ac9b8b741", product_id="580e63fc8c9a982ac9b8b745" - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_create_sku(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "skus": [ - { - "id": "580e63fc8c9a982ac9b8b745", - "cmsLocaleId": "653ad57de882f528b32e810e", - "lastPublished": "2023-03-17T18:47:35Z", - "lastUpdated": "2023-03-17T18:47:35Z", - "createdOn": "2023-03-17T18:47:35Z", - "fieldData": { - "sku-values": {"ff42fee0113744f693a764e3431a9cc2": "64a74715c456e36762fc39a1"}, - "name": "Blue T-shirt", - "slug": "t-shirt-blue", - "price": {"value": 100, "unit": "USD"}, - "quantity": 10, - }, - } - ] - } - expected_types: typing.Any = { - "skus": ( - "list", - { - 0: { - "id": None, - "cmsLocaleId": None, - "lastPublished": "datetime", - "lastUpdated": "datetime", - "createdOn": "datetime", - "fieldData": { - "sku-values": ("dict", {0: (None, None)}), - "name": None, - "slug": None, - "price": {"value": None, "unit": None}, - "quantity": None, - }, - } - }, - ) - } - response = client.products.create_sku( - site_id="580e63e98c9a982ac9b8b741", product_id="580e63fc8c9a982ac9b8b745", skus=[Sku()] - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.products.create_sku( - site_id="580e63e98c9a982ac9b8b741", product_id="580e63fc8c9a982ac9b8b745", skus=[Sku()] - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_update_sku(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "580e63fc8c9a982ac9b8b745", - "cmsLocaleId": "653ad57de882f528b32e810e", - "lastPublished": "2023-03-17T18:47:35Z", - "lastUpdated": "2023-03-17T18:47:35Z", - "createdOn": "2023-03-17T18:47:35Z", - "fieldData": { - "sku-values": {"ff42fee0113744f693a764e3431a9cc2": "64a74715c456e36762fc39a1"}, - "name": "Blue T-shirt", - "slug": "t-shirt-blue", - "price": {"value": 100, "unit": "USD"}, - "compare-at-price": {"value": 100, "unit": "USD"}, - "ec-sku-billing-method": "one-time", - "ec-sku-subscription-plan": {"interval": "day", "frequency": 1, "trial": 7, "plans": [{}]}, - "track-inventory": True, - "quantity": 10, - }, - } - expected_types: typing.Any = { - "id": None, - "cmsLocaleId": None, - "lastPublished": "datetime", - "lastUpdated": "datetime", - "createdOn": "datetime", - "fieldData": { - "sku-values": ("dict", {0: (None, None)}), - "name": None, - "slug": None, - "price": {"value": None, "unit": None}, - "compare-at-price": {"value": None, "unit": None}, - "ec-sku-billing-method": None, - "ec-sku-subscription-plan": { - "interval": None, - "frequency": None, - "trial": None, - "plans": ("list", {0: {}}), - }, - "track-inventory": None, - "quantity": None, - }, - } - response = client.products.update_sku( - site_id="580e63e98c9a982ac9b8b741", - product_id="580e63fc8c9a982ac9b8b745", - sku_id="5e8518516e147040726cc415", - sku=Sku(), - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.products.update_sku( - site_id="580e63e98c9a982ac9b8b741", - product_id="580e63fc8c9a982ac9b8b745", - sku_id="5e8518516e147040726cc415", - sku=Sku(), - ) - validate_response(async_response, expected_response, expected_types) diff --git a/tests/test_scripts.py b/tests/test_scripts.py deleted file mode 100644 index 6432530..0000000 --- a/tests/test_scripts.py +++ /dev/null @@ -1,157 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -from webflow import AsyncWebflow -import typing -from .utilities import validate_response - - -async def test_list_(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "registeredScripts": [ - { - "id": "alert", - "canCopy": False, - "displayName": "Alert", - "hostedLocation": "https://cdn.webflow.io/.../alert-0.0.1.js", - "integrityHash": "integrityHash", - "createdOn": "2022-10-26T00:28:54.191Z", - "lastUpdated": "lastUpdated", - "version": "0.0.1", - }, - { - "id": "alert", - "canCopy": False, - "displayName": "Alert", - "hostedLocation": "https://cdn.webflow.io/.../alert-0.0.2.js", - "integrityHash": "integrityHash", - "createdOn": "2022-10-26T00:28:54.191Z", - "lastUpdated": "lastUpdated", - "version": "0.0.2", - }, - { - "id": "cms_slider", - "canCopy": True, - "displayName": "CMS Slider", - "hostedLocation": "https://cdn.jsdelivr.net/.../cms_slider.js", - "integrityHash": "sha384-J+YlJ8v0gpaRoKH7SbFbEmxOZlAxLiwNjfSsBhDooGa5roXlPPpXbEevck4J7YZ+", - "createdOn": "2022-10-26T00:28:54.191Z", - "lastUpdated": "lastUpdated", - "version": "1.0.0", - }, - ] - } - expected_types: typing.Any = { - "registeredScripts": ( - "list", - { - 0: { - "id": None, - "canCopy": None, - "displayName": None, - "hostedLocation": None, - "integrityHash": None, - "createdOn": None, - "lastUpdated": None, - "version": None, - }, - 1: { - "id": None, - "canCopy": None, - "displayName": None, - "hostedLocation": None, - "integrityHash": None, - "createdOn": None, - "lastUpdated": None, - "version": None, - }, - 2: { - "id": None, - "canCopy": None, - "displayName": None, - "hostedLocation": None, - "integrityHash": None, - "createdOn": None, - "lastUpdated": None, - "version": None, - }, - }, - ) - } - response = client.scripts.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.scripts.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) - - -async def test_register_hosted(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "cms_slider", - "canCopy": True, - "displayName": "CMS Slider", - "hostedLocation": "https://cdn.jsdelivr.net/.../cmsslider.js", - "integrityHash": "sha384-J+YlJ8v0gpaRoKH7SbFbEmxOZlAxLiwNjfSsBhDooGa5roXlPPpXbEevck4J7YZ+", - "createdOn": "2022-10-26T00:28:54.191Z", - "lastUpdated": "lastUpdated", - "version": "1.0.0", - } - expected_types: typing.Any = { - "id": None, - "canCopy": None, - "displayName": None, - "hostedLocation": None, - "integrityHash": None, - "createdOn": None, - "lastUpdated": None, - "version": None, - } - response = client.scripts.register_hosted( - site_id="580e63e98c9a982ac9b8b741", - hosted_location="hostedLocation", - integrity_hash="integrityHash", - version="version", - display_name="displayName", - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.scripts.register_hosted( - site_id="580e63e98c9a982ac9b8b741", - hosted_location="hostedLocation", - integrity_hash="integrityHash", - version="version", - display_name="displayName", - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_register_inline(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "alert", - "canCopy": False, - "displayName": "Alert", - "hostedLocation": "https://uploads-ssl.webflow.com/6258612d1ee792848f805dcf%2F64b6c769ff52ba6c3d904a91%2F660d6e15b3d1696f2d2b1447%2Falert-0.0.1.js", - "integrityHash": "integrityHash", - "createdOn": "2022-10-26T00:28:54.191Z", - "lastUpdated": "lastUpdated", - "version": "0.0.1", - } - expected_types: typing.Any = { - "id": None, - "canCopy": None, - "displayName": None, - "hostedLocation": None, - "integrityHash": None, - "createdOn": None, - "lastUpdated": None, - "version": None, - } - response = client.scripts.register_inline( - site_id="580e63e98c9a982ac9b8b741", source_code="alert('hello world');", version="0.0.1", display_name="Alert" - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.scripts.register_inline( - site_id="580e63e98c9a982ac9b8b741", source_code="alert('hello world');", version="0.0.1", display_name="Alert" - ) - validate_response(async_response, expected_response, expected_types) diff --git a/tests/test_sites.py b/tests/test_sites.py deleted file mode 100644 index 6e9dd9b..0000000 --- a/tests/test_sites.py +++ /dev/null @@ -1,637 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -from webflow import AsyncWebflow -import typing -from .utilities import validate_response - - -async def test_create(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "670ecf86817e3cc7a510eb6a", - "workspaceId": "625860a7a6c16d624927122f", - "createdOn": "2024-10-15T20:24:38Z", - "displayName": "The Hitchiker‘s Guide", - "shortName": "hitchikers-guide", - "lastPublished": "2016-10-24T19:43:17Z", - "lastUpdated": "2024-10-15T20:24:38Z", - "previewUrl": "https://d1otoma47x30pg.cloudfront.net/580e63e98c9a982ac9b8b741/201610241243.png", - "timeZone": "America/Los_Angeles", - "parentFolderId": "670ece123598db72d9648be1", - "customDomains": [ - {"id": "589a331aa51e760df7ccb89d", "url": "test-api-domain.com", "lastPublished": "2022-12-07T16:51:37Z"} - ], - "locales": { - "primary": { - "id": "653fd9af6a07fc9cfd7a5e57", - "cmsLocaleId": "653ad57de882f528b32e810e", - "enabled": False, - "displayName": "English (United States)", - "displayImageId": "displayImageId", - "redirect": True, - "subdirectory": "", - "tag": "en-US", - }, - "secondary": [ - { - "id": "653fd9af6a07fc9cfd7a5e57", - "cmsLocaleId": "653ad57de882f528b32e810e", - "enabled": False, - "displayName": "English (United States)", - "redirect": True, - "subdirectory": "", - "tag": "en-US", - } - ], - }, - "dataCollectionEnabled": False, - "dataCollectionType": "always", - } - expected_types: typing.Any = { - "id": None, - "workspaceId": None, - "createdOn": "datetime", - "displayName": None, - "shortName": None, - "lastPublished": "datetime", - "lastUpdated": "datetime", - "previewUrl": None, - "timeZone": None, - "parentFolderId": None, - "customDomains": ("list", {0: {"id": None, "url": None, "lastPublished": "datetime"}}), - "locales": { - "primary": { - "id": None, - "cmsLocaleId": None, - "enabled": None, - "displayName": None, - "displayImageId": None, - "redirect": None, - "subdirectory": None, - "tag": None, - }, - "secondary": ( - "list", - { - 0: { - "id": None, - "cmsLocaleId": None, - "enabled": None, - "displayName": None, - "redirect": None, - "subdirectory": None, - "tag": None, - } - }, - ), - }, - "dataCollectionEnabled": None, - "dataCollectionType": None, - } - response = client.sites.create(workspace_id="580e63e98c9a982ac9b8b741", name="The Hitchhiker's Guide to the Galaxy") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.sites.create( - workspace_id="580e63e98c9a982ac9b8b741", name="The Hitchhiker's Guide to the Galaxy" - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_list_(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "sites": [ - { - "id": "42e63e98c9a982ac9b8b741", - "workspaceId": "42e63fc8c9a982ac9b8b744", - "createdOn": "1979-10-12T12:00:00Z", - "displayName": "Heart of Gold Spaceship", - "shortName": "heart-of-gold", - "lastPublished": "2023-04-02T12:42:00Z", - "lastUpdated": "2016-10-24T19:43:17Z", - "previewUrl": "https://d1otoma47x30pg.cloudfront.net/42e63e98c9a982ac9b8b741/197910121200.png", - "timeZone": "DeepSpace/InfiniteImprobability", - "parentFolderId": "1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6", - "customDomains": [ - { - "id": "589a331aa51e760df7ccb89e", - "url": "heartofgold.galaxy", - "lastPublished": "2022-12-07T16:51:37Z", - } - ], - "locales": { - "primary": { - "id": "653fd9af6a07fc9cfd7a5e57", - "cmsLocaleId": "653ad57de882f528b32e810e", - "enabled": True, - "displayName": "English - Heart of Gold Standard", - "redirect": False, - "subdirectory": "/en", - "tag": "The Ultimate Answer", - }, - "secondary": [ - { - "id": "653fd9af6a07fc9cfd7a5e58", - "cmsLocaleId": "653ad57de882f528b32e810g", - "enabled": True, - "displayName": "Betelgeusian - Vogon Liaison", - "redirect": True, - "subdirectory": "/bet", - "tag": "Vogon", - }, - { - "id": "653fd9af6a07fc9cfd7a5e59", - "cmsLocaleId": "653ad57de882f528b32e810h", - "enabled": False, - "displayName": "Magrathean - Custom Planet Designs", - "redirect": True, - "subdirectory": "/mg", - "tag": "Magrathean", - }, - ], - }, - "dataCollectionEnabled": True, - "dataCollectionType": "always", - }, - { - "id": "42e63e98c9a982ac9b8b742", - "workspaceId": "42e63fc8c9a982ac9b8b745", - "createdOn": "1981-10-12T12:00:00Z", - "displayName": "Marvin's Personal Blog", - "shortName": "paranoid-android", - "lastPublished": "2023-04-02T12:45:00Z", - "lastUpdated": "2016-10-24T19:43:17Z", - "previewUrl": "https://d1otoma47x30pg.cloudfront.net/42e63e98c9a982ac9b8b742/198110121200.png", - "timeZone": "DeepSpace/Depression", - "parentFolderId": "1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6", - "customDomains": [ - {"id": "589a331aa51e760df7ccb89f", "url": "marvin.blog", "lastPublished": "2022-12-07T16:51:37Z"} - ], - "locales": { - "primary": { - "id": "653fd9af6a07fc9cfd7a5e57", - "cmsLocaleId": "653ad57de882f528b32e810e", - "enabled": True, - "displayName": "English - Marvin's Musings", - "redirect": False, - "subdirectory": "/en", - "tag": "English", - }, - "secondary": [ - { - "id": "653fd9af6a07fc9cfd7a5e56", - "cmsLocaleId": "653ad57de882f528b32e810f", - "enabled": True, - "displayName": "Squornshellous - Mattress Speak", - "redirect": True, - "subdirectory": "/sr", - "tag": "Squornshellous", - } - ], - }, - "dataCollectionEnabled": True, - "dataCollectionType": "always", - }, - { - "id": "42e63e98c9a982ac9b8b743", - "workspaceId": "42e63fc8c9a982ac9b8b746", - "createdOn": "1982-10-12T12:00:00Z", - "displayName": "Vogon Poetry Archive", - "shortName": "vogon-poetry", - "lastPublished": "2023-04-02T12:50:00Z", - "lastUpdated": "2016-10-24T19:43:17Z", - "previewUrl": "https://d1otoma47x30pg.cloudfront.net/42e63e98c9a982ac9b8b743/198210121200.png", - "timeZone": "Vogsphere/PoetryHall", - "parentFolderId": "1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6", - "customDomains": [ - { - "id": "589a331aa51e760df7ccb8a0", - "url": "vogonpoetry.galaxy", - "lastPublished": "2022-12-07T16:51:37Z", - } - ], - "locales": { - "primary": { - "id": "653fd9af6a07fc9cfd7a5e55", - "cmsLocaleId": "653ad57de882f528b32e810d", - "enabled": True, - "displayName": "English - Vogon Verse", - "redirect": False, - "subdirectory": "/en", - "tag": "Third Worst Poetry", - }, - "secondary": [ - { - "id": "653fd9af6a07fc9cfd7a5e54", - "cmsLocaleId": "653ad57de882f528b32e810c", - "enabled": True, - "displayName": "Galactic - Universal Language", - "redirect": True, - "subdirectory": "/gl", - "tag": "Pan-Galactic Gargle Blaster", - } - ], - }, - "dataCollectionEnabled": True, - "dataCollectionType": "always", - }, - ] - } - expected_types: typing.Any = { - "sites": ( - "list", - { - 0: { - "id": None, - "workspaceId": None, - "createdOn": "datetime", - "displayName": None, - "shortName": None, - "lastPublished": "datetime", - "lastUpdated": "datetime", - "previewUrl": None, - "timeZone": None, - "parentFolderId": None, - "customDomains": ("list", {0: {"id": None, "url": None, "lastPublished": "datetime"}}), - "locales": { - "primary": { - "id": None, - "cmsLocaleId": None, - "enabled": None, - "displayName": None, - "redirect": None, - "subdirectory": None, - "tag": None, - }, - "secondary": ( - "list", - { - 0: { - "id": None, - "cmsLocaleId": None, - "enabled": None, - "displayName": None, - "redirect": None, - "subdirectory": None, - "tag": None, - }, - 1: { - "id": None, - "cmsLocaleId": None, - "enabled": None, - "displayName": None, - "redirect": None, - "subdirectory": None, - "tag": None, - }, - }, - ), - }, - "dataCollectionEnabled": None, - "dataCollectionType": None, - }, - 1: { - "id": None, - "workspaceId": None, - "createdOn": "datetime", - "displayName": None, - "shortName": None, - "lastPublished": "datetime", - "lastUpdated": "datetime", - "previewUrl": None, - "timeZone": None, - "parentFolderId": None, - "customDomains": ("list", {0: {"id": None, "url": None, "lastPublished": "datetime"}}), - "locales": { - "primary": { - "id": None, - "cmsLocaleId": None, - "enabled": None, - "displayName": None, - "redirect": None, - "subdirectory": None, - "tag": None, - }, - "secondary": ( - "list", - { - 0: { - "id": None, - "cmsLocaleId": None, - "enabled": None, - "displayName": None, - "redirect": None, - "subdirectory": None, - "tag": None, - } - }, - ), - }, - "dataCollectionEnabled": None, - "dataCollectionType": None, - }, - 2: { - "id": None, - "workspaceId": None, - "createdOn": "datetime", - "displayName": None, - "shortName": None, - "lastPublished": "datetime", - "lastUpdated": "datetime", - "previewUrl": None, - "timeZone": None, - "parentFolderId": None, - "customDomains": ("list", {0: {"id": None, "url": None, "lastPublished": "datetime"}}), - "locales": { - "primary": { - "id": None, - "cmsLocaleId": None, - "enabled": None, - "displayName": None, - "redirect": None, - "subdirectory": None, - "tag": None, - }, - "secondary": ( - "list", - { - 0: { - "id": None, - "cmsLocaleId": None, - "enabled": None, - "displayName": None, - "redirect": None, - "subdirectory": None, - "tag": None, - } - }, - ), - }, - "dataCollectionEnabled": None, - "dataCollectionType": None, - }, - }, - ) - } - response = client.sites.list() - validate_response(response, expected_response, expected_types) - - async_response = await async_client.sites.list() - validate_response(async_response, expected_response, expected_types) - - -async def test_get(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "42e98c9a982ac9b8b742", - "workspaceId": "42e63e98c9a982ac9b8b742", - "createdOn": "1979-10-12T12:00:00Z", - "displayName": "The Hitchhiker's Guide to the Galaxy", - "shortName": "hitchhikers-guide", - "lastPublished": "2023-04-02T12:42:00Z", - "lastUpdated": "2023-04-02T12:42:00Z", - "previewUrl": "https://screenshots.webflow.com/sites/6258612d1ee792848f805dcf/20231219211811_d5990556c743f33b7071300a03bf67e6.png", - "timeZone": "Magrathea/FactoryFloor", - "parentFolderId": "1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6", - "customDomains": [ - { - "id": "589a331aa51e760df7ccb89d", - "url": "hitchhikersguide.galaxy", - "lastPublished": "2022-12-07T16:51:37Z", - }, - {"id": "589a331aa51e760df7ccb89e", "url": "heartofgold.spaceship", "lastPublished": "2022-12-07T16:51:37Z"}, - ], - "locales": { - "primary": { - "id": "653fd9af6a07fc9cfd7a5e57", - "cmsLocaleId": "653ad57de882f528b32e810e", - "enabled": False, - "displayName": "English (United States)", - "displayImageId": "displayImageId", - "redirect": True, - "subdirectory": "", - "tag": "en-US", - }, - "secondary": [ - { - "id": "653fd9af6a07fc9cfd7a5e57", - "cmsLocaleId": "653ad57de882f528b32e810e", - "enabled": False, - "displayName": "English (United States)", - "redirect": True, - "subdirectory": "", - "tag": "en-US", - } - ], - }, - "dataCollectionEnabled": True, - "dataCollectionType": "always", - } - expected_types: typing.Any = { - "id": None, - "workspaceId": None, - "createdOn": "datetime", - "displayName": None, - "shortName": None, - "lastPublished": "datetime", - "lastUpdated": "datetime", - "previewUrl": None, - "timeZone": None, - "parentFolderId": None, - "customDomains": ( - "list", - { - 0: {"id": None, "url": None, "lastPublished": "datetime"}, - 1: {"id": None, "url": None, "lastPublished": "datetime"}, - }, - ), - "locales": { - "primary": { - "id": None, - "cmsLocaleId": None, - "enabled": None, - "displayName": None, - "displayImageId": None, - "redirect": None, - "subdirectory": None, - "tag": None, - }, - "secondary": ( - "list", - { - 0: { - "id": None, - "cmsLocaleId": None, - "enabled": None, - "displayName": None, - "redirect": None, - "subdirectory": None, - "tag": None, - } - }, - ), - }, - "dataCollectionEnabled": None, - "dataCollectionType": None, - } - response = client.sites.get(site_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.sites.get(site_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) - - -async def test_delete(client: Webflow, async_client: AsyncWebflow) -> None: - # Type ignore to avoid mypy complaining about the function not being meant to return a value - assert ( - client.sites.delete(site_id="580e63e98c9a982ac9b8b741") # type: ignore[func-returns-value] - is None - ) - - assert ( - await async_client.sites.delete(site_id="580e63e98c9a982ac9b8b741") # type: ignore[func-returns-value] - is None - ) - - -async def test_update(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "42e98c9a982ac9b8b742", - "workspaceId": "42e63e98c9a982ac9b8b742", - "createdOn": "1979-10-12T12:00:00Z", - "displayName": "The Hitchhiker's Guide to the Galaxy", - "shortName": "hitchhikers-guide", - "lastPublished": "2023-04-02T12:42:00Z", - "lastUpdated": "2023-04-02T12:42:00Z", - "previewUrl": "https://screenshots.webflow.com/sites/6258612d1ee792848f805dcf/20231219211811_d5990556c743f33b7071300a03bf67e6.png", - "timeZone": "Magrathea/FactoryFloor", - "parentFolderId": "1as2d3f4g5h6j7k8l9z0x1c2v3b4n5m6", - "customDomains": [ - { - "id": "589a331aa51e760df7ccb89d", - "url": "hitchhikersguide.galaxy", - "lastPublished": "2022-12-07T16:51:37Z", - }, - {"id": "589a331aa51e760df7ccb89e", "url": "heartofgold.spaceship", "lastPublished": "2022-12-07T16:51:37Z"}, - ], - "locales": { - "primary": { - "id": "653fd9af6a07fc9cfd7a5e57", - "cmsLocaleId": "653ad57de882f528b32e810e", - "enabled": False, - "displayName": "English (United States)", - "displayImageId": "displayImageId", - "redirect": True, - "subdirectory": "", - "tag": "en-US", - }, - "secondary": [ - { - "id": "653fd9af6a07fc9cfd7a5e57", - "cmsLocaleId": "653ad57de882f528b32e810e", - "enabled": False, - "displayName": "English (United States)", - "redirect": True, - "subdirectory": "", - "tag": "en-US", - } - ], - }, - "dataCollectionEnabled": True, - "dataCollectionType": "always", - } - expected_types: typing.Any = { - "id": None, - "workspaceId": None, - "createdOn": "datetime", - "displayName": None, - "shortName": None, - "lastPublished": "datetime", - "lastUpdated": "datetime", - "previewUrl": None, - "timeZone": None, - "parentFolderId": None, - "customDomains": ( - "list", - { - 0: {"id": None, "url": None, "lastPublished": "datetime"}, - 1: {"id": None, "url": None, "lastPublished": "datetime"}, - }, - ), - "locales": { - "primary": { - "id": None, - "cmsLocaleId": None, - "enabled": None, - "displayName": None, - "displayImageId": None, - "redirect": None, - "subdirectory": None, - "tag": None, - }, - "secondary": ( - "list", - { - 0: { - "id": None, - "cmsLocaleId": None, - "enabled": None, - "displayName": None, - "redirect": None, - "subdirectory": None, - "tag": None, - } - }, - ), - }, - "dataCollectionEnabled": None, - "dataCollectionType": None, - } - response = client.sites.update(site_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.sites.update(site_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) - - -async def test_get_custom_domain(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "customDomains": [ - { - "id": "589a331aa51e760df7ccb89d", - "url": "hitchhikersguide.galaxy", - "lastPublished": "2022-12-07T16:51:37Z", - }, - {"id": "589a331aa51e760df7ccb89e", "url": "heartofgold.spaceship", "lastPublished": "2022-12-07T16:51:37Z"}, - ] - } - expected_types: typing.Any = { - "customDomains": ( - "list", - { - 0: {"id": None, "url": None, "lastPublished": "datetime"}, - 1: {"id": None, "url": None, "lastPublished": "datetime"}, - }, - ) - } - response = client.sites.get_custom_domain(site_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.sites.get_custom_domain(site_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) - - -async def test_publish(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "customDomains": [ - {"id": "589a331aa51e760df7ccb89d", "url": "test-api-domain.com", "lastPublished": "2022-12-07T16:51:37Z"} - ], - "publishToWebflowSubdomain": True, - } - expected_types: typing.Any = { - "customDomains": ("list", {0: {"id": None, "url": None, "lastPublished": "datetime"}}), - "publishToWebflowSubdomain": None, - } - response = client.sites.publish(site_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.sites.publish(site_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) diff --git a/tests/test_token.py b/tests/test_token.py deleted file mode 100644 index d57ee3b..0000000 --- a/tests/test_token.py +++ /dev/null @@ -1,66 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -from webflow import AsyncWebflow -import typing -from .utilities import validate_response - - -async def test_authorized_by(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "545bbecb7bdd6769632504a7", - "email": "some@email.com", - "firstName": "Some", - "lastName": "One", - } - expected_types: typing.Any = {"id": None, "email": None, "firstName": None, "lastName": None} - response = client.token.authorized_by() - validate_response(response, expected_response, expected_types) - - async_response = await async_client.token.authorized_by() - validate_response(async_response, expected_response, expected_types) - - -async def test_introspect(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "authorization": { - "id": "55818d58616600637b9a5786", - "createdOn": "2016-10-03T23:12:00Z", - "lastUsed": "2016-10-10T21:41:12Z", - "grantType": "authorization_code", - "rateLimit": 60, - "scope": "assets:read,assets:write", - "authorizedTo": { - "siteIds": ["62f3b1f7eafac55d0c64ef91"], - "workspaceIds": ["52f3b1f7eafac55d0c64ef91"], - "userIds": ["545bbecb7bdd6769632504a7"], - }, - }, - "application": { - "id": "55131cd036c09f7d07883dfc", - "description": "My Amazing App", - "homepage": "https://webflow.com", - "displayName": "My Amazing App", - }, - } - expected_types: typing.Any = { - "authorization": { - "id": None, - "createdOn": "datetime", - "lastUsed": "datetime", - "grantType": None, - "rateLimit": "integer", - "scope": None, - "authorizedTo": { - "siteIds": ("list", {0: None}), - "workspaceIds": ("list", {0: None}), - "userIds": ("list", {0: None}), - }, - }, - "application": None, - } - response = client.token.introspect() - validate_response(response, expected_response, expected_types) - - async_response = await async_client.token.introspect() - validate_response(async_response, expected_response, expected_types) diff --git a/tests/test_users.py b/tests/test_users.py deleted file mode 100644 index abcbfd6..0000000 --- a/tests/test_users.py +++ /dev/null @@ -1,301 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -from webflow import AsyncWebflow -import typing -from .utilities import validate_response -from webflow.resources.users import UsersUpdateRequestData - - -async def test_list_(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "count": 5, - "limit": 5, - "offset": 0, - "total": 201, - "users": [ - { - "id": "6287ec36a841b25637c663df", - "isEmailVerified": False, - "lastUpdated": "2022-05-20T13:46:12Z", - "invitedOn": "2016-10-24T19:41:29Z", - "createdOn": "2022-05-20T13:46:12Z", - "lastLogin": "2016-10-24T19:41:29Z", - "status": "unverified", - "accessGroups": [{"slug": "vogon-construction-crew", "type": "admin"}], - }, - { - "id": "6287ec36a841b25637c663f0", - "isEmailVerified": False, - "lastUpdated": "2022-05-19T05:32:04Z", - "invitedOn": "2016-10-24T19:41:29Z", - "createdOn": "2022-05-19T05:32:04Z", - "lastLogin": "2016-10-24T19:41:29Z", - "status": "unverified", - "accessGroups": [{"slug": "improbability-drive-test-subjects", "type": "admin"}], - }, - { - "id": "6287ec36a841b25637c663d9", - "isEmailVerified": True, - "lastUpdated": "2022-05-17T03:34:06Z", - "invitedOn": "2016-10-24T19:41:29Z", - "createdOn": "2022-05-17T03:34:06Z", - "lastLogin": "2016-10-24T19:41:29Z", - "status": "verified", - "accessGroups": [{"slug": "heart-of-gold-crew", "type": "admin"}], - }, - { - "id": "6287ec37a841b25637c6641b", - "isEmailVerified": False, - "lastUpdated": "2022-05-15T03:46:09Z", - "invitedOn": "2016-10-24T19:41:29Z", - "createdOn": "2022-05-15T03:46:09Z", - "lastLogin": "2016-10-24T19:41:29Z", - "status": "unverified", - "accessGroups": [{"slug": "hitchhikers-guide-research-team", "type": "admin"}], - }, - { - "id": "6287ec37a841b25637c66449", - "isEmailVerified": True, - "lastUpdated": "2022-05-15T02:55:38Z", - "invitedOn": "2016-10-24T19:41:29Z", - "createdOn": "2022-05-15T02:55:38Z", - "lastLogin": "2016-10-24T19:41:29Z", - "status": "verified", - "accessGroups": [{"slug": "milliways-reservationists", "type": "admin"}], - }, - ], - } - expected_types: typing.Any = { - "count": None, - "limit": None, - "offset": None, - "total": None, - "users": ( - "list", - { - 0: { - "id": None, - "isEmailVerified": None, - "lastUpdated": "datetime", - "invitedOn": "datetime", - "createdOn": "datetime", - "lastLogin": "datetime", - "status": None, - "accessGroups": ("list", {0: {"slug": None, "type": None}}), - }, - 1: { - "id": None, - "isEmailVerified": None, - "lastUpdated": "datetime", - "invitedOn": "datetime", - "createdOn": "datetime", - "lastLogin": "datetime", - "status": None, - "accessGroups": ("list", {0: {"slug": None, "type": None}}), - }, - 2: { - "id": None, - "isEmailVerified": None, - "lastUpdated": "datetime", - "invitedOn": "datetime", - "createdOn": "datetime", - "lastLogin": "datetime", - "status": None, - "accessGroups": ("list", {0: {"slug": None, "type": None}}), - }, - 3: { - "id": None, - "isEmailVerified": None, - "lastUpdated": "datetime", - "invitedOn": "datetime", - "createdOn": "datetime", - "lastLogin": "datetime", - "status": None, - "accessGroups": ("list", {0: {"slug": None, "type": None}}), - }, - 4: { - "id": None, - "isEmailVerified": None, - "lastUpdated": "datetime", - "invitedOn": "datetime", - "createdOn": "datetime", - "lastLogin": "datetime", - "status": None, - "accessGroups": ("list", {0: {"slug": None, "type": None}}), - }, - }, - ), - } - response = client.users.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.users.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) - - -async def test_get(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "6287ec36a841b25637c663df", - "isEmailVerified": True, - "lastUpdated": "2022-05-20T13:46:12Z", - "invitedOn": "2022-05-20T13:46:12Z", - "createdOn": "2022-05-20T13:46:12Z", - "lastLogin": "2022-05-20T13:46:12Z", - "status": "verified", - "accessGroups": [{"slug": "webflowers", "type": "admin"}], - "data": { - "data": { - "name": "name", - "email": "email", - "accept-privacy": True, - "accept-communications": True, - "additionalProperties": "additionalProperties", - } - }, - } - expected_types: typing.Any = { - "id": None, - "isEmailVerified": None, - "lastUpdated": "datetime", - "invitedOn": "datetime", - "createdOn": "datetime", - "lastLogin": "datetime", - "status": None, - "accessGroups": ("list", {0: {"slug": None, "type": None}}), - "data": { - "data": { - "name": None, - "email": None, - "accept-privacy": None, - "accept-communications": None, - "additionalProperties": None, - } - }, - } - response = client.users.get(site_id="580e63e98c9a982ac9b8b741", user_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.users.get( - site_id="580e63e98c9a982ac9b8b741", user_id="580e63e98c9a982ac9b8b741" - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_delete(client: Webflow, async_client: AsyncWebflow) -> None: - # Type ignore to avoid mypy complaining about the function not being meant to return a value - assert ( - client.users.delete(site_id="580e63e98c9a982ac9b8b741", user_id="580e63e98c9a982ac9b8b741") # type: ignore[func-returns-value] - is None - ) - - assert ( - await async_client.users.delete(site_id="580e63e98c9a982ac9b8b741", user_id="580e63e98c9a982ac9b8b741") # type: ignore[func-returns-value] - is None - ) - - -async def test_update(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "6287ec36a841b25637c663df", - "isEmailVerified": True, - "lastUpdated": "2022-05-20T13:46:12Z", - "invitedOn": "2022-05-20T13:46:12Z", - "createdOn": "2022-05-20T13:46:12Z", - "lastLogin": "2022-05-20T13:46:12Z", - "status": "verified", - "accessGroups": [{"slug": "webflowers", "type": "admin"}], - "data": { - "data": { - "name": "name", - "email": "email", - "accept-privacy": True, - "accept-communications": True, - "additionalProperties": "additionalProperties", - } - }, - } - expected_types: typing.Any = { - "id": None, - "isEmailVerified": None, - "lastUpdated": "datetime", - "invitedOn": "datetime", - "createdOn": "datetime", - "lastLogin": "datetime", - "status": None, - "accessGroups": ("list", {0: {"slug": None, "type": None}}), - "data": { - "data": { - "name": None, - "email": None, - "accept-privacy": None, - "accept-communications": None, - "additionalProperties": None, - } - }, - } - response = client.users.update( - site_id="580e63e98c9a982ac9b8b741", - user_id="580e63e98c9a982ac9b8b741", - data=UsersUpdateRequestData(name="Some One", accept_privacy=False, accept_communications=False), - access_groups=["webflowers", "platinum", "free-tier"], - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.users.update( - site_id="580e63e98c9a982ac9b8b741", - user_id="580e63e98c9a982ac9b8b741", - data=UsersUpdateRequestData(name="Some One", accept_privacy=False, accept_communications=False), - access_groups=["webflowers", "platinum", "free-tier"], - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_invite(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "6287ec36a841b25637c663df", - "isEmailVerified": True, - "lastUpdated": "2022-05-20T13:46:12Z", - "invitedOn": "2022-05-20T13:46:12Z", - "createdOn": "2022-05-20T13:46:12Z", - "lastLogin": "2022-05-20T13:46:12Z", - "status": "verified", - "accessGroups": [{"slug": "webflowers", "type": "admin"}], - "data": { - "data": { - "name": "name", - "email": "email", - "accept-privacy": True, - "accept-communications": True, - "additionalProperties": "additionalProperties", - } - }, - } - expected_types: typing.Any = { - "id": None, - "isEmailVerified": None, - "lastUpdated": "datetime", - "invitedOn": "datetime", - "createdOn": "datetime", - "lastLogin": "datetime", - "status": None, - "accessGroups": ("list", {0: {"slug": None, "type": None}}), - "data": { - "data": { - "name": None, - "email": None, - "accept-privacy": None, - "accept-communications": None, - "additionalProperties": None, - } - }, - } - response = client.users.invite( - site_id="580e63e98c9a982ac9b8b741", email="some.one@home.com", access_groups=["webflowers"] - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.users.invite( - site_id="580e63e98c9a982ac9b8b741", email="some.one@home.com", access_groups=["webflowers"] - ) - validate_response(async_response, expected_response, expected_types) diff --git a/tests/test_webhooks.py b/tests/test_webhooks.py deleted file mode 100644 index 4c19188..0000000 --- a/tests/test_webhooks.py +++ /dev/null @@ -1,175 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -from webflow import Webflow -from webflow import AsyncWebflow -import typing -from .utilities import validate_response -import datetime - - -async def test_list_(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "pagination": {"limit": 100, "offset": 0, "total": 100}, - "webhooks": [ - { - "id": "57ca0a9e418c504a6e1acbb6", - "triggerType": "form_submission", - "url": "https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f", - "workspaceId": "4f4e46fd476ea8c507000001", - "siteId": "562ac0395358780a1f5e6fbd", - "filter": {"name": "Email Form"}, - "lastTriggered": "2023-02-08T23:59:28Z", - "createdOn": "2016-09-02T23:26:22Z", - }, - { - "id": "578d85cce0c47cd2865f4cf2", - "triggerType": "form_submission", - "url": "https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f", - "workspaceId": "4f4e46fd476ea8c507000001", - "siteId": "562ac0395358780a1f5e6fbd", - "filter": {"name": "Email Form"}, - "lastTriggered": "2023-02-08T23:59:28Z", - "createdOn": "2016-07-19T01:43:40Z", - }, - { - "id": "578d85cce0c47cd2865f4cf3", - "triggerType": "form_submission", - "url": "https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f", - "workspaceId": "4f4e46fd476ea8c507000001", - "siteId": "562ac0395358780a1f5e6fbd", - "filter": {"name": "Email Form"}, - "lastTriggered": "2023-02-08T23:59:28Z", - "createdOn": "2016-07-19T01:43:40Z", - }, - ], - } - expected_types: typing.Any = { - "pagination": {"limit": None, "offset": None, "total": None}, - "webhooks": ( - "list", - { - 0: { - "id": None, - "triggerType": None, - "url": None, - "workspaceId": None, - "siteId": None, - "filter": {"name": None}, - "lastTriggered": "datetime", - "createdOn": "datetime", - }, - 1: { - "id": None, - "triggerType": None, - "url": None, - "workspaceId": None, - "siteId": None, - "filter": {"name": None}, - "lastTriggered": "datetime", - "createdOn": "datetime", - }, - 2: { - "id": None, - "triggerType": None, - "url": None, - "workspaceId": None, - "siteId": None, - "filter": {"name": None}, - "lastTriggered": "datetime", - "createdOn": "datetime", - }, - }, - ), - } - response = client.webhooks.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.webhooks.list(site_id="580e63e98c9a982ac9b8b741") - validate_response(async_response, expected_response, expected_types) - - -async def test_create(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "582266e0cd48de0f0e3c6d8b", - "triggerType": "form_submission", - "url": "https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f", - "workspaceId": "4f4e46fd476ea8c507000001", - "siteId": "562ac0395358780a1f5e6fbd", - "filter": {"name": "My Form"}, - "lastTriggered": "2023-02-08T23:59:28Z", - "createdOn": "2022-11-08T23:59:28Z", - } - expected_types: typing.Any = { - "id": None, - "triggerType": None, - "url": None, - "workspaceId": None, - "siteId": None, - "filter": {"name": None}, - "lastTriggered": "datetime", - "createdOn": "datetime", - } - response = client.webhooks.create( - site_id_="580e63e98c9a982ac9b8b741", - id="582266e0cd48de0f0e3c6d8b", - trigger_type="form_submission", - url="https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f", - workspace_id="4f4e46fd476ea8c507000001", - site_id="562ac0395358780a1f5e6fbd", - last_triggered=datetime.datetime.fromisoformat("2023-02-08 23:59:28+00:00"), - created_on=datetime.datetime.fromisoformat("2022-11-08 23:59:28+00:00"), - ) - validate_response(response, expected_response, expected_types) - - async_response = await async_client.webhooks.create( - site_id_="580e63e98c9a982ac9b8b741", - id="582266e0cd48de0f0e3c6d8b", - trigger_type="form_submission", - url="https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f", - workspace_id="4f4e46fd476ea8c507000001", - site_id="562ac0395358780a1f5e6fbd", - last_triggered=datetime.datetime.fromisoformat("2023-02-08 23:59:28+00:00"), - created_on=datetime.datetime.fromisoformat("2022-11-08 23:59:28+00:00"), - ) - validate_response(async_response, expected_response, expected_types) - - -async def test_get(client: Webflow, async_client: AsyncWebflow) -> None: - expected_response: typing.Any = { - "id": "582266e0cd48de0f0e3c6d8b", - "triggerType": "form_submission", - "url": "https://webhook.site/7f7f7f7f-7f7f-7f7f-7f7f-7f7f7f7f7f7f", - "workspaceId": "4f4e46fd476ea8c507000001", - "siteId": "562ac0395358780a1f5e6fbd", - "filter": {"name": "My Form"}, - "lastTriggered": "2023-02-08T23:59:28Z", - "createdOn": "2022-11-08T23:59:28Z", - } - expected_types: typing.Any = { - "id": None, - "triggerType": None, - "url": None, - "workspaceId": None, - "siteId": None, - "filter": {"name": None}, - "lastTriggered": "datetime", - "createdOn": "datetime", - } - response = client.webhooks.get(webhook_id="580e64008c9a982ac9b8b754") - validate_response(response, expected_response, expected_types) - - async_response = await async_client.webhooks.get(webhook_id="580e64008c9a982ac9b8b754") - validate_response(async_response, expected_response, expected_types) - - -async def test_delete(client: Webflow, async_client: AsyncWebflow) -> None: - # Type ignore to avoid mypy complaining about the function not being meant to return a value - assert ( - client.webhooks.delete(webhook_id="580e64008c9a982ac9b8b754") # type: ignore[func-returns-value] - is None - ) - - assert ( - await async_client.webhooks.delete(webhook_id="580e64008c9a982ac9b8b754") # type: ignore[func-returns-value] - is None - ) diff --git a/tests/utilities.py b/tests/utilities.py deleted file mode 100644 index 3d22880..0000000 --- a/tests/utilities.py +++ /dev/null @@ -1,162 +0,0 @@ -# This file was auto-generated by Fern from our API Definition. - -import typing -import uuid - -from dateutil import parser - -import pydantic - - -def cast_field(json_expectation: typing.Any, type_expectation: typing.Any) -> typing.Any: - # Cast these specific types which come through as string and expect our - # models to cast to the correct type. - if type_expectation == "uuid": - return uuid.UUID(json_expectation) - elif type_expectation == "date": - return parser.parse(json_expectation).date() - elif type_expectation == "datetime": - return parser.parse(json_expectation) - elif type_expectation == "set": - return set(json_expectation) - elif type_expectation == "integer": - # Necessary as we allow numeric keys, but JSON makes them strings - return int(json_expectation) - - return json_expectation - - -def validate_field(response: typing.Any, json_expectation: typing.Any, type_expectation: typing.Any) -> None: - # Allow for an escape hatch if the object cannot be validated - if type_expectation == "no_validate": - return - - is_container_of_complex_type = False - # Parse types in containers, note that dicts are handled within `validate_response` - if isinstance(json_expectation, list): - if isinstance(type_expectation, tuple): - container_expectation = type_expectation[0] - contents_expectation = type_expectation[1] - - cast_json_expectation = [] - for idx, ex in enumerate(json_expectation): - if isinstance(contents_expectation, dict): - entry_expectation = contents_expectation.get(idx) - if isinstance(entry_expectation, dict): - is_container_of_complex_type = True - validate_response( - response=response[idx], - json_expectation=ex, - type_expectations=entry_expectation, - ) - else: - cast_json_expectation.append(cast_field(ex, entry_expectation)) - else: - cast_json_expectation.append(ex) - json_expectation = cast_json_expectation - - # Note that we explicitly do not allow for sets of pydantic models as they are not hashable, so - # if any of the values of the set have a type_expectation of a dict, we're assuming it's a pydantic - # model and keeping it a list. - if container_expectation != "set" or not any( - map( - lambda value: isinstance(value, dict), - list(contents_expectation.values()), - ) - ): - json_expectation = cast_field(json_expectation, container_expectation) - elif isinstance(type_expectation, tuple): - container_expectation = type_expectation[0] - contents_expectation = type_expectation[1] - if isinstance(contents_expectation, dict): - json_expectation = { - cast_field( - key, - contents_expectation.get(idx)[0] # type: ignore - if contents_expectation.get(idx) is not None - else None, - ): cast_field( - value, - contents_expectation.get(idx)[1] # type: ignore - if contents_expectation.get(idx) is not None - else None, - ) - for idx, (key, value) in enumerate(json_expectation.items()) - } - else: - json_expectation = cast_field(json_expectation, container_expectation) - elif type_expectation is not None: - json_expectation = cast_field(json_expectation, type_expectation) - - # When dealing with containers of models, etc. we're validating them implicitly, so no need to check the resultant list - if not is_container_of_complex_type: - assert ( - json_expectation == response - ), "Primitives found, expected: {0} (type: {1}), Actual: {2} (type: {3})".format( - json_expectation, type(json_expectation), response, type(response) - ) - - -# Arg type_expectations is a deeply nested structure that matches the response, but with the values replaced with the expected types -def validate_response(response: typing.Any, json_expectation: typing.Any, type_expectations: typing.Any) -> None: - # Allow for an escape hatch if the object cannot be validated - if type_expectations == "no_validate": - return - - if ( - not isinstance(response, list) - and not isinstance(response, dict) - and not issubclass(type(response), pydantic.BaseModel) - ): - validate_field( - response=response, - json_expectation=json_expectation, - type_expectation=type_expectations, - ) - return - - if isinstance(response, list): - assert len(response) == len(json_expectation), "Length mismatch, expected: {0}, Actual: {1}".format( - len(response), len(json_expectation) - ) - content_expectation = type_expectations - if isinstance(type_expectations, tuple): - content_expectation = type_expectations[1] - for idx, item in enumerate(response): - validate_response( - response=item, - json_expectation=json_expectation[idx], - type_expectations=content_expectation[idx], - ) - else: - response_json = response - if issubclass(type(response), pydantic.BaseModel): - response_json = response.dict(by_alias=True) - - for key, value in json_expectation.items(): - assert key in response_json, "Field {0} not found within the response object: {1}".format( - key, response_json - ) - - type_expectation = None - if type_expectations is not None and isinstance(type_expectations, dict): - type_expectation = type_expectations.get(key) - - # If your type_expectation is a tuple then you have a container field, process it as such - # Otherwise, we're just validating a single field that's a pydantic model. - if isinstance(value, dict) and not isinstance(type_expectation, tuple): - validate_response( - response=response_json[key], - json_expectation=value, - type_expectations=type_expectation, - ) - else: - validate_field( - response=response_json[key], - json_expectation=value, - type_expectation=type_expectation, - ) - - # Ensure there are no additional fields here either - del response_json[key] - assert len(response_json) == 0, "Additional fields found, expected None: {0}".format(response_json) diff --git a/tests/utils/assets/models/__init__.py b/tests/utils/assets/models/__init__.py index 3a1c852..2cf0126 100644 --- a/tests/utils/assets/models/__init__.py +++ b/tests/utils/assets/models/__init__.py @@ -5,7 +5,7 @@ from .circle import CircleParams from .object_with_defaults import ObjectWithDefaultsParams from .object_with_optional_field import ObjectWithOptionalFieldParams -from .shape import ShapeParams, Shape_CircleParams, Shape_SquareParams +from .shape import Shape_CircleParams, Shape_SquareParams, ShapeParams from .square import SquareParams from .undiscriminated_shape import UndiscriminatedShapeParams diff --git a/tests/utils/assets/models/circle.py b/tests/utils/assets/models/circle.py index de001b7..9295a33 100644 --- a/tests/utils/assets/models/circle.py +++ b/tests/utils/assets/models/circle.py @@ -3,7 +3,7 @@ # This file was auto-generated by Fern from our API Definition. import typing_extensions -import typing_extensions + from webflow.core.serialization import FieldMetadata diff --git a/tests/utils/assets/models/object_with_defaults.py b/tests/utils/assets/models/object_with_defaults.py index ef14f7b..a977b1d 100644 --- a/tests/utils/assets/models/object_with_defaults.py +++ b/tests/utils/assets/models/object_with_defaults.py @@ -3,7 +3,6 @@ # This file was auto-generated by Fern from our API Definition. import typing_extensions -import typing_extensions class ObjectWithDefaultsParams(typing_extensions.TypedDict): diff --git a/tests/utils/assets/models/object_with_optional_field.py b/tests/utils/assets/models/object_with_optional_field.py index 1912220..f1a588e 100644 --- a/tests/utils/assets/models/object_with_optional_field.py +++ b/tests/utils/assets/models/object_with_optional_field.py @@ -2,16 +2,17 @@ # This file was auto-generated by Fern from our API Definition. -import typing_extensions -import typing -import typing_extensions -from webflow.core.serialization import FieldMetadata import datetime as dt +import typing import uuid + +import typing_extensions from .color import Color from .shape import ShapeParams from .undiscriminated_shape import UndiscriminatedShapeParams +from webflow.core.serialization import FieldMetadata + class ObjectWithOptionalFieldParams(typing_extensions.TypedDict): literal: typing.Literal["lit_one"] diff --git a/tests/utils/assets/models/shape.py b/tests/utils/assets/models/shape.py index cf58a9b..84153dc 100644 --- a/tests/utils/assets/models/shape.py +++ b/tests/utils/assets/models/shape.py @@ -3,9 +3,11 @@ # This file was auto-generated by Fern from our API Definition. from __future__ import annotations -import typing_extensions -import typing_extensions + import typing + +import typing_extensions + from webflow.core.serialization import FieldMetadata diff --git a/tests/utils/assets/models/square.py b/tests/utils/assets/models/square.py index ec068c5..3f40c1f 100644 --- a/tests/utils/assets/models/square.py +++ b/tests/utils/assets/models/square.py @@ -3,7 +3,7 @@ # This file was auto-generated by Fern from our API Definition. import typing_extensions -import typing_extensions + from webflow.core.serialization import FieldMetadata diff --git a/tests/utils/assets/models/undiscriminated_shape.py b/tests/utils/assets/models/undiscriminated_shape.py index 68876a2..99f12b3 100644 --- a/tests/utils/assets/models/undiscriminated_shape.py +++ b/tests/utils/assets/models/undiscriminated_shape.py @@ -3,6 +3,7 @@ # This file was auto-generated by Fern from our API Definition. import typing + from .circle import CircleParams from .square import SquareParams diff --git a/tests/utils/test_http_client.py b/tests/utils/test_http_client.py index 8532616..10ef8a1 100644 --- a/tests/utils/test_http_client.py +++ b/tests/utils/test_http_client.py @@ -1,13 +1,57 @@ # This file was auto-generated by Fern from our API Definition. -from webflow.core.http_client import get_request_body +from typing import Any, Dict + +import pytest + +from webflow.core.http_client import ( + AsyncHttpClient, + HttpClient, + _build_url, + get_request_body, + remove_none_from_dict, +) from webflow.core.request_options import RequestOptions +# Stub clients for testing HttpClient and AsyncHttpClient +class _DummySyncClient: + """A minimal stub for httpx.Client that records request arguments.""" + + def __init__(self) -> None: + self.last_request_kwargs: Dict[str, Any] = {} + + def request(self, **kwargs: Any) -> "_DummyResponse": + self.last_request_kwargs = kwargs + return _DummyResponse() + + +class _DummyAsyncClient: + """A minimal stub for httpx.AsyncClient that records request arguments.""" + + def __init__(self) -> None: + self.last_request_kwargs: Dict[str, Any] = {} + + async def request(self, **kwargs: Any) -> "_DummyResponse": + self.last_request_kwargs = kwargs + return _DummyResponse() + + +class _DummyResponse: + """A minimal stub for httpx.Response.""" + + status_code = 200 + headers: Dict[str, str] = {} + + def get_request_options() -> RequestOptions: return {"additional_body_parameters": {"see you": "later"}} +def get_request_options_with_none() -> RequestOptions: + return {"additional_body_parameters": {"see you": "later", "optional": None}} + + def test_get_json_request_body() -> None: json_body, data_body = get_request_body(json={"hello": "world"}, data=None, request_options=None, omit=None) assert json_body == {"hello": "world"} @@ -48,14 +92,209 @@ def test_get_none_request_body() -> None: def test_get_empty_json_request_body() -> None: + """Test that implicit empty bodies (json=None) are collapsed to None.""" unrelated_request_options: RequestOptions = {"max_retries": 3} json_body, data_body = get_request_body(json=None, data=None, request_options=unrelated_request_options, omit=None) assert json_body is None assert data_body is None - json_body_extras, data_body_extras = get_request_body( - json={}, data=None, request_options=unrelated_request_options, omit=None + +def test_explicit_empty_json_body_is_preserved() -> None: + """Test that explicit empty bodies (json={}) are preserved and sent as {}. + + This is important for endpoints where the request body is required but all + fields are optional. The server expects valid JSON ({}) not an empty body. + """ + unrelated_request_options: RequestOptions = {"max_retries": 3} + + # Explicit json={} should be preserved + json_body, data_body = get_request_body(json={}, data=None, request_options=unrelated_request_options, omit=None) + assert json_body == {} + assert data_body is None + + # Explicit data={} should also be preserved + json_body2, data_body2 = get_request_body(json=None, data={}, request_options=unrelated_request_options, omit=None) + assert json_body2 is None + assert data_body2 == {} + + +def test_json_body_preserves_none_values() -> None: + """Test that JSON bodies preserve None values (they become JSON null).""" + json_body, data_body = get_request_body( + json={"hello": "world", "optional": None}, data=None, request_options=None, omit=None ) + # JSON bodies should preserve None values + assert json_body == {"hello": "world", "optional": None} + assert data_body is None - assert json_body_extras is None - assert data_body_extras is None + +def test_data_body_preserves_none_values_without_multipart() -> None: + """Test that data bodies preserve None values when not using multipart. + + The filtering of None values happens in HttpClient.request/stream methods, + not in get_request_body. This test verifies get_request_body doesn't filter None. + """ + json_body, data_body = get_request_body( + json=None, data={"hello": "world", "optional": None}, request_options=None, omit=None + ) + # get_request_body should preserve None values in data body + # The filtering happens later in HttpClient.request when multipart is detected + assert data_body == {"hello": "world", "optional": None} + assert json_body is None + + +def test_remove_none_from_dict_filters_none_values() -> None: + """Test that remove_none_from_dict correctly filters out None values.""" + original = {"hello": "world", "optional": None, "another": "value", "also_none": None} + filtered = remove_none_from_dict(original) + assert filtered == {"hello": "world", "another": "value"} + # Original should not be modified + assert original == {"hello": "world", "optional": None, "another": "value", "also_none": None} + + +def test_remove_none_from_dict_empty_dict() -> None: + """Test that remove_none_from_dict handles empty dict.""" + assert remove_none_from_dict({}) == {} + + +def test_remove_none_from_dict_all_none() -> None: + """Test that remove_none_from_dict handles dict with all None values.""" + assert remove_none_from_dict({"a": None, "b": None}) == {} + + +def test_http_client_does_not_pass_empty_params_list() -> None: + """Test that HttpClient passes params=None when params are empty. + + This prevents httpx from stripping existing query parameters from the URL, + which happens when params=[] or params={} is passed. + """ + dummy_client = _DummySyncClient() + http_client = HttpClient( + httpx_client=dummy_client, # type: ignore[arg-type] + base_timeout=lambda: None, + base_headers=lambda: {}, + base_url=lambda: "https://example.com", + ) + + # Use a path with query params (e.g., pagination cursor URL) + http_client.request( + path="resource?after=123", + method="GET", + params=None, + request_options=None, + ) + + # We care that httpx receives params=None, not [] or {} + assert "params" in dummy_client.last_request_kwargs + assert dummy_client.last_request_kwargs["params"] is None + + # Verify the query string in the URL is preserved + url = str(dummy_client.last_request_kwargs["url"]) + assert "after=123" in url, f"Expected query param 'after=123' in URL, got: {url}" + + +def test_http_client_passes_encoded_params_when_present() -> None: + """Test that HttpClient passes encoded params when params are provided.""" + dummy_client = _DummySyncClient() + http_client = HttpClient( + httpx_client=dummy_client, # type: ignore[arg-type] + base_timeout=lambda: None, + base_headers=lambda: {}, + base_url=lambda: "https://example.com/resource", + ) + + http_client.request( + path="", + method="GET", + params={"after": "456"}, + request_options=None, + ) + + params = dummy_client.last_request_kwargs["params"] + # For a simple dict, encode_query should give a single (key, value) tuple + assert params == [("after", "456")] + + +@pytest.mark.asyncio +async def test_async_http_client_does_not_pass_empty_params_list() -> None: + """Test that AsyncHttpClient passes params=None when params are empty. + + This prevents httpx from stripping existing query parameters from the URL, + which happens when params=[] or params={} is passed. + """ + dummy_client = _DummyAsyncClient() + http_client = AsyncHttpClient( + httpx_client=dummy_client, # type: ignore[arg-type] + base_timeout=lambda: None, + base_headers=lambda: {}, + base_url=lambda: "https://example.com", + async_base_headers=None, + ) + + # Use a path with query params (e.g., pagination cursor URL) + await http_client.request( + path="resource?after=123", + method="GET", + params=None, + request_options=None, + ) + + # We care that httpx receives params=None, not [] or {} + assert "params" in dummy_client.last_request_kwargs + assert dummy_client.last_request_kwargs["params"] is None + + # Verify the query string in the URL is preserved + url = str(dummy_client.last_request_kwargs["url"]) + assert "after=123" in url, f"Expected query param 'after=123' in URL, got: {url}" + + +@pytest.mark.asyncio +async def test_async_http_client_passes_encoded_params_when_present() -> None: + """Test that AsyncHttpClient passes encoded params when params are provided.""" + dummy_client = _DummyAsyncClient() + http_client = AsyncHttpClient( + httpx_client=dummy_client, # type: ignore[arg-type] + base_timeout=lambda: None, + base_headers=lambda: {}, + base_url=lambda: "https://example.com/resource", + async_base_headers=None, + ) + + await http_client.request( + path="", + method="GET", + params={"after": "456"}, + request_options=None, + ) + + params = dummy_client.last_request_kwargs["params"] + # For a simple dict, encode_query should give a single (key, value) tuple + assert params == [("after", "456")] + + +def test_basic_url_joining() -> None: + """Test basic URL joining with a simple base URL and path.""" + result = _build_url("https://api.example.com", "/users") + assert result == "https://api.example.com/users" + + +def test_basic_url_joining_trailing_slash() -> None: + """Test basic URL joining with a simple base URL and path.""" + result = _build_url("https://api.example.com/", "/users") + assert result == "https://api.example.com/users" + + +def test_preserves_base_url_path_prefix() -> None: + """Test that path prefixes in base URL are preserved. + + This is the critical bug fix - urllib.parse.urljoin() would strip + the path prefix when the path starts with '/'. + """ + result = _build_url("https://cloud.example.com/org/tenant/api", "/users") + assert result == "https://cloud.example.com/org/tenant/api/users" + + +def test_preserves_base_url_path_prefix_trailing_slash() -> None: + """Test that path prefixes in base URL are preserved.""" + result = _build_url("https://cloud.example.com/org/tenant/api/", "/users") + assert result == "https://cloud.example.com/org/tenant/api/users" diff --git a/tests/utils/test_query_encoding.py b/tests/utils/test_query_encoding.py index 9c4591e..c76b5d2 100644 --- a/tests/utils/test_query_encoding.py +++ b/tests/utils/test_query_encoding.py @@ -1,6 +1,5 @@ # This file was auto-generated by Fern from our API Definition. - from webflow.core.query_encoder import encode_query @@ -34,4 +33,4 @@ def test_query_encoding_deep_object_arrays() -> None: def test_encode_query_with_none() -> None: encoded = encode_query(None) - assert encoded == None + assert encoded is None diff --git a/tests/utils/test_serialization.py b/tests/utils/test_serialization.py index 3676b2f..af7b043 100644 --- a/tests/utils/test_serialization.py +++ b/tests/utils/test_serialization.py @@ -1,10 +1,10 @@ # This file was auto-generated by Fern from our API Definition. -from typing import List, Any +from typing import Any, List -from webflow.core.serialization import convert_and_respect_annotation_metadata -from .assets.models import ShapeParams, ObjectWithOptionalFieldParams +from .assets.models import ObjectWithOptionalFieldParams, ShapeParams +from webflow.core.serialization import convert_and_respect_annotation_metadata UNION_TEST: ShapeParams = {"radius_measurement": 1.0, "shape_type": "circle", "id": "1"} UNION_TEST_CONVERTED = {"shapeType": "circle", "radiusMeasurement": 1.0, "id": "1"}