webflow-api 3.1.0 → 3.1.2

package/dist/api/resources/sites/resources/activityLogs/client/Client.js

@@ -50,7 +50,11 @@ class ActivityLogs {
         this._options = _options;
     }
     /**
-     * Retrieve Activity Logs for a specific Site. Requires Site to be on an Enterprise plan. </br></br>  Required scope | `site_activity:read`
+     * Retrieve Activity Logs for a specific Site.
+     *
+     * <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
+     *
+     * Required scope: `site_activity:read`
      *
      * @param {string} siteId - Unique identifier for a Site
      * @param {Webflow.sites.ActivityLogsListRequest} request
@@ -78,7 +82,7 @@ class ActivityLogs {
             const _response = yield core.fetcher({
                 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`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                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),
                 contentType: "application/json",
                 queryParameters: _queryParams,
                 requestType: "json",

package/dist/api/resources/sites/resources/index.d.ts

@@ -1,5 +1,6 @@
 export * as redirects from "./redirects";
 export * as plans from "./plans";
+export * as robotsTxt from "./robotsTxt";
 export * as activityLogs from "./activityLogs";
 export * as scripts from "./scripts";
 export * from "./activityLogs/client/requests";

package/dist/api/resources/sites/resources/index.js

@@ -26,9 +26,10 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.scripts = exports.activityLogs = exports.plans = exports.redirects = void 0;
+exports.scripts = exports.activityLogs = exports.robotsTxt = exports.plans = exports.redirects = void 0;
 exports.redirects = __importStar(require("./redirects"));
 exports.plans = __importStar(require("./plans"));
+exports.robotsTxt = __importStar(require("./robotsTxt"));
 exports.activityLogs = __importStar(require("./activityLogs"));
 exports.scripts = __importStar(require("./scripts"));
 __exportStar(require("./activityLogs/client/requests"), exports);

package/dist/api/resources/sites/resources/plans/client/Client.d.ts

@@ -26,6 +26,8 @@ export declare class Plans {
     /**
      * Get site plan details for the specified Site.
      *
+     * <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
+     *
      * Required scope | `sites:read`
      *
      * @param {string} siteId - Unique identifier for a Site

package/dist/api/resources/sites/resources/plans/client/Client.js

@@ -52,6 +52,8 @@ class Plans {
     /**
      * Get site plan details for the specified Site.
      *
+     * <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
+     *
      * Required scope | `sites:read`
      *
      * @param {string} siteId - Unique identifier for a Site
@@ -72,7 +74,7 @@ class Plans {
             const _response = yield core.fetcher({
                 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`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                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),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,

package/dist/api/resources/sites/resources/redirects/client/Client.d.ts

@@ -28,6 +28,7 @@ export declare class Redirects {
      *
      * Use this endpoint to review, audit, or manage the redirection rules that control how traffic is rerouted on your site.
      *
+     * <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
      *
      * Required scope: `sites:read`
      *
@@ -49,6 +50,8 @@ export declare class Redirects {
      *
      * 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.
      *
+     * <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
+     *
      * Required scope: `sites:write`
      *
      * @param {string} siteId - Unique identifier for a Site
@@ -71,7 +74,11 @@ export declare class Redirects {
     create(siteId: string, request: Webflow.Redirect, requestOptions?: Redirects.RequestOptions): Promise<Webflow.Redirect>;
     /**
      * 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.
+     *
+     * <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
+     *
      * Required scope: `sites:write`
      *
      * @param {string} siteId - Unique identifier for a Site
@@ -90,6 +97,9 @@ export declare class Redirects {
     delete(siteId: string, redirectId: string, requestOptions?: Redirects.RequestOptions): Promise<Webflow.Redirects>;
     /**
      * Update a URL redirection rule from a site.
+     *
+     * <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
+     *
      * Required scope: `sites:write`
      *
      * @param {string} siteId - Unique identifier for a Site

package/dist/api/resources/sites/resources/redirects/client/Client.js

@@ -54,6 +54,7 @@ class Redirects {
      *
      * Use this endpoint to review, audit, or manage the redirection rules that control how traffic is rerouted on your site.
      *
+     * <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
      *
      * Required scope: `sites:read`
      *
@@ -75,7 +76,7 @@ class Redirects {
             const _response = yield core.fetcher({
                 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`),
                 method: "GET",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                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),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -154,6 +155,8 @@ class Redirects {
      *
      * 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.
      *
+     * <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
+     *
      * Required scope: `sites:write`
      *
      * @param {string} siteId - Unique identifier for a Site
@@ -179,7 +182,7 @@ class Redirects {
             const _response = yield core.fetcher({
                 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`),
                 method: "POST",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                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),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.Redirect.jsonOrThrow(request, {
@@ -260,7 +263,11 @@ class Redirects {
     }
     /**
      * 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.
+     *
+     * <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
+     *
      * Required scope: `sites:write`
      *
      * @param {string} siteId - Unique identifier for a Site
@@ -282,7 +289,7 @@ class Redirects {
             const _response = yield core.fetcher({
                 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)}`),
                 method: "DELETE",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                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),
                 contentType: "application/json",
                 requestType: "json",
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -358,6 +365,9 @@ class Redirects {
     }
     /**
      * Update a URL redirection rule from a site.
+     *
+     * <Warning title="Enterprise Only">This endpoint requires an Enterprise workspace.</Warning>
+     *
      * Required scope: `sites:write`
      *
      * @param {string} siteId - Unique identifier for a Site
@@ -384,7 +394,7 @@ class Redirects {
             const _response = yield core.fetcher({
                 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)}`),
                 method: "PATCH",
-                headers: Object.assign({ Authorization: yield this._getAuthorizationHeader(), "X-Fern-Language": "JavaScript", "X-Fern-SDK-Name": "webflow-api", "X-Fern-SDK-Version": "3.1.0", "User-Agent": "webflow-api/3.1.0", "X-Fern-Runtime": core.RUNTIME.type, "X-Fern-Runtime-Version": core.RUNTIME.version }, requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                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),
                 contentType: "application/json",
                 requestType: "json",
                 body: serializers.Redirect.jsonOrThrow(request, {

package/dist/api/resources/sites/resources/robotsTxt/client/Client.d.ts

@@ -0,0 +1,124 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../../../environments";
+import * as core from "../../../../../../core";
+import * as Webflow from "../../../../../index";
+export declare namespace RobotsTxt {
+    interface Options {
+        environment?: core.Supplier<environments.WebflowEnvironment | string>;
+        accessToken: core.Supplier<core.BearerToken>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string>;
+    }
+}
+export declare class RobotsTxt {
+    protected readonly _options: RobotsTxt.Options;
+    constructor(_options: RobotsTxt.Options);
+    /**
+     * Retrieve the robots.txt configuration for various user agents.
+     *
+     * Required scope: `site_config:read`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {RobotsTxt.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Webflow.BadRequestError}
+     * @throws {@link Webflow.UnauthorizedError}
+     * @throws {@link Webflow.NotFoundError}
+     * @throws {@link Webflow.TooManyRequestsError}
+     * @throws {@link Webflow.InternalServerError}
+     *
+     * @example
+     *     await client.sites.robotsTxt.get("580e63e98c9a982ac9b8b741")
+     */
+    get(siteId: string, requestOptions?: RobotsTxt.RequestOptions): Promise<Webflow.Robots>;
+    /**
+     * Replace the `robots.txt` configuration for various user agents.
+     *
+     * Required scope | `site_config:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.Robots} request
+     * @param {RobotsTxt.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Webflow.BadRequestError}
+     * @throws {@link Webflow.UnauthorizedError}
+     * @throws {@link Webflow.NotFoundError}
+     * @throws {@link Webflow.TooManyRequestsError}
+     * @throws {@link Webflow.InternalServerError}
+     *
+     * @example
+     *     await client.sites.robotsTxt.put("580e63e98c9a982ac9b8b741", {
+     *         rules: [{
+     *                 userAgent: "googlebot",
+     *                 allows: ["/public"],
+     *                 disallows: ["/vogon-poetry", "/total-perspective-vortex"]
+     *             }],
+     *         sitemap: "https://heartofgold.ship/sitemap.xml"
+     *     })
+     */
+    put(siteId: string, request: Webflow.Robots, requestOptions?: RobotsTxt.RequestOptions): Promise<Webflow.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.
+     *
+     * Required scope: `site_config:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.Robots} request
+     * @param {RobotsTxt.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Webflow.BadRequestError}
+     * @throws {@link Webflow.UnauthorizedError}
+     * @throws {@link Webflow.NotFoundError}
+     * @throws {@link Webflow.TooManyRequestsError}
+     * @throws {@link Webflow.InternalServerError}
+     *
+     * @example
+     *     await client.sites.robotsTxt.delete("580e63e98c9a982ac9b8b741", {
+     *         rules: [{
+     *                 userAgent: "*",
+     *                 allows: ["/public"],
+     *                 disallows: ["/bubbles"]
+     *             }]
+     *     })
+     */
+    delete(siteId: string, request: Webflow.Robots, requestOptions?: RobotsTxt.RequestOptions): Promise<Webflow.Robots>;
+    /**
+     * Update the `robots.txt` configuration for various user agents.
+     *
+     * Required scope | `site_config:write`
+     *
+     * @param {string} siteId - Unique identifier for a Site
+     * @param {Webflow.Robots} request
+     * @param {RobotsTxt.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Webflow.BadRequestError}
+     * @throws {@link Webflow.UnauthorizedError}
+     * @throws {@link Webflow.NotFoundError}
+     * @throws {@link Webflow.TooManyRequestsError}
+     * @throws {@link Webflow.InternalServerError}
+     *
+     * @example
+     *     await client.sites.robotsTxt.patch("580e63e98c9a982ac9b8b741", {
+     *         rules: [{
+     *                 userAgent: "googlebot",
+     *                 allows: ["/public"],
+     *                 disallows: ["/vogon-poetry", "/total-perspective-vortex"]
+     *             }],
+     *         sitemap: "https://heartofgold.ship/sitemap.xml"
+     *     })
+     */
+    patch(siteId: string, request: Webflow.Robots, requestOptions?: RobotsTxt.RequestOptions): Promise<Webflow.Robots>;
+    protected _getAuthorizationHeader(): Promise<string>;
+}