webflow-api 1.2.1 → 1.3.0

package/dist/api/site.js

@@ -1,137 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Site = void 0;
-const _1 = require(".");
-const core_1 = require("../core");
-/**************************************************************
- * Class
- **************************************************************/
-class Site extends core_1.WebflowRecord {
-    /**
-     * Get a list of Sites
-     * @param client The Axios client instance
-     * @returns a list of Sites
-     */
-    static list(client) {
-        const path = "/sites";
-        return client.get(path);
-    }
-    /**
-     * Get a single Site
-     * @param params The params for the request
-     * @param params.siteId The site ID
-     * @param params.params The query string parameters (optional)
-     * @param client The Axios client instance
-     * @returns A single Site
-     */
-    static getOne({ siteId }, client) {
-        (0, core_1.requireArgs)({ siteId });
-        const path = `/sites/${siteId}`;
-        return client.get(path);
-    }
-    /**
-     * Publish a site
-     * @param params The params for the request
-     * @param params.siteId The site ID
-     * @param params.domains The domains to publish to
-     * @param client The Axios client instance
-     * @returns The publish result
-     */
-    static publish({ siteId, domains }, client) {
-        (0, core_1.requireArgs)({ siteId, domains });
-        const path = `/sites/${siteId}/publish`;
-        return client.post(path, { domains });
-    }
-    /**
-     * Get a list of domains for a site
-     * @param params The params for the request
-     * @param params.siteId The site ID
-     * @param client The Axios client instance
-     * @returns A list of domains
-     */
-    static domains({ siteId }, client) {
-        (0, core_1.requireArgs)({ siteId });
-        const path = `/sites/${siteId}/domains`;
-        return client.get(path);
-    }
-    /**************************************************************
-     * Instance Methods
-     **************************************************************/
-    /**
-     * Get a list of domains for a site
-     * @returns A list of domains
-     */
-    async domains() {
-        const res = await Site.domains({ siteId: this._id }, this.client);
-        return res.data;
-    }
-    /**
-     * Publish a site
-     * @param domains The domains to publish to
-     * @returns The publish result
-     */
-    async publishSite(domains) {
-        const res = await Site.publish({ siteId: this._id, domains }, this.client);
-        return res.data;
-    }
-    /**
-     * Get a single Collection
-     * @param params The params for the request
-     * @param params.collectionId The collection ID
-     * @returns A single Collection
-     */
-    async collection({ collectionId }) {
-        const res = await _1.Collection.getOne({ collectionId }, this.client);
-        return new _1.Collection(this.client, res);
-    }
-    /**
-     * Get a list of Collections
-     * @returns A list of Collections
-     */
-    async collections() {
-        const res = await _1.Collection.list({ siteId: this._id }, this.client);
-        return res.data.map((data) => new _1.Collection(this.client, { ...res, data }));
-    }
-    /**
-     * Get a single Webhook
-     * @param params The params for the request
-     * @param params.webhookId The webhook ID
-     * @returns A single Webhook
-     */
-    async webhook({ webhookId }) {
-        const res = await _1.Webhook.getOne({ siteId: this._id, webhookId }, this.client);
-        return new _1.Webhook(this.client, res);
-    }
-    /**
-     * Get a list of Webhooks
-     * @returns A list of Webhooks
-     */
-    async webhooks() {
-        const res = await _1.Webhook.list({ siteId: this._id }, this.client);
-        return res.data.map((data) => new _1.Webhook(this.client, { ...res, data }));
-    }
-    /**
-     * Remove a Webhook
-     * @param params The query string parameters (optional)
-     * @param params.webhookId The Webhook ID
-     * @returns The result of the removal
-     */
-    async removeWebhook({ webhookId }) {
-        const res = await _1.Webhook.remove({ siteId: this._id, webhookId }, this.client);
-        return res.data;
-    }
-    /**
-     * Create a new Webhook
-     * @param params The params for the request
-     * @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)
-     * @returns The created webhook
-     */
-    async createWebhook({ triggerType, filter, url, }) {
-        const _params = { url, siteId: this._id, triggerType, filter };
-        const res = await _1.Webhook.create(_params, this.client);
-        return new _1.Webhook(this.client, res);
-    }
-}
-exports.Site = Site;

package/dist/api/user.d.ts

@@ -1,143 +0,0 @@
-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

@@ -1,119 +0,0 @@
-"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,102 +0,0 @@
-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 WebhookFilter = {
-    name: string;
-};
-/**************************************************************
- * Interfaces
- **************************************************************/
-export interface IWebhook {
-    triggerType: TriggerType;
-    triggerId: string;
-    createdOn: string;
-    lastUsed?: string;
-    site: string;
-    _id: string;
-    filter?: {
-        name: string;
-    };
-}
-export interface IRemoveResult {
-    deleted: number;
-}
-/**************************************************************
- * Class
- **************************************************************/
-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,80 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Webhook = void 0;
-const core_1 = require("../core");
-/**************************************************************
- * Class
- **************************************************************/
-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.Webhook = Webhook;

package/dist/core/error.d.ts

@@ -1,21 +0,0 @@
-import { AxiosResponse } from "axios";
-export interface IRequestError {
-    msg: string;
-    code: number;
-    name: string;
-    path: string;
-    err: string;
-}
-export declare class RequestError extends Error implements IRequestError {
-    msg: string;
-    code: number;
-    name: string;
-    path: string;
-    err: string;
-    constructor(error: IRequestError);
-}
-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,30 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ErrorInterceptor = exports.requireArgs = exports.ArgumentError = exports.RequestError = void 0;
-class RequestError extends Error {
-    constructor(error) {
-        super(error.err ? error.err : "Unknown error occured");
-        Object.assign(this, error);
-    }
-}
-exports.RequestError = RequestError;
-class ArgumentError extends Error {
-    constructor(name) {
-        super(`Argument '${name}' is required but was not present`);
-    }
-}
-exports.ArgumentError = ArgumentError;
-function requireArgs(args) {
-    for (const key in args) {
-        if (!args[key])
-            throw new ArgumentError(key);
-    }
-}
-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 +0,0 @@
-export * from "./error";
-export * from "./response";
-export * from "./webflow";

package/dist/core/index.js

@@ -1,19 +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("./error"), exports);
-__exportStar(require("./response"), exports);
-__exportStar(require("./webflow"), exports);

package/dist/core/response.d.ts

@@ -1,32 +0,0 @@
-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[]);
-}