webflow-api 1.1.2 → 1.2.1

package/dist/api/user.d.ts

@@ -0,0 +1,143 @@
+import { AxiosInstance } from "axios";
+import { PaginatedData, WebflowRecord } from "../core";
+/**************************************************************
+ * Interfaces
+ **************************************************************/
+export interface IUser {
+    emailVerified: boolean;
+    lastUpdated?: string;
+    createdOn: string;
+    _id: string;
+    data: any;
+}
+export interface IAcessGroup {
+    _id: string;
+    name: string;
+    shortId: string;
+    slug: string;
+    createdOn: string;
+}
+export interface IUserDelete {
+    deleted: number;
+}
+/**************************************************************
+ * Types
+ **************************************************************/
+export declare type PaginatedUsers = PaginatedData & {
+    users: IUser[];
+};
+export declare type PaginatedAccessGroups = PaginatedData & {
+    accessGroups: IAcessGroup[];
+};
+export declare type UserIdParam = {
+    siteId: string;
+    userId: string;
+};
+/**************************************************************
+ * Class
+ **************************************************************/
+export declare class User extends WebflowRecord<IUser> implements IUser {
+    emailVerified: boolean;
+    lastUpdated?: string;
+    createdOn: string;
+    siteId: string;
+    _id: string;
+    data: any;
+    /**************************************************************
+     * Static Methods
+     **************************************************************/
+    /**
+     * Get a list of Users
+     * @param params The params for the request
+     * @param params.siteId The site ID
+     * @param params.limit The number of items to return (optional)
+     * @param params.offset The number of items to skip (optional)
+     * @param client The Axios client instance
+     * @returns A list of Users
+     */
+    static list({ siteId, limit, offset }: {
+        siteId: string;
+        limit?: number;
+        offset?: number;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<PaginatedUsers, any>>;
+    /**
+     * Get a single User
+     * @param params The params for the request
+     * @param params.siteId The site ID
+     * @param params.userId The user ID
+     * @param client The Axios client instance
+     * @returns A single User
+     */
+    static getOne({ siteId, userId }: {
+        siteId: string;
+        userId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IUser, any>>;
+    /**
+     * Update a User
+     * @param params The params for the request
+     * @param params.siteId The site ID
+     * @param params.userId The user ID
+     * @param params.data The data to update
+     * @param client The Axios client instance
+     * @returns The updated User
+     */
+    static update({ siteId, userId, data, }: {
+        data: object;
+        siteId: string;
+        userId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IUser, any>>;
+    /**
+     * Invite a User to a site
+     * @param params The params for the request
+     * @param params.siteId The site ID
+     * @param params.email The email address of the user to invite
+     * @param client The Axios client instance
+     * @returns The newly created User
+     */
+    static invite({ siteId, email }: {
+        siteId: string;
+        email: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IUser, any>>;
+    /**
+     * Remove a User
+     * @param params The params for the request
+     * @param params.siteId The site ID
+     * @param params.userId The user ID
+     * @param client The Axios client instance
+     * @returns The result of the remove
+     */
+    static remove({ siteId, userId }: {
+        siteId: string;
+        userId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IUserDelete, any>>;
+    /**
+     * Get a list of User Access Groups
+     * @param params The params for the request
+     * @param params.siteId The site ID
+     * @param params.limit The number of items to return (optional)
+     * @param params.offset The number of items to skip (optional)
+     * @param params.sort The sort order of the groups (optional)
+     * @param client The Axios client instance
+     * @returns A list of Access Groups
+     */
+    static accessGroups({ siteId, limit, offset, sort, }: {
+        siteId: string;
+        limit?: number;
+        offset?: number;
+        sort?: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<PaginatedAccessGroups, any>>;
+    /**************************************************************
+     * Instance Methods
+     **************************************************************/
+    /**
+     * Update a User
+     * @param data The data to update
+     * @returns The updated User
+     */
+    update(data: any): Promise<User>;
+    /**
+     * Remove a User
+     * @returns The result of the remove
+     */
+    remove(): Promise<IUserDelete>;
+}

package/dist/api/user.js

@@ -0,0 +1,119 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.User = void 0;
+const core_1 = require("../core");
+/**************************************************************
+ * Class
+ **************************************************************/
+class User extends core_1.WebflowRecord {
+    /**************************************************************
+     * Static Methods
+     **************************************************************/
+    /**
+     * Get a list of Users
+     * @param params The params for the request
+     * @param params.siteId The site ID
+     * @param params.limit The number of items to return (optional)
+     * @param params.offset The number of items to skip (optional)
+     * @param client The Axios client instance
+     * @returns A list of Users
+     */
+    static list({ siteId, limit, offset }, client) {
+        (0, core_1.requireArgs)({ siteId });
+        const params = { limit, offset };
+        const path = `/sites/${siteId}/users`;
+        return client.get(path, { params });
+    }
+    /**
+     * Get a single User
+     * @param params The params for the request
+     * @param params.siteId The site ID
+     * @param params.userId The user ID
+     * @param client The Axios client instance
+     * @returns A single User
+     */
+    static getOne({ siteId, userId }, client) {
+        (0, core_1.requireArgs)({ siteId, userId });
+        const path = `/sites/${siteId}/users/${userId}`;
+        return client.get(path);
+    }
+    /**
+     * Update a User
+     * @param params The params for the request
+     * @param params.siteId The site ID
+     * @param params.userId The user ID
+     * @param params.data The data to update
+     * @param client The Axios client instance
+     * @returns The updated User
+     */
+    static update({ siteId, userId, data, }, client) {
+        (0, core_1.requireArgs)({ siteId, userId });
+        const path = `/sites/${siteId}/users/${userId}`;
+        return client.patch(path, data);
+    }
+    /**
+     * Invite a User to a site
+     * @param params The params for the request
+     * @param params.siteId The site ID
+     * @param params.email The email address of the user to invite
+     * @param client The Axios client instance
+     * @returns The newly created User
+     */
+    static async invite({ siteId, email }, client) {
+        (0, core_1.requireArgs)({ siteId, email });
+        const path = `/sites/${siteId}/users/invite`;
+        return client.post(path, { email });
+    }
+    /**
+     * Remove a User
+     * @param params The params for the request
+     * @param params.siteId The site ID
+     * @param params.userId The user ID
+     * @param client The Axios client instance
+     * @returns The result of the remove
+     */
+    static remove({ siteId, userId }, client) {
+        (0, core_1.requireArgs)({ siteId, userId });
+        const path = `/sites/${siteId}/users/${userId}`;
+        return client.delete(path);
+    }
+    /**
+     * Get a list of User Access Groups
+     * @param params The params for the request
+     * @param params.siteId The site ID
+     * @param params.limit The number of items to return (optional)
+     * @param params.offset The number of items to skip (optional)
+     * @param params.sort The sort order of the groups (optional)
+     * @param client The Axios client instance
+     * @returns A list of Access Groups
+     */
+    static accessGroups({ siteId, limit, offset, sort, }, client) {
+        (0, core_1.requireArgs)({ siteId });
+        const params = { limit, offset, sort };
+        const path = `/sites/${siteId}/accessgroups`;
+        return client.get(path, { params });
+    }
+    /**************************************************************
+     * Instance Methods
+     **************************************************************/
+    /**
+     * Update a User
+     * @param data The data to update
+     * @returns The updated User
+     */
+    async update(data) {
+        const params = { siteId: this.siteId, userId: this._id, data };
+        const res = await User.update(params, this.client);
+        return new User(this.client, res);
+    }
+    /**
+     * Remove a User
+     * @returns The result of the remove
+     */
+    async remove() {
+        const params = { siteId: this.siteId, userId: this._id };
+        const res = await User.remove(params, this.client);
+        return res.data;
+    }
+}
+exports.User = User;

package/dist/api/webhook.d.ts

@@ -1,9 +1,10 @@
-import { Client, QueryString } from "../core";
+import { AxiosInstance } from "axios";
+import { WebflowRecord } from "../core";
 /**************************************************************
  * Types
  **************************************************************/
 export declare type TriggerType = "form_submission" | "site_publish" | "ecomm_new_order" | "ecomm_order_changed" | "ecomm_inventory_changed" | "collection_item_created" | "collection_item_changed" | "collection_item_deleted" | string;
-export declare type Filter = {
+export declare type WebhookFilter = {
     name: string;
 };
 /**************************************************************
@@ -24,57 +25,78 @@ export interface IRemoveResult {
     deleted: number;
 }
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
-/**
- * Get a list of Webhooks
- * @param client The Webflow client
- * @param params1 The params for the request
- * @param params1.siteId The site ID
- * @param params The query string parameters (optional)
- * @returns A list of Webhooks
- */
-export declare function list(client: Client, { siteId }: {
-    siteId: string;
-}, params?: QueryString): Promise<import("axios").AxiosResponse<IWebhook[], any>>;
-/**
- * Get a single Webhook
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.siteId The site ID
- * @param params.webhookId The webhook ID
- * @returns A single Webhook
- */
-export declare function getOne(client: Client, { siteId, webhookId }: {
-    siteId: string;
-    webhookId: string;
-}): Promise<import("axios").AxiosResponse<IWebhook, any>>;
-/**
- * Create a new Webhook
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.siteId The site ID
- * @param params.url The URL to send the webhook to
- * @param params.triggerType The event to trigger the webhook
- * @param params.filter The filter to apply to the webhook (optional: form_submission only)
- * @param params.params The query string parameters (optional)
- * @returns The created webhook
- */
-export declare function create(client: Client, { triggerType, siteId, filter, url, }: {
-    url: string;
-    siteId: string;
-    filter?: Filter;
-    triggerType: TriggerType;
-}): Promise<import("axios").AxiosResponse<IWebhook, any>>;
-/**
- * Remove a Webhook
- * @param client The Webflow client
- * @param params The query string parameters (optional)
- * @param params.webhookId The Webhook ID
- * @param params.siteId The Site ID
- * @returns The result of the removal
- */
-export declare function remove(client: Client, { siteId, webhookId }: {
-    siteId: string;
-    webhookId: string;
-}): Promise<import("axios").AxiosResponse<IRemoveResult, any>>;
+export declare class Webhook extends WebflowRecord<IWebhook> implements IWebhook {
+    filter?: {
+        name: string;
+    };
+    triggerType: string;
+    triggerId: string;
+    createdOn: string;
+    lastUsed?: string;
+    site: string;
+    _id: string;
+    /**************************************************************
+     * Static Methods
+     **************************************************************/
+    /**
+     * Get a list of Webhooks
+     * @param params The params for the request
+     * @param params.siteId The site ID
+     * @param client The Axios client instance
+     * @returns A list of Webhooks
+     */
+    static list({ siteId }: {
+        siteId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IWebhook[], any>>;
+    /**
+     * Get a single Webhook
+     * @param params The params for the request
+     * @param params.siteId The site ID
+     * @param params.webhookId The webhook ID
+     * @param client The Axios client instance
+     * @returns A single Webhook
+     */
+    static getOne({ siteId, webhookId }: {
+        siteId: string;
+        webhookId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IWebhook, any>>;
+    /**
+     * Create a new Webhook
+     * @param params The params for the request
+     * @param params.siteId The site ID
+     * @param params.url The URL to send the webhook to
+     * @param params.triggerType The event to trigger the webhook
+     * @param params.filter The filter to apply to the webhook (optional: form_submission only)
+     * @param params.params The query string parameters (optional)
+     * @param client The Axios client instance
+     * @returns The created webhook
+     */
+    static create({ triggerType, siteId, filter, url, }: {
+        url: string;
+        siteId: string;
+        filter?: WebhookFilter;
+        triggerType: TriggerType;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IWebhook, any>>;
+    /**
+     * Remove a Webhook
+     * @param params The query string parameters (optional)
+     * @param params.webhookId The Webhook ID
+     * @param params.siteId The Site ID
+     * @param client The Axios client instance
+     * @returns The result of the removal
+     */
+    static remove({ siteId, webhookId }: {
+        siteId: string;
+        webhookId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IRemoveResult, any>>;
+    /**************************************************************
+     * Instance Methods
+     **************************************************************/
+    /**
+     * Remove a Webhook
+     * @returns The result of the removal
+     */
+    remove(): Promise<IRemoveResult>;
+}

package/dist/api/webhook.js

@@ -1,67 +1,80 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.remove = exports.create = exports.getOne = exports.list = void 0;
+exports.Webhook = void 0;
 const core_1 = require("../core");
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
-/**
- * Get a list of Webhooks
- * @param client The Webflow client
- * @param params1 The params for the request
- * @param params1.siteId The site ID
- * @param params The query string parameters (optional)
- * @returns A list of Webhooks
- */
-function list(client, { siteId }, params) {
-    (0, core_1.requireArgs)({ siteId });
-    const path = `/sites/${siteId}/webhooks`;
-    return client.get(path, { params });
+class Webhook extends core_1.WebflowRecord {
+    /**************************************************************
+     * Static Methods
+     **************************************************************/
+    /**
+     * Get a list of Webhooks
+     * @param params The params for the request
+     * @param params.siteId The site ID
+     * @param client The Axios client instance
+     * @returns A list of Webhooks
+     */
+    static list({ siteId }, client) {
+        (0, core_1.requireArgs)({ siteId });
+        const path = `/sites/${siteId}/webhooks`;
+        return client.get(path);
+    }
+    /**
+     * Get a single Webhook
+     * @param params The params for the request
+     * @param params.siteId The site ID
+     * @param params.webhookId The webhook ID
+     * @param client The Axios client instance
+     * @returns A single Webhook
+     */
+    static getOne({ siteId, webhookId }, client) {
+        (0, core_1.requireArgs)({ siteId, webhookId });
+        const path = `/sites/${siteId}/webhooks/${webhookId}`;
+        return client.get(path);
+    }
+    /**
+     * Create a new Webhook
+     * @param params The params for the request
+     * @param params.siteId The site ID
+     * @param params.url The URL to send the webhook to
+     * @param params.triggerType The event to trigger the webhook
+     * @param params.filter The filter to apply to the webhook (optional: form_submission only)
+     * @param params.params The query string parameters (optional)
+     * @param client The Axios client instance
+     * @returns The created webhook
+     */
+    static create({ triggerType, siteId, filter, url, }, client) {
+        (0, core_1.requireArgs)({ siteId, triggerType, url });
+        const path = `/sites/${siteId}/webhooks`;
+        const data = { triggerType, url, filter };
+        return client.post(path, data);
+    }
+    /**
+     * Remove a Webhook
+     * @param params The query string parameters (optional)
+     * @param params.webhookId The Webhook ID
+     * @param params.siteId The Site ID
+     * @param client The Axios client instance
+     * @returns The result of the removal
+     */
+    static remove({ siteId, webhookId }, client) {
+        (0, core_1.requireArgs)({ siteId, webhookId });
+        const path = `/sites/${siteId}/webhooks/${webhookId}`;
+        return client.delete(path);
+    }
+    /**************************************************************
+     * Instance Methods
+     **************************************************************/
+    /**
+     * Remove a Webhook
+     * @returns The result of the removal
+     */
+    async remove() {
+        const params = { siteId: this.site, webhookId: this._id };
+        const res = await Webhook.remove(params, this.client);
+        return res.data;
+    }
 }
-exports.list = list;
-/**
- * Get a single Webhook
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.siteId The site ID
- * @param params.webhookId The webhook ID
- * @returns A single Webhook
- */
-function getOne(client, { siteId, webhookId }) {
-    (0, core_1.requireArgs)({ siteId, webhookId });
-    const path = `/sites/${siteId}/webhooks/${webhookId}`;
-    return client.get(path);
-}
-exports.getOne = getOne;
-/**
- * Create a new Webhook
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.siteId The site ID
- * @param params.url The URL to send the webhook to
- * @param params.triggerType The event to trigger the webhook
- * @param params.filter The filter to apply to the webhook (optional: form_submission only)
- * @param params.params The query string parameters (optional)
- * @returns The created webhook
- */
-function create(client, { triggerType, siteId, filter, url, }) {
-    (0, core_1.requireArgs)({ siteId, triggerType, url });
-    const path = `/sites/${siteId}/webhooks`;
-    const data = { triggerType, url, filter };
-    return client.post(path, data);
-}
-exports.create = create;
-/**
- * Remove a Webhook
- * @param client The Webflow client
- * @param params The query string parameters (optional)
- * @param params.webhookId The Webhook ID
- * @param params.siteId The Site ID
- * @returns The result of the removal
- */
-function remove(client, { siteId, webhookId }) {
-    (0, core_1.requireArgs)({ siteId, webhookId });
-    const path = `/sites/${siteId}/webhooks/${webhookId}`;
-    return client.delete(path);
-}
-exports.remove = remove;
+exports.Webhook = Webhook;

package/dist/core/error.d.ts

@@ -1,3 +1,4 @@
+import { AxiosResponse } from "axios";
 export interface IRequestError {
     msg: string;
     code: number;
@@ -17,3 +18,4 @@ export declare class ArgumentError extends Error {
     constructor(name: string);
 }
 export declare function requireArgs(args: object): void;
+export declare function ErrorInterceptor(res: AxiosResponse<IRequestError>): AxiosResponse<IRequestError, any>;

package/dist/core/error.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.requireArgs = exports.ArgumentError = exports.RequestError = void 0;
+exports.ErrorInterceptor = exports.requireArgs = exports.ArgumentError = exports.RequestError = void 0;
 class RequestError extends Error {
     constructor(error) {
         super(error.err ? error.err : "Unknown error occured");
@@ -21,3 +21,10 @@ function requireArgs(args) {
     }
 }
 exports.requireArgs = requireArgs;
+// throw an error if Webflow error
+function ErrorInterceptor(res) {
+    if (res.data.err)
+        throw new RequestError(res.data);
+    return res;
+}
+exports.ErrorInterceptor = ErrorInterceptor;

package/dist/core/index.d.ts

@@ -1,3 +1,3 @@
-export * from "./client";
 export * from "./error";
-export * from "./options";
+export * from "./response";
+export * from "./webflow";

package/dist/core/index.js

@@ -14,6 +14,6 @@ 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("./client"), exports);
 __exportStar(require("./error"), exports);
-__exportStar(require("./options"), exports);
+__exportStar(require("./response"), exports);
+__exportStar(require("./webflow"), exports);

package/dist/core/response.d.ts

@@ -0,0 +1,32 @@
+import { AxiosInstance, AxiosResponse } from "axios";
+/**************************************************************
+ * Types
+ **************************************************************/
+export declare type PaginationFilter = {
+    limit?: number;
+    offset?: number;
+};
+export declare type WebflowHeaders = Record<string, any>;
+/**************************************************************
+ * Interfaces
+ ************************************************************* */
+export interface PaginatedData {
+    count: number;
+    limit: number;
+    offset: number;
+    total: number;
+}
+export declare class MetaResponse<T> {
+    response: AxiosResponse<T>;
+    rateLimit: {
+        limit: number;
+        remaining: number;
+    };
+    constructor(response: AxiosResponse<T>);
+}
+export declare class WebflowRecord<T> {
+    response: AxiosResponse<T>;
+    _meta: MetaResponse<T>;
+    client: AxiosInstance;
+    constructor(client: AxiosInstance, response: AxiosResponse<any>, record?: T, ...args: any[]);
+}

package/dist/core/response.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebflowRecord = exports.MetaResponse = void 0;
+class MetaResponse {
+    constructor(response) {
+        this.response = response;
+        this.rateLimit = {
+            limit: parseInt(response.headers["x-ratelimit-limit"], 10),
+            remaining: parseInt(response.headers["x-ratelimit-remaining"], 10),
+        };
+    }
+}
+exports.MetaResponse = MetaResponse;
+class WebflowRecord {
+    constructor(client, response, record, ...args) {
+        Object.assign(this, record || response.data, ...args); // Copy the record data
+        // dynamically add client and response to object
+        // without serializing during toString()
+        Object.defineProperties(this, {
+            client: { get: () => client },
+            response: { get: () => response },
+            _meta: { get: () => new MetaResponse(response) }, // legacy support
+        });
+    }
+}
+exports.WebflowRecord = WebflowRecord;