webflow-api 2.0.0-beta → 2.0.0

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

@@ -58,7 +58,7 @@ class Scripts {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.sites.scripts.getCustomCode("site-id")
+     *     await webflow.sites.scripts.getCustomCode("string")
      */
     getCustomCode(siteId, requestOptions) {
         var _a;
@@ -128,7 +128,16 @@ class Scripts {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.sites.scripts.upsertCustomCode("site-id", {})
+     *     await webflow.sites.scripts.upsertCustomCode("string", {
+     *         scripts: [{
+     *                 id: "cms_slider",
+     *                 location: Webflow.ScriptApplyLocation.Header,
+     *                 version: "1.0.0",
+     *                 attributes: {
+     *                     "my-attribute": "some-value"
+     *                 }
+     *             }]
+     *     })
      */
     upsertCustomCode(siteId, request, requestOptions) {
         var _a;
@@ -199,7 +208,7 @@ class Scripts {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.sites.scripts.deleteCustomCode("site-id")
+     *     await webflow.sites.scripts.deleteCustomCode("string")
      */
     deleteCustomCode(siteId, requestOptions) {
         var _a;
@@ -263,7 +272,7 @@ class Scripts {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.sites.scripts.listCustomCodeBlocks("site-id", {})
+     *     await webflow.sites.scripts.listCustomCodeBlocks("string", {})
      */
     listCustomCodeBlocks(siteId, request = {}, requestOptions) {
         var _a;

package/dist/api/resources/users/client/Client.d.ts

@@ -27,7 +27,7 @@ export declare class Users {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.users.list("site-id", {
+     *     await webflow.users.list("string", {
      *         sort: Webflow.UsersListRequestSort.CreatedOnAscending
      *     })
      */
@@ -42,7 +42,7 @@ export declare class Users {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.users.get("site-id", "user-id")
+     *     await webflow.users.get("string", "string")
      */
     get(siteId: string, userId: string, requestOptions?: Users.RequestOptions): Promise<Webflow.User>;
     /**
@@ -55,7 +55,7 @@ export declare class Users {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.users.delete("site-id", "user-id")
+     *     await webflow.users.delete("string", "string")
      */
     delete(siteId: string, userId: string, requestOptions?: Users.RequestOptions): Promise<void>;
     /**
@@ -70,7 +70,7 @@ export declare class Users {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.users.update("site-id", "user-id", {
+     *     await webflow.users.update("string", "string", {
      *         id: "6287ec36a841b25637c663df",
      *         lastUpdated: new Date("2016-10-24T19:41:29.156Z"),
      *         invitedOn: new Date("2016-10-24T19:41:29.156Z"),
@@ -79,7 +79,10 @@ export declare class Users {
      *         status: Webflow.UserStatus.Invited,
      *         accessGroups: [{
      *                 type: Webflow.UserAccessGroupsItemType.Admin
-     *             }]
+     *             }],
+     *         data: {
+     *             data: {}
+     *         }
      *     })
      */
     update(siteId: string, userId: string, request: Webflow.User, requestOptions?: Users.RequestOptions): Promise<Webflow.User>;
@@ -94,7 +97,7 @@ export declare class Users {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.users.invite("site-id", {
+     *     await webflow.users.invite("string", {
      *         email: "some.one@home.com"
      *     })
      */

package/dist/api/resources/users/client/Client.js

@@ -59,7 +59,7 @@ class Users {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.users.list("site-id", {
+     *     await webflow.users.list("string", {
      *         sort: Webflow.UsersListRequestSort.CreatedOnAscending
      *     })
      */
@@ -146,7 +146,7 @@ class Users {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.users.get("site-id", "user-id")
+     *     await webflow.users.get("string", "string")
      */
     get(siteId, userId, requestOptions) {
         var _a;
@@ -219,7 +219,7 @@ class Users {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.users.delete("site-id", "user-id")
+     *     await webflow.users.delete("string", "string")
      */
     delete(siteId, userId, requestOptions) {
         var _a;
@@ -288,7 +288,7 @@ class Users {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.users.update("site-id", "user-id", {
+     *     await webflow.users.update("string", "string", {
      *         id: "6287ec36a841b25637c663df",
      *         lastUpdated: new Date("2016-10-24T19:41:29.156Z"),
      *         invitedOn: new Date("2016-10-24T19:41:29.156Z"),
@@ -297,7 +297,10 @@ class Users {
      *         status: Webflow.UserStatus.Invited,
      *         accessGroups: [{
      *                 type: Webflow.UserAccessGroupsItemType.Admin
-     *             }]
+     *             }],
+     *         data: {
+     *             data: {}
+     *         }
      *     })
      */
     update(siteId, userId, request, requestOptions) {
@@ -373,7 +376,7 @@ class Users {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.users.invite("site-id", {
+     *     await webflow.users.invite("string", {
      *         email: "some.one@home.com"
      *     })
      */

package/dist/api/resources/webhooks/client/Client.d.ts

@@ -26,7 +26,7 @@ export declare class Webhooks {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.webhooks.list("site-id")
+     *     await webflow.webhooks.list("string")
      */
     list(siteId: string, requestOptions?: Webhooks.RequestOptions): Promise<Webflow.Webhook[]>;
     /**
@@ -38,7 +38,7 @@ export declare class Webhooks {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.webhooks.create("site-id", {
+     *     await webflow.webhooks.create("string", {
      *         triggerType: Webflow.TriggerType.FormSubmission,
      *         url: "https://api.mydomain.com/webhook"
      *     })
@@ -53,7 +53,7 @@ export declare class Webhooks {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.webhooks.get("webhook-id")
+     *     await webflow.webhooks.get("string")
      */
     get(webhookId: string, requestOptions?: Webhooks.RequestOptions): Promise<Webflow.Webhook>;
     /**
@@ -65,7 +65,7 @@ export declare class Webhooks {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.webhooks.delete("webhook-id")
+     *     await webflow.webhooks.delete("string")
      */
     delete(webhookId: string, requestOptions?: Webhooks.RequestOptions): Promise<void>;
     protected _getAuthorizationHeader(): Promise<string>;

package/dist/api/resources/webhooks/client/Client.js

@@ -58,7 +58,7 @@ class Webhooks {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.webhooks.list("site-id")
+     *     await webflow.webhooks.list("string")
      */
     list(siteId, requestOptions) {
         var _a;
@@ -128,7 +128,7 @@ class Webhooks {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.webhooks.create("site-id", {
+     *     await webflow.webhooks.create("string", {
      *         triggerType: Webflow.TriggerType.FormSubmission,
      *         url: "https://api.mydomain.com/webhook"
      *     })
@@ -202,7 +202,7 @@ class Webhooks {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.webhooks.get("webhook-id")
+     *     await webflow.webhooks.get("string")
      */
     get(webhookId, requestOptions) {
         var _a;
@@ -272,7 +272,7 @@ class Webhooks {
      * @throws {@link Webflow.InternalServerError}
      *
      * @example
-     *     await webflow.webhooks.delete("webhook-id")
+     *     await webflow.webhooks.delete("string")
      */
     delete(webhookId, requestOptions) {
         var _a;

package/dist/core/fetcher/Fetcher.js

@@ -15,9 +15,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetcher = void 0;
 const form_data_1 = __importDefault(require("form-data"));
 const qs_1 = __importDefault(require("qs"));
-if (typeof window === "undefined") {
-    global.fetch = require("node-fetch");
-}
 const INITIAL_RETRY_DELAY = 1;
 const MAX_RETRY_DELAY = 60;
 const DEFAULT_MAX_RETRIES = 2;
@@ -46,18 +43,19 @@ function fetcherImpl(args) {
         else {
             body = JSON.stringify(args.body);
         }
+        const fetchFn = typeof fetch == "function" ? fetch : require("node-fetch");
         const makeRequest = () => __awaiter(this, void 0, void 0, function* () {
             const controller = new AbortController();
             let abortId = undefined;
             if (args.timeoutMs != null) {
                 abortId = setTimeout(() => controller.abort(), args.timeoutMs);
             }
-            const response = yield fetch(url, {
+            const response = yield fetchFn(url, {
                 method: args.method,
                 headers,
                 body,
                 signal: controller.signal,
-                credentials: args.withCredentials ? "same-origin" : undefined,
+                credentials: args.withCredentials ? "include" : undefined,
             });
             if (abortId != null) {
                 clearTimeout(abortId);
@@ -86,19 +84,22 @@ function fetcherImpl(args) {
             else if (response.body != null && args.responseType === "streaming") {
                 body = response.body;
             }
-            else if (response.body != null) {
-                try {
-                    body = yield response.json();
-                }
-                catch (err) {
-                    return {
-                        ok: false,
-                        error: {
-                            reason: "non-json",
-                            statusCode: response.status,
-                            rawBody: yield response.text(),
-                        },
-                    };
+            else {
+                const text = yield response.text();
+                if (text.length > 0) {
+                    try {
+                        body = JSON.parse(text);
+                    }
+                    catch (err) {
+                        return {
+                            ok: false,
+                            error: {
+                                reason: "non-json",
+                                statusCode: response.status,
+                                rawBody: text,
+                            },
+                        };
+                    }
                 }
             }
             if (response.status >= 200 && response.status < 400) {

package/dist/environments.d.ts

@@ -2,6 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export declare const WebflowEnvironment: {
-    readonly Default: "https://api.webflow.com/v2";
+    readonly Default: "https://api.webflow.com";
 };
 export declare type WebflowEnvironment = typeof WebflowEnvironment.Default;

package/dist/environments.js

@@ -5,5 +5,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebflowEnvironment = void 0;
 exports.WebflowEnvironment = {
-    Default: "https://api.webflow.com/v2",
+    Default: "https://api.webflow.com",
 };

package/environments.d.ts

@@ -2,6 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export declare const WebflowEnvironment: {
-    readonly Default: "https://api.webflow.com/v2";
+    readonly Default: "https://api.webflow.com";
 };
 export declare type WebflowEnvironment = typeof WebflowEnvironment.Default;

package/environments.js

@@ -5,5 +5,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebflowEnvironment = void 0;
 exports.WebflowEnvironment = {
-    Default: "https://api.webflow.com/v2",
+    Default: "https://api.webflow.com",
 };

package/package.json

@@ -1,8 +1,6 @@
 {
     "name": "webflow-api",
-    "description": "Webflow's official Node.js SDK for Data APIs",
-    "license": "MIT",
-    "version": "2.0.0-beta",
+    "version": "2.0.0",
     "private": false,
     "repository": "https://github.com/webflow/js-webflow-api",
     "main": "./index.js",
@@ -27,4 +25,4 @@
         "prettier": "2.7.1",
         "typescript": "4.6.4"
     }
-}
+}

package/dist/oauth.d.ts

@@ -1,27 +0,0 @@
-import { OauthScope } from "./api/types";
-/**
- * @param clientId The OAuth client ID
- * @param state The state
- * @param redirectUri The redirect URI
- * @param scope The OAuth scopes
- * @returns the URL to authorize a user
- */
-export declare function authorizeURL({ clientId, state, redirectUri, scope, }: {
-    clientId: string;
-    state?: string;
-    redirectUri?: string;
-    scope: OauthScope | OauthScope[];
-}): string;
-/**
- * @param clientId The OAuth client ID
- * @param clientSecret The OAuth client secret
- * @param code The OAuth code
- * @param redirect_uri The redirect uri
- * @returns access token that can be used to hit our API
- */
-export declare function getAccessToken({ clientId, clientSecret, code, redirectUri, }: {
-    clientId: string;
-    clientSecret: string;
-    code: string;
-    redirectUri?: string;
-}): Promise<string>;

package/dist/oauth.js

@@ -1,113 +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 __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;
-};
-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.getAccessToken = exports.authorizeURL = void 0;
-const core = __importStar(require("./core"));
-const errors = __importStar(require("./errors"));
-const qs_1 = __importDefault(require("qs"));
-/**
- * @param clientId The OAuth client ID
- * @param state The state
- * @param redirectUri The redirect URI
- * @param scope The OAuth scopes
- * @returns the URL to authorize a user
- */
-function authorizeURL({ clientId, state, redirectUri, scope, }) {
-    const params = { response_type: "code", client_id: clientId };
-    if (redirectUri != null) {
-        params["redirect_uri"] = redirectUri;
-    }
-    if (state != null) {
-        params["state"] = state;
-    }
-    if (typeof scope === "string") {
-        params["scope"] = scope;
-    }
-    else {
-        params["scope"] = scope.join("+");
-    }
-    return `https://webflow.com/oauth/authorize?${qs_1.default.stringify(params)}`;
-}
-exports.authorizeURL = authorizeURL;
-/**
- * @param clientId The OAuth client ID
- * @param clientSecret The OAuth client secret
- * @param code The OAuth code
- * @param redirect_uri The redirect uri
- * @returns access token that can be used to hit our API
- */
-function getAccessToken({ clientId, clientSecret, code, redirectUri, }) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const body = {
-            client_id: clientId,
-            client_secret: clientSecret,
-            code,
-            grant_type: "authorization_code",
-        };
-        if (redirectUri != null) {
-            body["redirect_uri"] = redirectUri;
-        }
-        const response = yield core.fetcher({
-            url: "https://api.webflow.com/oauth/access_token",
-            method: "POST",
-            contentType: "application/json",
-            body,
-        });
-        if (response.ok) {
-            return response["access_token"];
-        }
-        switch (response.error.reason) {
-            case "status-code":
-                throw new errors.WebflowError({
-                    statusCode: response.error.statusCode,
-                    body: response.error.body,
-                });
-            case "non-json":
-                throw new errors.WebflowError({
-                    statusCode: response.error.statusCode,
-                    body: response.error.rawBody,
-                });
-            case "timeout":
-                throw new errors.WebflowTimeoutError();
-            case "unknown":
-                throw new errors.WebflowError({
-                    message: response.error.errorMessage,
-                });
-        }
-    });
-}
-exports.getAccessToken = getAccessToken;

package/oauth.d.ts

@@ -1,27 +0,0 @@
-import { OauthScope } from "./api/types";
-/**
- * @param clientId The OAuth client ID
- * @param state The state
- * @param redirectUri The redirect URI
- * @param scope The OAuth scopes
- * @returns the URL to authorize a user
- */
-export declare function authorizeURL({ clientId, state, redirectUri, scope, }: {
-    clientId: string;
-    state?: string;
-    redirectUri?: string;
-    scope: OauthScope | OauthScope[];
-}): string;
-/**
- * @param clientId The OAuth client ID
- * @param clientSecret The OAuth client secret
- * @param code The OAuth code
- * @param redirect_uri The redirect uri
- * @returns access token that can be used to hit our API
- */
-export declare function getAccessToken({ clientId, clientSecret, code, redirectUri, }: {
-    clientId: string;
-    clientSecret: string;
-    code: string;
-    redirectUri?: string;
-}): Promise<string>;

package/oauth.js

@@ -1,113 +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 __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;
-};
-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.getAccessToken = exports.authorizeURL = void 0;
-const core = __importStar(require("./core"));
-const errors = __importStar(require("./errors"));
-const qs_1 = __importDefault(require("qs"));
-/**
- * @param clientId The OAuth client ID
- * @param state The state
- * @param redirectUri The redirect URI
- * @param scope The OAuth scopes
- * @returns the URL to authorize a user
- */
-function authorizeURL({ clientId, state, redirectUri, scope, }) {
-    const params = { response_type: "code", client_id: clientId };
-    if (redirectUri != null) {
-        params["redirect_uri"] = redirectUri;
-    }
-    if (state != null) {
-        params["state"] = state;
-    }
-    if (typeof scope === "string") {
-        params["scope"] = scope;
-    }
-    else {
-        params["scope"] = scope.join("+");
-    }
-    return `https://webflow.com/oauth/authorize?${qs_1.default.stringify(params)}`;
-}
-exports.authorizeURL = authorizeURL;
-/**
- * @param clientId The OAuth client ID
- * @param clientSecret The OAuth client secret
- * @param code The OAuth code
- * @param redirect_uri The redirect uri
- * @returns access token that can be used to hit our API
- */
-function getAccessToken({ clientId, clientSecret, code, redirectUri, }) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const body = {
-            client_id: clientId,
-            client_secret: clientSecret,
-            code,
-            grant_type: "authorization_code",
-        };
-        if (redirectUri != null) {
-            body["redirect_uri"] = redirectUri;
-        }
-        const response = yield core.fetcher({
-            url: "https://api.webflow.com/oauth/access_token",
-            method: "POST",
-            contentType: "application/json",
-            body,
-        });
-        if (response.ok) {
-            return response["access_token"];
-        }
-        switch (response.error.reason) {
-            case "status-code":
-                throw new errors.WebflowError({
-                    statusCode: response.error.statusCode,
-                    body: response.error.body,
-                });
-            case "non-json":
-                throw new errors.WebflowError({
-                    statusCode: response.error.statusCode,
-                    body: response.error.rawBody,
-                });
-            case "timeout":
-                throw new errors.WebflowTimeoutError();
-            case "unknown":
-                throw new errors.WebflowError({
-                    message: response.error.errorMessage,
-                });
-        }
-    });
-}
-exports.getAccessToken = getAccessToken;