webflow-api 1.3.0 → 1.3.1

package/dist/api/webhook.d.ts

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

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

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

@@ -0,0 +1,30 @@
+"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 occurred");
+        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

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

package/dist/core/index.js

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

@@ -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;