webflow-api 3.1.0 → 3.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.mock/definition/__package__.yml +363 -79
- package/.mock/definition/accessGroups.yml +1 -0
- package/.mock/definition/assets.yml +86 -47
- package/.mock/definition/collections/fields.yml +63 -46
- package/.mock/definition/collections/items.yml +58 -30
- package/.mock/definition/collections.yml +42 -7
- package/.mock/definition/components.yml +43 -50
- package/.mock/definition/ecommerce.yml +1 -0
- package/.mock/definition/forms.yml +114 -2
- package/.mock/definition/inventory.yml +2 -0
- package/.mock/definition/orders.yml +6 -68
- package/.mock/definition/pages/scripts.yml +10 -44
- package/.mock/definition/pages.yml +36 -41
- package/.mock/definition/products.yml +9 -0
- package/.mock/definition/scripts.yml +18 -49
- package/.mock/definition/sites/activityLogs.yml +10 -7
- package/.mock/definition/sites/plans.yml +7 -1
- package/.mock/definition/sites/redirects.yml +24 -1
- package/.mock/definition/sites/robotsTxt.yml +202 -0
- package/.mock/definition/sites/scripts.yml +22 -30
- package/.mock/definition/sites.yml +27 -30
- package/.mock/definition/token.yml +2 -0
- package/.mock/definition/users.yml +4 -0
- package/.mock/definition/webhooks.yml +7 -8
- package/.mock/fern.config.json +1 -1
- package/api/resources/accessGroups/client/Client.js +1 -1
- package/api/resources/assets/client/Client.d.ts +10 -7
- package/api/resources/assets/client/Client.js +18 -15
- package/api/resources/collections/client/Client.d.ts +21 -1
- package/api/resources/collections/client/Client.js +27 -5
- package/api/resources/collections/client/requests/CollectionsCreateRequest.d.ts +23 -1
- package/api/resources/collections/resources/fields/client/Client.d.ts +34 -4
- package/api/resources/collections/resources/fields/client/Client.js +40 -8
- package/api/resources/collections/resources/fields/client/requests/index.d.ts +0 -1
- package/api/resources/collections/resources/fields/index.d.ts +0 -1
- package/api/resources/collections/resources/fields/index.js +0 -1
- package/api/resources/collections/resources/index.d.ts +1 -2
- package/api/resources/collections/resources/index.js +2 -3
- package/api/resources/collections/resources/items/client/Client.d.ts +19 -12
- package/api/resources/collections/resources/items/client/Client.js +39 -28
- package/api/resources/collections/resources/items/client/requests/ItemsListItemsLiveRequest.d.ts +2 -2
- package/api/resources/collections/resources/items/client/requests/ItemsListItemsRequest.d.ts +2 -2
- package/api/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +1 -1
- package/api/resources/components/client/Client.d.ts +5 -6
- package/api/resources/components/client/Client.js +10 -11
- package/api/resources/ecommerce/client/Client.js +1 -1
- package/api/resources/forms/client/Client.d.ts +51 -0
- package/api/resources/forms/client/Client.js +226 -5
- package/api/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.d.ts +23 -0
- package/api/resources/forms/client/requests/index.d.ts +1 -0
- package/api/resources/inventory/client/Client.js +2 -2
- package/api/resources/orders/client/Client.js +6 -6
- package/api/resources/pages/client/Client.d.ts +8 -3
- package/api/resources/pages/client/Client.js +13 -8
- package/api/resources/pages/resources/scripts/client/Client.d.ts +6 -20
- package/api/resources/pages/resources/scripts/client/Client.js +9 -23
- package/api/resources/products/client/Client.js +6 -6
- package/api/resources/scripts/client/Client.d.ts +12 -20
- package/api/resources/scripts/client/Client.js +15 -23
- package/api/resources/sites/client/Client.d.ts +12 -3
- package/api/resources/sites/client/Client.js +25 -14
- package/api/resources/sites/resources/activityLogs/client/Client.d.ts +5 -1
- package/api/resources/sites/resources/activityLogs/client/Client.js +6 -2
- package/api/resources/sites/resources/index.d.ts +1 -0
- package/api/resources/sites/resources/index.js +2 -1
- package/api/resources/sites/resources/plans/client/Client.d.ts +2 -0
- package/api/resources/sites/resources/plans/client/Client.js +3 -1
- package/api/resources/sites/resources/redirects/client/Client.d.ts +10 -0
- package/api/resources/sites/resources/redirects/client/Client.js +14 -4
- package/api/resources/sites/resources/robotsTxt/client/Client.d.ts +124 -0
- package/api/resources/sites/resources/robotsTxt/client/Client.js +486 -0
- package/api/resources/sites/resources/robotsTxt/client/index.d.ts +1 -0
- package/api/resources/sites/resources/robotsTxt/client/index.js +2 -0
- package/api/resources/sites/resources/robotsTxt/index.d.ts +1 -0
- package/api/resources/{collections/resources/fields/types → sites/resources/robotsTxt}/index.js +1 -1
- package/api/resources/sites/resources/scripts/client/Client.d.ts +15 -13
- package/api/resources/sites/resources/scripts/client/Client.js +19 -17
- package/api/resources/token/client/Client.js +2 -2
- package/api/resources/users/client/Client.js +5 -5
- package/api/resources/users/client/requests/UsersInviteRequest.d.ts +1 -4
- package/api/resources/users/client/requests/UsersUpdateRequest.d.ts +1 -4
- package/api/resources/webhooks/client/Client.js +4 -4
- package/api/types/Asset.d.ts +4 -0
- package/api/types/AssetVariant.d.ts +3 -0
- package/api/types/Assets.d.ts +1 -0
- package/api/types/ComponentNode.d.ts +2 -2
- package/api/types/Conflict.d.ts +4 -0
- package/api/types/Dom.d.ts +2 -0
- package/api/types/FieldCreate.d.ts +8 -0
- package/api/types/FieldCreate.js +5 -0
- package/api/types/FieldType.d.ts +3 -1
- package/api/types/FieldType.js +2 -0
- package/api/types/ImageNode.d.ts +1 -0
- package/api/types/ImageNodeImage.d.ts +3 -0
- package/api/types/Metadata.d.ts +11 -0
- package/api/types/Metadata.js +5 -0
- package/api/types/MetadataOptionsItem.d.ts +12 -0
- package/api/types/MetadataOptionsItem.js +5 -0
- package/api/types/OAuthScope.d.ts +8 -0
- package/api/types/OAuthScope.js +2 -0
- package/api/types/OptionField.d.ts +19 -0
- package/api/types/OptionField.js +5 -0
- package/api/types/ReferenceField.d.ts +20 -0
- package/api/types/ReferenceField.js +5 -0
- package/api/types/ReferenceFieldMetadata.d.ts +10 -0
- package/api/types/ReferenceFieldMetadata.js +5 -0
- package/api/types/ReferenceFieldType.d.ts +11 -0
- package/api/types/ReferenceFieldType.js +10 -0
- package/api/types/Robots.d.ts +13 -0
- package/api/types/Robots.js +5 -0
- package/api/types/RobotsRulesItem.d.ts +11 -0
- package/api/types/RobotsRulesItem.js +5 -0
- package/api/types/SkuFieldData.d.ts +2 -0
- package/api/types/SkuFieldDataEcSkuBillingMethod.d.ts +3 -0
- package/api/types/SkuFieldDataEcSkuSubscriptionPlan.d.ts +3 -0
- package/api/{resources/collections/resources/fields/client/requests/FieldCreate.d.ts → types/StaticField.d.ts} +7 -12
- package/api/types/StaticField.js +5 -0
- package/api/{resources/collections/resources/fields/types/FieldCreateType.d.ts → types/StaticFieldType.d.ts} +2 -3
- package/{dist/api/resources/collections/resources/fields/types/FieldCreateType.js → api/types/StaticFieldType.js} +2 -3
- package/api/types/Text.d.ts +3 -0
- package/api/types/TextNode.d.ts +1 -0
- package/api/types/TextNodeText.d.ts +3 -0
- package/api/types/TriggerType.d.ts +1 -15
- package/api/types/WebhookList.d.ts +1 -1
- package/api/types/index.d.ts +12 -0
- package/api/types/index.js +12 -0
- package/dist/api/resources/accessGroups/client/Client.js +1 -1
- package/dist/api/resources/assets/client/Client.d.ts +10 -7
- package/dist/api/resources/assets/client/Client.js +18 -15
- package/dist/api/resources/collections/client/Client.d.ts +21 -1
- package/dist/api/resources/collections/client/Client.js +27 -5
- package/dist/api/resources/collections/client/requests/CollectionsCreateRequest.d.ts +23 -1
- package/dist/api/resources/collections/resources/fields/client/Client.d.ts +34 -4
- package/dist/api/resources/collections/resources/fields/client/Client.js +40 -8
- package/dist/api/resources/collections/resources/fields/client/requests/index.d.ts +0 -1
- package/dist/api/resources/collections/resources/fields/index.d.ts +0 -1
- package/dist/api/resources/collections/resources/fields/index.js +0 -1
- package/dist/api/resources/collections/resources/index.d.ts +1 -2
- package/dist/api/resources/collections/resources/index.js +2 -3
- package/dist/api/resources/collections/resources/items/client/Client.d.ts +19 -12
- package/dist/api/resources/collections/resources/items/client/Client.js +39 -28
- package/dist/api/resources/collections/resources/items/client/requests/ItemsListItemsLiveRequest.d.ts +2 -2
- package/dist/api/resources/collections/resources/items/client/requests/ItemsListItemsRequest.d.ts +2 -2
- package/dist/api/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +1 -1
- package/dist/api/resources/components/client/Client.d.ts +5 -6
- package/dist/api/resources/components/client/Client.js +10 -11
- package/dist/api/resources/ecommerce/client/Client.js +1 -1
- package/dist/api/resources/forms/client/Client.d.ts +51 -0
- package/dist/api/resources/forms/client/Client.js +226 -5
- package/dist/api/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.d.ts +23 -0
- package/dist/api/resources/forms/client/requests/FormsListSubmissionsBySiteRequest.js +5 -0
- package/dist/api/resources/forms/client/requests/index.d.ts +1 -0
- package/dist/api/resources/inventory/client/Client.js +2 -2
- package/dist/api/resources/orders/client/Client.js +6 -6
- package/dist/api/resources/pages/client/Client.d.ts +8 -3
- package/dist/api/resources/pages/client/Client.js +13 -8
- package/dist/api/resources/pages/resources/scripts/client/Client.d.ts +6 -20
- package/dist/api/resources/pages/resources/scripts/client/Client.js +9 -23
- package/dist/api/resources/products/client/Client.js +6 -6
- package/dist/api/resources/scripts/client/Client.d.ts +12 -20
- package/dist/api/resources/scripts/client/Client.js +15 -23
- package/dist/api/resources/sites/client/Client.d.ts +12 -3
- package/dist/api/resources/sites/client/Client.js +25 -14
- package/dist/api/resources/sites/resources/activityLogs/client/Client.d.ts +5 -1
- package/dist/api/resources/sites/resources/activityLogs/client/Client.js +6 -2
- package/dist/api/resources/sites/resources/index.d.ts +1 -0
- package/dist/api/resources/sites/resources/index.js +2 -1
- package/dist/api/resources/sites/resources/plans/client/Client.d.ts +2 -0
- package/dist/api/resources/sites/resources/plans/client/Client.js +3 -1
- package/dist/api/resources/sites/resources/redirects/client/Client.d.ts +10 -0
- package/dist/api/resources/sites/resources/redirects/client/Client.js +14 -4
- package/dist/api/resources/sites/resources/robotsTxt/client/Client.d.ts +124 -0
- package/dist/api/resources/sites/resources/robotsTxt/client/Client.js +486 -0
- package/dist/api/resources/sites/resources/robotsTxt/client/index.d.ts +1 -0
- package/dist/api/resources/sites/resources/robotsTxt/client/index.js +2 -0
- package/dist/api/resources/sites/resources/robotsTxt/index.d.ts +1 -0
- package/dist/{serialization/resources/collections/resources/fields/types → api/resources/sites/resources/robotsTxt}/index.js +1 -1
- package/dist/api/resources/sites/resources/scripts/client/Client.d.ts +15 -13
- package/dist/api/resources/sites/resources/scripts/client/Client.js +19 -17
- package/dist/api/resources/token/client/Client.js +2 -2
- package/dist/api/resources/users/client/Client.js +5 -5
- package/dist/api/resources/users/client/requests/UsersInviteRequest.d.ts +1 -4
- package/dist/api/resources/users/client/requests/UsersUpdateRequest.d.ts +1 -4
- package/dist/api/resources/webhooks/client/Client.js +4 -4
- package/dist/api/types/Asset.d.ts +4 -0
- package/dist/api/types/AssetVariant.d.ts +3 -0
- package/dist/api/types/Assets.d.ts +1 -0
- package/dist/api/types/ComponentNode.d.ts +2 -2
- package/dist/api/types/Conflict.d.ts +4 -0
- package/dist/api/types/Conflict.js +5 -0
- package/dist/api/types/Dom.d.ts +2 -0
- package/dist/api/types/FieldCreate.d.ts +8 -0
- package/dist/api/types/FieldCreate.js +5 -0
- package/dist/api/types/FieldType.d.ts +3 -1
- package/dist/api/types/FieldType.js +2 -0
- package/dist/api/types/ImageNode.d.ts +1 -0
- package/dist/api/types/ImageNodeImage.d.ts +3 -0
- package/dist/api/types/Metadata.d.ts +11 -0
- package/dist/api/types/Metadata.js +5 -0
- package/dist/api/types/MetadataOptionsItem.d.ts +12 -0
- package/dist/api/types/MetadataOptionsItem.js +5 -0
- package/dist/api/types/OAuthScope.d.ts +8 -0
- package/dist/api/types/OAuthScope.js +2 -0
- package/dist/api/types/OptionField.d.ts +19 -0
- package/dist/api/types/OptionField.js +5 -0
- package/dist/api/types/ReferenceField.d.ts +20 -0
- package/dist/api/types/ReferenceField.js +5 -0
- package/dist/api/types/ReferenceFieldMetadata.d.ts +10 -0
- package/dist/api/types/ReferenceFieldMetadata.js +5 -0
- package/dist/api/types/ReferenceFieldType.d.ts +11 -0
- package/dist/api/types/ReferenceFieldType.js +10 -0
- package/dist/api/types/Robots.d.ts +13 -0
- package/dist/api/types/Robots.js +5 -0
- package/dist/api/types/RobotsRulesItem.d.ts +11 -0
- package/dist/api/types/RobotsRulesItem.js +5 -0
- package/dist/api/types/SkuFieldData.d.ts +2 -0
- package/dist/api/types/SkuFieldDataEcSkuBillingMethod.d.ts +3 -0
- package/dist/api/types/SkuFieldDataEcSkuSubscriptionPlan.d.ts +3 -0
- package/dist/api/{resources/collections/resources/fields/client/requests/FieldCreate.d.ts → types/StaticField.d.ts} +7 -12
- package/dist/api/types/StaticField.js +5 -0
- package/dist/api/{resources/collections/resources/fields/types/FieldCreateType.d.ts → types/StaticFieldType.d.ts} +2 -3
- package/{api/resources/collections/resources/fields/types/FieldCreateType.js → dist/api/types/StaticFieldType.js} +2 -3
- package/dist/api/types/Text.d.ts +3 -0
- package/dist/api/types/TextNode.d.ts +1 -0
- package/dist/api/types/TextNodeText.d.ts +3 -0
- package/dist/api/types/TriggerType.d.ts +1 -15
- package/dist/api/types/WebhookList.d.ts +1 -1
- package/dist/api/types/index.d.ts +12 -0
- package/dist/api/types/index.js +12 -0
- package/dist/serialization/resources/collections/client/requests/CollectionsCreateRequest.d.ts +2 -0
- package/dist/serialization/resources/collections/client/requests/CollectionsCreateRequest.js +2 -0
- package/dist/serialization/resources/collections/resources/fields/client/requests/index.d.ts +0 -1
- package/dist/serialization/resources/collections/resources/fields/client/requests/index.js +1 -3
- package/dist/serialization/resources/collections/resources/fields/index.d.ts +0 -1
- package/dist/serialization/resources/collections/resources/fields/index.js +0 -1
- package/dist/serialization/resources/collections/resources/index.d.ts +1 -2
- package/dist/serialization/resources/collections/resources/index.js +2 -3
- package/dist/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +1 -1
- package/dist/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.js +1 -1
- package/dist/serialization/types/Assets.d.ts +2 -0
- package/dist/serialization/types/Assets.js +2 -0
- package/dist/serialization/types/Conflict.d.ts +10 -0
- package/dist/serialization/types/Conflict.js +31 -0
- package/dist/serialization/types/Dom.d.ts +1 -0
- package/dist/serialization/types/Dom.js +1 -0
- package/dist/serialization/types/FieldCreate.d.ts +13 -0
- package/dist/serialization/types/FieldCreate.js +34 -0
- package/dist/serialization/types/FieldType.d.ts +1 -1
- package/dist/serialization/types/FieldType.js +2 -0
- package/dist/serialization/types/Metadata.d.ts +13 -0
- package/dist/serialization/types/Metadata.js +34 -0
- package/dist/serialization/types/MetadataOptionsItem.d.ts +13 -0
- package/dist/serialization/types/MetadataOptionsItem.js +34 -0
- package/dist/serialization/types/OptionField.d.ts +19 -0
- package/dist/serialization/types/OptionField.js +40 -0
- package/dist/serialization/types/ReferenceField.d.ts +20 -0
- package/dist/serialization/types/ReferenceField.js +41 -0
- package/dist/serialization/types/ReferenceFieldMetadata.d.ts +12 -0
- package/dist/serialization/types/ReferenceFieldMetadata.js +33 -0
- package/dist/serialization/types/ReferenceFieldType.d.ts +10 -0
- package/dist/serialization/types/ReferenceFieldType.js +31 -0
- package/dist/serialization/types/Robots.d.ts +14 -0
- package/dist/serialization/types/Robots.js +35 -0
- package/dist/serialization/types/RobotsRulesItem.d.ts +14 -0
- package/dist/serialization/types/RobotsRulesItem.js +35 -0
- package/dist/serialization/types/StaticField.d.ts +18 -0
- package/dist/serialization/{resources/collections/resources/fields/client/requests/FieldCreate.js → types/StaticField.js} +7 -5
- package/dist/serialization/types/StaticFieldType.d.ts +10 -0
- package/dist/serialization/{resources/collections/resources/fields/types/FieldCreateType.js → types/StaticFieldType.js} +3 -4
- package/dist/serialization/types/WebhookList.d.ts +2 -2
- package/dist/serialization/types/WebhookList.js +2 -2
- package/dist/serialization/types/index.d.ts +12 -0
- package/dist/serialization/types/index.js +12 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/wrapper/AssetsClient.d.ts +12 -0
- package/dist/wrapper/AssetsClient.js +16 -0
- package/dist/wrapper/AssetsUtilitiesClient.d.ts +49 -0
- package/dist/wrapper/AssetsUtilitiesClient.js +121 -0
- package/dist/wrapper/WebflowClient.d.ts +6 -0
- package/dist/wrapper/WebflowClient.js +10 -0
- package/dist/wrapper/WebhooksClient.d.ts +39 -0
- package/dist/wrapper/WebhooksClient.js +66 -0
- package/package.json +15 -12
- package/reference.md +585 -91
- package/serialization/resources/collections/client/requests/CollectionsCreateRequest.d.ts +2 -0
- package/serialization/resources/collections/client/requests/CollectionsCreateRequest.js +2 -0
- package/serialization/resources/collections/resources/fields/client/requests/index.d.ts +0 -1
- package/serialization/resources/collections/resources/fields/client/requests/index.js +1 -3
- package/serialization/resources/collections/resources/fields/index.d.ts +0 -1
- package/serialization/resources/collections/resources/fields/index.js +0 -1
- package/serialization/resources/collections/resources/index.d.ts +1 -2
- package/serialization/resources/collections/resources/index.js +2 -3
- package/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.d.ts +1 -1
- package/serialization/resources/collections/resources/items/types/ItemsDeleteItemsLiveRequestItemsItem.js +1 -1
- package/serialization/types/Assets.d.ts +2 -0
- package/serialization/types/Assets.js +2 -0
- package/serialization/types/Conflict.d.ts +10 -0
- package/serialization/types/Conflict.js +31 -0
- package/serialization/types/Dom.d.ts +1 -0
- package/serialization/types/Dom.js +1 -0
- package/serialization/types/FieldCreate.d.ts +13 -0
- package/serialization/types/FieldCreate.js +34 -0
- package/serialization/types/FieldType.d.ts +1 -1
- package/serialization/types/FieldType.js +2 -0
- package/serialization/types/Metadata.d.ts +13 -0
- package/serialization/types/Metadata.js +34 -0
- package/serialization/types/MetadataOptionsItem.d.ts +13 -0
- package/serialization/types/MetadataOptionsItem.js +34 -0
- package/serialization/types/OptionField.d.ts +19 -0
- package/serialization/types/OptionField.js +40 -0
- package/serialization/types/ReferenceField.d.ts +20 -0
- package/serialization/types/ReferenceField.js +41 -0
- package/serialization/types/ReferenceFieldMetadata.d.ts +12 -0
- package/serialization/types/ReferenceFieldMetadata.js +33 -0
- package/serialization/types/ReferenceFieldType.d.ts +10 -0
- package/serialization/types/ReferenceFieldType.js +31 -0
- package/serialization/types/Robots.d.ts +14 -0
- package/serialization/types/Robots.js +35 -0
- package/serialization/types/RobotsRulesItem.d.ts +14 -0
- package/serialization/types/RobotsRulesItem.js +35 -0
- package/serialization/types/StaticField.d.ts +18 -0
- package/serialization/{resources/collections/resources/fields/client/requests/FieldCreate.js → types/StaticField.js} +7 -5
- package/serialization/types/StaticFieldType.d.ts +10 -0
- package/serialization/{resources/collections/resources/fields/types/FieldCreateType.js → types/StaticFieldType.js} +3 -4
- package/serialization/types/WebhookList.d.ts +2 -2
- package/serialization/types/WebhookList.js +2 -2
- package/serialization/types/index.d.ts +12 -0
- package/serialization/types/index.js +12 -0
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/wrapper/AssetsClient.d.ts +12 -0
- package/wrapper/AssetsClient.js +16 -0
- package/wrapper/AssetsUtilitiesClient.d.ts +49 -0
- package/wrapper/AssetsUtilitiesClient.js +121 -0
- package/wrapper/WebflowClient.d.ts +6 -0
- package/wrapper/WebflowClient.js +10 -0
- package/wrapper/WebhooksClient.d.ts +39 -0
- package/wrapper/WebhooksClient.js +66 -0
- package/api/resources/collections/resources/fields/types/index.d.ts +0 -1
- package/dist/api/resources/collections/resources/fields/types/index.d.ts +0 -1
- package/dist/api/resources/collections/resources/fields/types/index.js +0 -17
- package/dist/serialization/resources/collections/resources/fields/client/requests/FieldCreate.d.ts +0 -16
- package/dist/serialization/resources/collections/resources/fields/types/FieldCreateType.d.ts +0 -10
- package/dist/serialization/resources/collections/resources/fields/types/index.d.ts +0 -1
- package/serialization/resources/collections/resources/fields/client/requests/FieldCreate.d.ts +0 -16
- package/serialization/resources/collections/resources/fields/types/FieldCreateType.d.ts +0 -10
- package/serialization/resources/collections/resources/fields/types/index.d.ts +0 -1
- package/serialization/resources/collections/resources/fields/types/index.js +0 -17
- /package/api/resources/{collections/resources/fields/client/requests/FieldCreate.js → forms/client/requests/FormsListSubmissionsBySiteRequest.js} +0 -0
- /package/{dist/api/resources/collections/resources/fields/client/requests/FieldCreate.js → api/types/Conflict.js} +0 -0
|
@@ -47,8 +47,9 @@ const url_join_1 = __importDefault(require("url-join"));
|
|
|
47
47
|
const errors = __importStar(require("../../../../errors/index"));
|
|
48
48
|
const Client_1 = require("../resources/redirects/client/Client");
|
|
49
49
|
const Client_2 = require("../resources/plans/client/Client");
|
|
50
|
-
const Client_3 = require("../resources/
|
|
51
|
-
const Client_4 = require("../resources/
|
|
50
|
+
const Client_3 = require("../resources/robotsTxt/client/Client");
|
|
51
|
+
const Client_4 = require("../resources/activityLogs/client/Client");
|
|
52
|
+
const Client_5 = require("../resources/scripts/client/Client");
|
|
52
53
|
/**
|
|
53
54
|
* Sites are the sites in your Webflow workspace.
|
|
54
55
|
*/
|
|
@@ -57,7 +58,9 @@ class Sites {
|
|
|
57
58
|
this._options = _options;
|
|
58
59
|
}
|
|
59
60
|
/**
|
|
60
|
-
* Create a site.
|
|
61
|
+
* Create a site.
|
|
62
|
+
*
|
|
63
|
+
* <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
61
64
|
*
|
|
62
65
|
* Required scope | `workspace:write`
|
|
63
66
|
*
|
|
@@ -83,7 +86,7 @@ class Sites {
|
|
|
83
86
|
const _response = yield core.fetcher({
|
|
84
87
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `workspaces/${encodeURIComponent(workspaceId)}/sites`),
|
|
85
88
|
method: "POST",
|
|
86
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.
|
|
89
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
87
90
|
contentType: "application/json",
|
|
88
91
|
requestType: "json",
|
|
89
92
|
body: serializers.SitesCreateRequest.jsonOrThrow(request, {
|
|
@@ -184,7 +187,7 @@ class Sites {
|
|
|
184
187
|
const _response = yield core.fetcher({
|
|
185
188
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, "sites"),
|
|
186
189
|
method: "GET",
|
|
187
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.
|
|
190
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
188
191
|
contentType: "application/json",
|
|
189
192
|
requestType: "json",
|
|
190
193
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -271,7 +274,7 @@ class Sites {
|
|
|
271
274
|
const _response = yield core.fetcher({
|
|
272
275
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}`),
|
|
273
276
|
method: "GET",
|
|
274
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.
|
|
277
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
275
278
|
contentType: "application/json",
|
|
276
279
|
requestType: "json",
|
|
277
280
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -346,7 +349,9 @@ class Sites {
|
|
|
346
349
|
});
|
|
347
350
|
}
|
|
348
351
|
/**
|
|
349
|
-
* Delete a site.
|
|
352
|
+
* Delete a site.
|
|
353
|
+
*
|
|
354
|
+
* <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
350
355
|
*
|
|
351
356
|
* Required scope | `sites:write`
|
|
352
357
|
*
|
|
@@ -369,7 +374,7 @@ class Sites {
|
|
|
369
374
|
const _response = yield core.fetcher({
|
|
370
375
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}`),
|
|
371
376
|
method: "DELETE",
|
|
372
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.
|
|
377
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
373
378
|
contentType: "application/json",
|
|
374
379
|
requestType: "json",
|
|
375
380
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -440,7 +445,9 @@ class Sites {
|
|
|
440
445
|
});
|
|
441
446
|
}
|
|
442
447
|
/**
|
|
443
|
-
* Update a site.
|
|
448
|
+
* Update a site.
|
|
449
|
+
*
|
|
450
|
+
* <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
444
451
|
*
|
|
445
452
|
* Required scope | `sites:write`
|
|
446
453
|
*
|
|
@@ -464,7 +471,7 @@ class Sites {
|
|
|
464
471
|
const _response = yield core.fetcher({
|
|
465
472
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}`),
|
|
466
473
|
method: "PATCH",
|
|
467
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.
|
|
474
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
468
475
|
contentType: "application/json",
|
|
469
476
|
requestType: "json",
|
|
470
477
|
body: serializers.SitesUpdateRequest.jsonOrThrow(request, {
|
|
@@ -568,7 +575,7 @@ class Sites {
|
|
|
568
575
|
const _response = yield core.fetcher({
|
|
569
576
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/custom_domains`),
|
|
570
577
|
method: "GET",
|
|
571
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.
|
|
578
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
572
579
|
contentType: "application/json",
|
|
573
580
|
requestType: "json",
|
|
574
581
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -668,7 +675,7 @@ class Sites {
|
|
|
668
675
|
const _response = yield core.fetcher({
|
|
669
676
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/publish`),
|
|
670
677
|
method: "POST",
|
|
671
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.
|
|
678
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
672
679
|
contentType: "application/json",
|
|
673
680
|
requestType: "json",
|
|
674
681
|
body: serializers.SitesPublishRequest.jsonOrThrow(request, {
|
|
@@ -749,13 +756,17 @@ class Sites {
|
|
|
749
756
|
var _a;
|
|
750
757
|
return ((_a = this._plans) !== null && _a !== void 0 ? _a : (this._plans = new Client_2.Plans(this._options)));
|
|
751
758
|
}
|
|
759
|
+
get robotsTxt() {
|
|
760
|
+
var _a;
|
|
761
|
+
return ((_a = this._robotsTxt) !== null && _a !== void 0 ? _a : (this._robotsTxt = new Client_3.RobotsTxt(this._options)));
|
|
762
|
+
}
|
|
752
763
|
get activityLogs() {
|
|
753
764
|
var _a;
|
|
754
|
-
return ((_a = this._activityLogs) !== null && _a !== void 0 ? _a : (this._activityLogs = new
|
|
765
|
+
return ((_a = this._activityLogs) !== null && _a !== void 0 ? _a : (this._activityLogs = new Client_4.ActivityLogs(this._options)));
|
|
755
766
|
}
|
|
756
767
|
get scripts() {
|
|
757
768
|
var _a;
|
|
758
|
-
return ((_a = this._scripts) !== null && _a !== void 0 ? _a : (this._scripts = new
|
|
769
|
+
return ((_a = this._scripts) !== null && _a !== void 0 ? _a : (this._scripts = new Client_5.Scripts(this._options)));
|
|
759
770
|
}
|
|
760
771
|
_getAuthorizationHeader() {
|
|
761
772
|
return __awaiter(this, void 0, void 0, function* () {
|
|
@@ -24,7 +24,11 @@ export declare class ActivityLogs {
|
|
|
24
24
|
protected readonly _options: ActivityLogs.Options;
|
|
25
25
|
constructor(_options: ActivityLogs.Options);
|
|
26
26
|
/**
|
|
27
|
-
* Retrieve Activity Logs for a specific Site.
|
|
27
|
+
* Retrieve Activity Logs for a specific Site.
|
|
28
|
+
*
|
|
29
|
+
* <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
30
|
+
*
|
|
31
|
+
* Required scope: `site_activity:read`
|
|
28
32
|
*
|
|
29
33
|
* @param {string} siteId - Unique identifier for a Site
|
|
30
34
|
* @param {Webflow.sites.ActivityLogsListRequest} request
|
|
@@ -50,7 +50,11 @@ class ActivityLogs {
|
|
|
50
50
|
this._options = _options;
|
|
51
51
|
}
|
|
52
52
|
/**
|
|
53
|
-
* Retrieve Activity Logs for a specific Site.
|
|
53
|
+
* Retrieve Activity Logs for a specific Site.
|
|
54
|
+
*
|
|
55
|
+
* <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
56
|
+
*
|
|
57
|
+
* Required scope: `site_activity:read`
|
|
54
58
|
*
|
|
55
59
|
* @param {string} siteId - Unique identifier for a Site
|
|
56
60
|
* @param {Webflow.sites.ActivityLogsListRequest} request
|
|
@@ -78,7 +82,7 @@ class ActivityLogs {
|
|
|
78
82
|
const _response = yield core.fetcher({
|
|
79
83
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/activity_logs`),
|
|
80
84
|
method: "GET",
|
|
81
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.
|
|
85
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
82
86
|
contentType: "application/json",
|
|
83
87
|
queryParameters: _queryParams,
|
|
84
88
|
requestType: "json",
|
|
@@ -26,9 +26,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
|
26
26
|
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
27
27
|
};
|
|
28
28
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
29
|
-
exports.scripts = exports.activityLogs = exports.plans = exports.redirects = void 0;
|
|
29
|
+
exports.scripts = exports.activityLogs = exports.robotsTxt = exports.plans = exports.redirects = void 0;
|
|
30
30
|
exports.redirects = __importStar(require("./redirects"));
|
|
31
31
|
exports.plans = __importStar(require("./plans"));
|
|
32
|
+
exports.robotsTxt = __importStar(require("./robotsTxt"));
|
|
32
33
|
exports.activityLogs = __importStar(require("./activityLogs"));
|
|
33
34
|
exports.scripts = __importStar(require("./scripts"));
|
|
34
35
|
__exportStar(require("./activityLogs/client/requests"), exports);
|
|
@@ -26,6 +26,8 @@ export declare class Plans {
|
|
|
26
26
|
/**
|
|
27
27
|
* Get site plan details for the specified Site.
|
|
28
28
|
*
|
|
29
|
+
* <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
30
|
+
*
|
|
29
31
|
* Required scope | `sites:read`
|
|
30
32
|
*
|
|
31
33
|
* @param {string} siteId - Unique identifier for a Site
|
|
@@ -52,6 +52,8 @@ class Plans {
|
|
|
52
52
|
/**
|
|
53
53
|
* Get site plan details for the specified Site.
|
|
54
54
|
*
|
|
55
|
+
* <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
56
|
+
*
|
|
55
57
|
* Required scope | `sites:read`
|
|
56
58
|
*
|
|
57
59
|
* @param {string} siteId - Unique identifier for a Site
|
|
@@ -72,7 +74,7 @@ class Plans {
|
|
|
72
74
|
const _response = yield core.fetcher({
|
|
73
75
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/plan`),
|
|
74
76
|
method: "GET",
|
|
75
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.
|
|
77
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
76
78
|
contentType: "application/json",
|
|
77
79
|
requestType: "json",
|
|
78
80
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -28,6 +28,7 @@ export declare class Redirects {
|
|
|
28
28
|
*
|
|
29
29
|
* Use this endpoint to review, audit, or manage the redirection rules that control how traffic is rerouted on your site.
|
|
30
30
|
*
|
|
31
|
+
* <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
31
32
|
*
|
|
32
33
|
* Required scope: `sites:read`
|
|
33
34
|
*
|
|
@@ -49,6 +50,8 @@ export declare class Redirects {
|
|
|
49
50
|
*
|
|
50
51
|
* 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.
|
|
51
52
|
*
|
|
53
|
+
* <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
54
|
+
*
|
|
52
55
|
* Required scope: `sites:write`
|
|
53
56
|
*
|
|
54
57
|
* @param {string} siteId - Unique identifier for a Site
|
|
@@ -71,7 +74,11 @@ export declare class Redirects {
|
|
|
71
74
|
create(siteId: string, request: Webflow.Redirect, requestOptions?: Redirects.RequestOptions): Promise<Webflow.Redirect>;
|
|
72
75
|
/**
|
|
73
76
|
* Remove a URL redirection rule from a site.
|
|
77
|
+
*
|
|
74
78
|
* This is useful for cleaning up outdated or unnecessary redirects, ensuring that your site's routing behavior remains efficient and up-to-date.
|
|
79
|
+
*
|
|
80
|
+
* <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
81
|
+
*
|
|
75
82
|
* Required scope: `sites:write`
|
|
76
83
|
*
|
|
77
84
|
* @param {string} siteId - Unique identifier for a Site
|
|
@@ -90,6 +97,9 @@ export declare class Redirects {
|
|
|
90
97
|
delete(siteId: string, redirectId: string, requestOptions?: Redirects.RequestOptions): Promise<Webflow.Redirects>;
|
|
91
98
|
/**
|
|
92
99
|
* Update a URL redirection rule from a site.
|
|
100
|
+
*
|
|
101
|
+
* <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
102
|
+
*
|
|
93
103
|
* Required scope: `sites:write`
|
|
94
104
|
*
|
|
95
105
|
* @param {string} siteId - Unique identifier for a Site
|
|
@@ -54,6 +54,7 @@ class Redirects {
|
|
|
54
54
|
*
|
|
55
55
|
* Use this endpoint to review, audit, or manage the redirection rules that control how traffic is rerouted on your site.
|
|
56
56
|
*
|
|
57
|
+
* <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
57
58
|
*
|
|
58
59
|
* Required scope: `sites:read`
|
|
59
60
|
*
|
|
@@ -75,7 +76,7 @@ class Redirects {
|
|
|
75
76
|
const _response = yield core.fetcher({
|
|
76
77
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/redirects`),
|
|
77
78
|
method: "GET",
|
|
78
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.
|
|
79
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
79
80
|
contentType: "application/json",
|
|
80
81
|
requestType: "json",
|
|
81
82
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -154,6 +155,8 @@ class Redirects {
|
|
|
154
155
|
*
|
|
155
156
|
* 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.
|
|
156
157
|
*
|
|
158
|
+
* <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
159
|
+
*
|
|
157
160
|
* Required scope: `sites:write`
|
|
158
161
|
*
|
|
159
162
|
* @param {string} siteId - Unique identifier for a Site
|
|
@@ -179,7 +182,7 @@ class Redirects {
|
|
|
179
182
|
const _response = yield core.fetcher({
|
|
180
183
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/redirects`),
|
|
181
184
|
method: "POST",
|
|
182
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.
|
|
185
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
183
186
|
contentType: "application/json",
|
|
184
187
|
requestType: "json",
|
|
185
188
|
body: serializers.Redirect.jsonOrThrow(request, {
|
|
@@ -260,7 +263,11 @@ class Redirects {
|
|
|
260
263
|
}
|
|
261
264
|
/**
|
|
262
265
|
* Remove a URL redirection rule from a site.
|
|
266
|
+
*
|
|
263
267
|
* This is useful for cleaning up outdated or unnecessary redirects, ensuring that your site's routing behavior remains efficient and up-to-date.
|
|
268
|
+
*
|
|
269
|
+
* <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
270
|
+
*
|
|
264
271
|
* Required scope: `sites:write`
|
|
265
272
|
*
|
|
266
273
|
* @param {string} siteId - Unique identifier for a Site
|
|
@@ -282,7 +289,7 @@ class Redirects {
|
|
|
282
289
|
const _response = yield core.fetcher({
|
|
283
290
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/redirects/${encodeURIComponent(redirectId)}`),
|
|
284
291
|
method: "DELETE",
|
|
285
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.
|
|
292
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
286
293
|
contentType: "application/json",
|
|
287
294
|
requestType: "json",
|
|
288
295
|
timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
|
|
@@ -358,6 +365,9 @@ class Redirects {
|
|
|
358
365
|
}
|
|
359
366
|
/**
|
|
360
367
|
* Update a URL redirection rule from a site.
|
|
368
|
+
*
|
|
369
|
+
* <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
|
|
370
|
+
*
|
|
361
371
|
* Required scope: `sites:write`
|
|
362
372
|
*
|
|
363
373
|
* @param {string} siteId - Unique identifier for a Site
|
|
@@ -384,7 +394,7 @@ class Redirects {
|
|
|
384
394
|
const _response = yield core.fetcher({
|
|
385
395
|
url: (0, url_join_1.default)((_a = (yield core.Supplier.get(this._options.environment))) !== null && _a !== void 0 ? _a : environments.WebflowEnvironment.Default, `sites/${encodeURIComponent(siteId)}/redirects/${encodeURIComponent(redirectId)}`),
|
|
386
396
|
method: "PATCH",
|
|
387
|
-
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.
|
|
397
|
+
headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.2", "User-Agent": "webflow-api/3.1.1", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
|
|
388
398
|
contentType: "application/json",
|
|
389
399
|
requestType: "json",
|
|
390
400
|
body: serializers.Redirect.jsonOrThrow(request, {
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* This file was auto-generated by Fern from our API Definition.
|
|
3
|
+
*/
|
|
4
|
+
import * as environments from "../../../../../../environments";
|
|
5
|
+
import * as core from "../../../../../../core";
|
|
6
|
+
import * as Webflow from "../../../../../index";
|
|
7
|
+
export declare namespace RobotsTxt {
|
|
8
|
+
interface Options {
|
|
9
|
+
environment?: core.Supplier<environments.WebflowEnvironment | string>;
|
|
10
|
+
accessToken: core.Supplier<core.BearerToken>;
|
|
11
|
+
}
|
|
12
|
+
interface RequestOptions {
|
|
13
|
+
/** The maximum time to wait for a response in seconds. */
|
|
14
|
+
timeoutInSeconds?: number;
|
|
15
|
+
/** The number of times to retry the request. Defaults to 2. */
|
|
16
|
+
maxRetries?: number;
|
|
17
|
+
/** A hook to abort the request. */
|
|
18
|
+
abortSignal?: AbortSignal;
|
|
19
|
+
/** Additional headers to include in the request. */
|
|
20
|
+
headers?: Record<string, string>;
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
export declare class RobotsTxt {
|
|
24
|
+
protected readonly _options: RobotsTxt.Options;
|
|
25
|
+
constructor(_options: RobotsTxt.Options);
|
|
26
|
+
/**
|
|
27
|
+
* Retrieve the robots.txt configuration for various user agents.
|
|
28
|
+
*
|
|
29
|
+
* Required scope: `site_config:read`
|
|
30
|
+
*
|
|
31
|
+
* @param {string} siteId - Unique identifier for a Site
|
|
32
|
+
* @param {RobotsTxt.RequestOptions} requestOptions - Request-specific configuration.
|
|
33
|
+
*
|
|
34
|
+
* @throws {@link Webflow.BadRequestError}
|
|
35
|
+
* @throws {@link Webflow.UnauthorizedError}
|
|
36
|
+
* @throws {@link Webflow.NotFoundError}
|
|
37
|
+
* @throws {@link Webflow.TooManyRequestsError}
|
|
38
|
+
* @throws {@link Webflow.InternalServerError}
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* await client.sites.robotsTxt.get("580e63e98c9a982ac9b8b741")
|
|
42
|
+
*/
|
|
43
|
+
get(siteId: string, requestOptions?: RobotsTxt.RequestOptions): Promise<Webflow.Robots>;
|
|
44
|
+
/**
|
|
45
|
+
* Replace the `robots.txt` configuration for various user agents.
|
|
46
|
+
*
|
|
47
|
+
* Required scope | `site_config:write`
|
|
48
|
+
*
|
|
49
|
+
* @param {string} siteId - Unique identifier for a Site
|
|
50
|
+
* @param {Webflow.Robots} request
|
|
51
|
+
* @param {RobotsTxt.RequestOptions} requestOptions - Request-specific configuration.
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link Webflow.BadRequestError}
|
|
54
|
+
* @throws {@link Webflow.UnauthorizedError}
|
|
55
|
+
* @throws {@link Webflow.NotFoundError}
|
|
56
|
+
* @throws {@link Webflow.TooManyRequestsError}
|
|
57
|
+
* @throws {@link Webflow.InternalServerError}
|
|
58
|
+
*
|
|
59
|
+
* @example
|
|
60
|
+
* await client.sites.robotsTxt.put("580e63e98c9a982ac9b8b741", {
|
|
61
|
+
* rules: [{
|
|
62
|
+
* userAgent: "googlebot",
|
|
63
|
+
* allows: ["/public"],
|
|
64
|
+
* disallows: ["/vogon-poetry", "/total-perspective-vortex"]
|
|
65
|
+
* }],
|
|
66
|
+
* sitemap: "https://heartofgold.ship/sitemap.xml"
|
|
67
|
+
* })
|
|
68
|
+
*/
|
|
69
|
+
put(siteId: string, request: Webflow.Robots, requestOptions?: RobotsTxt.RequestOptions): Promise<Webflow.Robots>;
|
|
70
|
+
/**
|
|
71
|
+
* 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.
|
|
72
|
+
*
|
|
73
|
+
* **Note:** Deleting a user-agent with no rules will make the user-agent's access unrestricted unless other directives apply.
|
|
74
|
+
*
|
|
75
|
+
* Required scope: `site_config:write`
|
|
76
|
+
*
|
|
77
|
+
* @param {string} siteId - Unique identifier for a Site
|
|
78
|
+
* @param {Webflow.Robots} request
|
|
79
|
+
* @param {RobotsTxt.RequestOptions} requestOptions - Request-specific configuration.
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link Webflow.BadRequestError}
|
|
82
|
+
* @throws {@link Webflow.UnauthorizedError}
|
|
83
|
+
* @throws {@link Webflow.NotFoundError}
|
|
84
|
+
* @throws {@link Webflow.TooManyRequestsError}
|
|
85
|
+
* @throws {@link Webflow.InternalServerError}
|
|
86
|
+
*
|
|
87
|
+
* @example
|
|
88
|
+
* await client.sites.robotsTxt.delete("580e63e98c9a982ac9b8b741", {
|
|
89
|
+
* rules: [{
|
|
90
|
+
* userAgent: "*",
|
|
91
|
+
* allows: ["/public"],
|
|
92
|
+
* disallows: ["/bubbles"]
|
|
93
|
+
* }]
|
|
94
|
+
* })
|
|
95
|
+
*/
|
|
96
|
+
delete(siteId: string, request: Webflow.Robots, requestOptions?: RobotsTxt.RequestOptions): Promise<Webflow.Robots>;
|
|
97
|
+
/**
|
|
98
|
+
* Update the `robots.txt` configuration for various user agents.
|
|
99
|
+
*
|
|
100
|
+
* Required scope | `site_config:write`
|
|
101
|
+
*
|
|
102
|
+
* @param {string} siteId - Unique identifier for a Site
|
|
103
|
+
* @param {Webflow.Robots} request
|
|
104
|
+
* @param {RobotsTxt.RequestOptions} requestOptions - Request-specific configuration.
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link Webflow.BadRequestError}
|
|
107
|
+
* @throws {@link Webflow.UnauthorizedError}
|
|
108
|
+
* @throws {@link Webflow.NotFoundError}
|
|
109
|
+
* @throws {@link Webflow.TooManyRequestsError}
|
|
110
|
+
* @throws {@link Webflow.InternalServerError}
|
|
111
|
+
*
|
|
112
|
+
* @example
|
|
113
|
+
* await client.sites.robotsTxt.patch("580e63e98c9a982ac9b8b741", {
|
|
114
|
+
* rules: [{
|
|
115
|
+
* userAgent: "googlebot",
|
|
116
|
+
* allows: ["/public"],
|
|
117
|
+
* disallows: ["/vogon-poetry", "/total-perspective-vortex"]
|
|
118
|
+
* }],
|
|
119
|
+
* sitemap: "https://heartofgold.ship/sitemap.xml"
|
|
120
|
+
* })
|
|
121
|
+
*/
|
|
122
|
+
patch(siteId: string, request: Webflow.Robots, requestOptions?: RobotsTxt.RequestOptions): Promise<Webflow.Robots>;
|
|
123
|
+
protected _getAuthorizationHeader(): Promise<string>;
|
|
124
|
+
}
|