webflow-api 3.1.0 → 3.1.1

package/serialization/types/RobotsRulesItem.js

@@ -0,0 +1,35 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RobotsRulesItem = void 0;
+const core = __importStar(require("../../core"));
+exports.RobotsRulesItem = core.serialization.object({
+    userAgent: core.serialization.string(),
+    allows: core.serialization.list(core.serialization.string()).optional(),
+    disallows: core.serialization.list(core.serialization.string()).optional(),
+});

package/serialization/types/StaticField.d.ts

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../index";
+import * as Webflow from "../../api/index";
+import * as core from "../../core";
+import { StaticFieldType } from "./StaticFieldType";
+export declare const StaticField: core.serialization.ObjectSchema<serializers.StaticField.Raw, Webflow.StaticField>;
+export declare namespace StaticField {
+    interface Raw {
+        id?: string | null;
+        isEditable?: boolean | null;
+        isRequired?: boolean | null;
+        type: StaticFieldType.Raw;
+        displayName: string;
+        helpText?: string | null;
+    }
+}

package/serialization/{resources/collections/resources/fields/client/requests/FieldCreate.js → types/StaticField.js}

@@ -26,12 +26,14 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FieldCreate = void 0;
-const core = __importStar(require("../../../../../../../core"));
-const FieldCreateType_1 = require("../../types/FieldCreateType");
-exports.FieldCreate = core.serialization.object({
+exports.StaticField = void 0;
+const core = __importStar(require("../../core"));
+const StaticFieldType_1 = require("./StaticFieldType");
+exports.StaticField = core.serialization.object({
+    id: core.serialization.string().optional(),
+    isEditable: core.serialization.boolean().optional(),
     isRequired: core.serialization.boolean().optional(),
-    type: FieldCreateType_1.FieldCreateType,
+    type: StaticFieldType_1.StaticFieldType,
     displayName: core.serialization.string(),
     helpText: core.serialization.string().optional(),
 });

package/serialization/types/StaticFieldType.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../index";
+import * as Webflow from "../../api/index";
+import * as core from "../../core";
+export declare const StaticFieldType: core.serialization.Schema<serializers.StaticFieldType.Raw, Webflow.StaticFieldType>;
+export declare namespace StaticFieldType {
+    type Raw = "Color" | "DateTime" | "Email" | "File" | "Image" | "Link" | "MultiImage" | "Number" | "Phone" | "PlainText" | "RichText" | "Switch" | "Video";
+}

package/serialization/{resources/collections/resources/fields/types/FieldCreateType.js → types/StaticFieldType.js}

@@ -26,13 +26,12 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FieldCreateType = void 0;
-const core = __importStar(require("../../../../../../core"));
-exports.FieldCreateType = core.serialization.enum_([
+exports.StaticFieldType = void 0;
+const core = __importStar(require("../../core"));
+exports.StaticFieldType = core.serialization.enum_([
     "Color",
     "DateTime",
     "Email",
-    "ExtFileRef",
     "File",
     "Image",
     "Link",

package/serialization/types/WebhookList.d.ts

@@ -4,12 +4,12 @@
 import * as serializers from "../index";
 import * as Webflow from "../../api/index";
 import * as core from "../../core";
-import { Pagination } from "./Pagination";
 import { Webhook } from "./Webhook";
+import { Pagination } from "./Pagination";
 export declare const WebhookList: core.serialization.ObjectSchema<serializers.WebhookList.Raw, Webflow.WebhookList>;
 export declare namespace WebhookList {
     interface Raw {
-        pagination?: Pagination.Raw | null;
         webhooks?: Webhook.Raw[] | null;
+        pagination?: Pagination.Raw | null;
     }
 }

package/serialization/types/WebhookList.js

@@ -28,9 +28,9 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebhookList = void 0;
 const core = __importStar(require("../../core"));
-const Pagination_1 = require("./Pagination");
 const Webhook_1 = require("./Webhook");
+const Pagination_1 = require("./Pagination");
 exports.WebhookList = core.serialization.object({
-    pagination: Pagination_1.Pagination.optional(),
     webhooks: core.serialization.list(Webhook_1.Webhook).optional(),
+    pagination: Pagination_1.Pagination.optional(),
 });

package/serialization/types/index.d.ts

@@ -26,6 +26,8 @@ export * from "./Redirects";
 export * from "./SitePlanId";
 export * from "./SitePlanName";
 export * from "./SitePlan";
+export * from "./RobotsRulesItem";
+export * from "./Robots";
 export * from "./SiteActivityLogItemEvent";
 export * from "./SiteActivityLogItemResourceOperation";
 export * from "./SiteActivityLogItemUser";
@@ -33,6 +35,15 @@ export * from "./SiteActivityLogItem";
 export * from "./SiteActivityLogResponse";
 export * from "./CollectionListArrayItem";
 export * from "./CollectionList";
+export * from "./StaticFieldType";
+export * from "./StaticField";
+export * from "./MetadataOptionsItem";
+export * from "./Metadata";
+export * from "./OptionField";
+export * from "./ReferenceFieldType";
+export * from "./ReferenceFieldMetadata";
+export * from "./ReferenceField";
+export * from "./FieldCreate";
 export * from "./FieldType";
 export * from "./Field";
 export * from "./Collection";
@@ -45,6 +56,7 @@ export * from "./CollectionItemPostSingle";
 export * from "./CollectionItemWithIdInputFieldData";
 export * from "./CollectionItemWithIdInput";
 export * from "./CollectionItemListNoPagination";
+export * from "./Conflict";
 export * from "./BulkCollectionItemFieldData";
 export * from "./BulkCollectionItem";
 export * from "./CollectionItemPatchSingleFieldData";

package/serialization/types/index.js

@@ -42,6 +42,8 @@ __exportStar(require("./Redirects"), exports);
 __exportStar(require("./SitePlanId"), exports);
 __exportStar(require("./SitePlanName"), exports);
 __exportStar(require("./SitePlan"), exports);
+__exportStar(require("./RobotsRulesItem"), exports);
+__exportStar(require("./Robots"), exports);
 __exportStar(require("./SiteActivityLogItemEvent"), exports);
 __exportStar(require("./SiteActivityLogItemResourceOperation"), exports);
 __exportStar(require("./SiteActivityLogItemUser"), exports);
@@ -49,6 +51,15 @@ __exportStar(require("./SiteActivityLogItem"), exports);
 __exportStar(require("./SiteActivityLogResponse"), exports);
 __exportStar(require("./CollectionListArrayItem"), exports);
 __exportStar(require("./CollectionList"), exports);
+__exportStar(require("./StaticFieldType"), exports);
+__exportStar(require("./StaticField"), exports);
+__exportStar(require("./MetadataOptionsItem"), exports);
+__exportStar(require("./Metadata"), exports);
+__exportStar(require("./OptionField"), exports);
+__exportStar(require("./ReferenceFieldType"), exports);
+__exportStar(require("./ReferenceFieldMetadata"), exports);
+__exportStar(require("./ReferenceField"), exports);
+__exportStar(require("./FieldCreate"), exports);
 __exportStar(require("./FieldType"), exports);
 __exportStar(require("./Field"), exports);
 __exportStar(require("./Collection"), exports);
@@ -61,6 +72,7 @@ __exportStar(require("./CollectionItemPostSingle"), exports);
 __exportStar(require("./CollectionItemWithIdInputFieldData"), exports);
 __exportStar(require("./CollectionItemWithIdInput"), exports);
 __exportStar(require("./CollectionItemListNoPagination"), exports);
+__exportStar(require("./Conflict"), exports);
 __exportStar(require("./BulkCollectionItemFieldData"), exports);
 __exportStar(require("./BulkCollectionItem"), exports);
 __exportStar(require("./CollectionItemPatchSingleFieldData"), exports);

package/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "3.1.0";
+export declare const SDK_VERSION = "3.1.1";

package/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "3.1.0";
+exports.SDK_VERSION = "3.1.1";

package/wrapper/WebflowClient.d.ts

@@ -1,8 +1,11 @@
 import { WebflowClient as FernClient } from "../Client";
 import { OauthScope } from "../api/types/OAuthScope";
+import { Client as Webhooks } from "./WebhooksClient";
 export declare class WebflowClient extends FernClient {
     protected readonly _options: FernClient.Options;
     constructor(_options: FernClient.Options);
+    protected _webhooks: Webhooks | undefined;
+    get webhooks(): Webhooks;
     /**
      * @param clientId The OAuth client ID
      * @param state The state

package/wrapper/WebflowClient.js

@@ -41,11 +41,16 @@ const Client_1 = require("../Client");
 const core = __importStar(require("../core"));
 const errors = __importStar(require("../errors"));
 const version_1 = require("../version");
+const WebhooksClient_1 = require("./WebhooksClient");
 class WebflowClient extends Client_1.WebflowClient {
     constructor(_options) {
         super(_options);
         this._options = _options;
     }
+    get webhooks() {
+        var _a;
+        return ((_a = this._webhooks) !== null && _a !== void 0 ? _a : (this._webhooks = new WebhooksClient_1.Client(this._options)));
+    }
     /**
      * @param clientId The OAuth client ID
      * @param state The state

package/wrapper/WebhooksClient.d.ts

@@ -0,0 +1,39 @@
+import { Webhooks } from "../api/resources/webhooks/client/Client";
+declare module "../api/resources/webhooks/client/Client" {
+    namespace Webhooks {
+        interface RequestSignatureDetails {
+            /** The headers of the incoming webhook request as a record-like object */
+            headers: Record<string, string>;
+            /** The body of the incoming webhook request as a string */
+            body: string;
+            /** The secret key generated when creating the webhook or the OAuth client secret */
+            secret: string;
+        }
+    }
+}
+export declare class Client extends Webhooks {
+    protected readonly _options: Webhooks.Options;
+    constructor(_options: Webhooks.Options);
+    /**
+     * Verify that the signature on the webhook message is from Webflow
+     * @link https://developers.webflow.com/data/docs/working-with-webhooks#validating-request-signatures
+     *
+     * @param {Webhooks.RequestSignatureDetails.headers} requestSignatureDetails - details of the incoming webhook request
+     * @example
+     *     function incomingWebhookRouteHandler(req, res) {
+     *       const headers = req.headers;
+     *       const body = JSON.stringify(req.body);
+     *       const secret = getWebhookSecret(WEBHOOK_ID);
+     *       const isAuthenticated = await client.webhooks.verifySignature({ headers, body, secret });
+     *
+     *       if (isAuthenticated) {
+     *           // Process the webhook
+     *       } else {
+     *           // Alert the user that the webhook is not authenticated
+     *       }
+     *       res.sendStatus(200);
+     *     }
+     *
+     */
+    verifySignature({ headers, body, secret }: Webhooks.RequestSignatureDetails): Promise<boolean>;
+}

package/wrapper/WebhooksClient.js

@@ -0,0 +1,66 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Client = void 0;
+const Client_1 = require("../api/resources/webhooks/client/Client");
+const crypto_1 = __importDefault(require("crypto"));
+class Client extends Client_1.Webhooks {
+    constructor(_options) {
+        super(_options);
+        this._options = _options;
+    }
+    /**
+     * Verify that the signature on the webhook message is from Webflow
+     * @link https://developers.webflow.com/data/docs/working-with-webhooks#validating-request-signatures
+     *
+     * @param {Webhooks.RequestSignatureDetails.headers} requestSignatureDetails - details of the incoming webhook request
+     * @example
+     *     function incomingWebhookRouteHandler(req, res) {
+     *       const headers = req.headers;
+     *       const body = JSON.stringify(req.body);
+     *       const secret = getWebhookSecret(WEBHOOK_ID);
+     *       const isAuthenticated = await client.webhooks.verifySignature({ headers, body, secret });
+     *
+     *       if (isAuthenticated) {
+     *           // Process the webhook
+     *       } else {
+     *           // Alert the user that the webhook is not authenticated
+     *       }
+     *       res.sendStatus(200);
+     *     }
+     *
+     */
+    verifySignature({ headers, body, secret }) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // Creates a HMAC signature following directions from https://developers.webflow.com/data/docs/working-with-webhooks#steps-to-validate-the-request-signature
+            const createHmac = (signingSecret, message) => __awaiter(this, void 0, void 0, function* () {
+                const encoder = new TextEncoder();
+                // Encode the signingSecret key
+                // @ts-expect-error TS2339: Property 'subtle' does not exist on type 'typeof import("crypto")'.
+                const key = yield crypto_1.default.subtle.importKey("raw", encoder.encode(signingSecret), { name: "HMAC", hash: "SHA-256" }, false, ["sign"]);
+                // Encode the message and compute HMAC signature
+                // @ts-expect-error TS2339: Property 'subtle' does not exist on type 'typeof import("crypto")'.
+                const signature = yield crypto_1.default.subtle.sign("HMAC", key, encoder.encode(message));
+                // Convert signature to hex string
+                return Array.from(new Uint8Array(signature))
+                    .map((b) => b.toString(16).padStart(2, "0"))
+                    .join("");
+            });
+            const message = `${headers["x-webflow-timestamp"]}:${body}`;
+            const generatedSignature = yield createHmac(secret, message);
+            return headers["x-webflow-signature"] === generatedSignature;
+        });
+    }
+}
+exports.Client = Client;

package/api/resources/collections/resources/fields/types/index.d.ts

@@ -1 +0,0 @@
-export * from "./FieldCreateType";

package/dist/api/resources/collections/resources/fields/types/index.d.ts

@@ -1 +0,0 @@
-export * from "./FieldCreateType";

package/dist/api/resources/collections/resources/fields/types/index.js

@@ -1,17 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-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 });
-__exportStar(require("./FieldCreateType"), exports);

package/dist/serialization/resources/collections/resources/fields/client/requests/FieldCreate.d.ts

@@ -1,16 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../../../../../../index";
-import * as Webflow from "../../../../../../../api/index";
-import * as core from "../../../../../../../core";
-import { FieldCreateType } from "../../types/FieldCreateType";
-export declare const FieldCreate: core.serialization.Schema<serializers.collections.FieldCreate.Raw, Webflow.collections.FieldCreate>;
-export declare namespace FieldCreate {
-    interface Raw {
-        isRequired?: boolean | null;
-        type: FieldCreateType.Raw;
-        displayName: string;
-        helpText?: string | null;
-    }
-}

package/dist/serialization/resources/collections/resources/fields/types/FieldCreateType.d.ts

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../../../../../index";
-import * as Webflow from "../../../../../../api/index";
-import * as core from "../../../../../../core";
-export declare const FieldCreateType: core.serialization.Schema<serializers.collections.FieldCreateType.Raw, Webflow.collections.FieldCreateType>;
-export declare namespace FieldCreateType {
-    type Raw = "Color" | "DateTime" | "Email" | "ExtFileRef" | "File" | "Image" | "Link" | "MultiImage" | "Number" | "Phone" | "PlainText" | "RichText" | "Switch" | "Video";
-}

package/dist/serialization/resources/collections/resources/fields/types/index.d.ts

@@ -1 +0,0 @@
-export * from "./FieldCreateType";

package/serialization/resources/collections/resources/fields/client/requests/FieldCreate.d.ts

@@ -1,16 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../../../../../../index";
-import * as Webflow from "../../../../../../../api/index";
-import * as core from "../../../../../../../core";
-import { FieldCreateType } from "../../types/FieldCreateType";
-export declare const FieldCreate: core.serialization.Schema<serializers.collections.FieldCreate.Raw, Webflow.collections.FieldCreate>;
-export declare namespace FieldCreate {
-    interface Raw {
-        isRequired?: boolean | null;
-        type: FieldCreateType.Raw;
-        displayName: string;
-        helpText?: string | null;
-    }
-}

package/serialization/resources/collections/resources/fields/types/FieldCreateType.d.ts

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../../../../../index";
-import * as Webflow from "../../../../../../api/index";
-import * as core from "../../../../../../core";
-export declare const FieldCreateType: core.serialization.Schema<serializers.collections.FieldCreateType.Raw, Webflow.collections.FieldCreateType>;
-export declare namespace FieldCreateType {
-    type Raw = "Color" | "DateTime" | "Email" | "ExtFileRef" | "File" | "Image" | "Link" | "MultiImage" | "Number" | "Phone" | "PlainText" | "RichText" | "Switch" | "Video";
-}

package/serialization/resources/collections/resources/fields/types/index.d.ts

@@ -1 +0,0 @@
-export * from "./FieldCreateType";

package/serialization/resources/collections/resources/fields/types/index.js

@@ -1,17 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-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 });
-__exportStar(require("./FieldCreateType"), exports);