webflow-api 1.1.1 → 1.2.0

package/dist/api/site.d.ts

@@ -1,4 +1,6 @@
-import { Client, QueryString } from "../core";
+import { AxiosInstance } from "axios";
+import { Webhook, Collection, WebhookFilter } from ".";
+import { WebflowRecord } from "../core";
 /**************************************************************
  * Interfaces
  *************************************************************/
@@ -20,46 +22,119 @@ export interface IPublishSite {
     queued: boolean;
 }
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
-/**
- * Get a list of Sites
- * @param client The Webflow client
- * @param params The query string parameters (optional)
- * @returns
- */
-export declare function list(client: Client, params?: QueryString): Promise<import("axios").AxiosResponse<ISite[], any>>;
-/**
- * Get a single Site
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.siteId The site ID
- * @param params.params The query string parameters (optional)
- * @returns A single Site
- */
-export declare function getOne(client: Client, { siteId, params }: {
-    siteId: string;
-    params?: QueryString;
-}): Promise<import("axios").AxiosResponse<ISite, any>>;
-/**
- * Publish a site
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.siteId The site ID
- * @param params.domains The domains to publish to
- * @returns The publish result
- */
-export declare function publish(client: Client, { siteId, domains }: {
-    siteId: string;
-    domains: string[];
-}): Promise<import("axios").AxiosResponse<IPublishSite, any>>;
-/**
- * Get a list of domains for a site
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.siteId The site ID
- * @returns A list of domains
- */
-export declare function domains(client: Client, { siteId }: {
-    siteId: string;
-}): Promise<import("axios").AxiosResponse<IDomain[], any>>;
+export declare class Site extends WebflowRecord<ISite> implements ISite {
+    lastPublished: string;
+    previewUrl: string;
+    createdOn: string;
+    shortName: string;
+    timezone: string;
+    database: string;
+    name: string;
+    _id: string;
+    /**
+     * Get a list of Sites
+     * @param client The Axios client instance
+     * @returns a list of Sites
+     */
+    static list(client: AxiosInstance): Promise<import("axios").AxiosResponse<ISite[], any>>;
+    /**
+     * 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 }: {
+        siteId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<ISite, any>>;
+    /**
+     * 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 }: {
+        siteId: string;
+        domains: string[];
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IPublishSite, any>>;
+    /**
+     * 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 }: {
+        siteId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IDomain[], any>>;
+    /**************************************************************
+     * Instance Methods
+     **************************************************************/
+    /**
+     * Get a list of domains for a site
+     * @returns A list of domains
+     */
+    domains(): Promise<IDomain[]>;
+    /**
+     * Publish a site
+     * @param domains The domains to publish to
+     * @returns The publish result
+     */
+    publishSite(domains: string[]): Promise<IPublishSite>;
+    /**
+     * Get a single Collection
+     * @param params The params for the request
+     * @param params.collectionId The collection ID
+     * @returns A single Collection
+     */
+    collection({ collectionId }: {
+        collectionId: string;
+    }): Promise<Collection>;
+    /**
+     * Get a list of Collections
+     * @returns A list of Collections
+     */
+    collections(): Promise<Collection[]>;
+    /**
+     * Get a single Webhook
+     * @param params The params for the request
+     * @param params.webhookId The webhook ID
+     * @returns A single Webhook
+     */
+    webhook({ webhookId }: {
+        webhookId: string;
+    }): Promise<Webhook>;
+    /**
+     * Get a list of Webhooks
+     * @returns A list of Webhooks
+     */
+    webhooks(): Promise<Webhook[]>;
+    /**
+     * Remove a Webhook
+     * @param params The query string parameters (optional)
+     * @param params.webhookId The Webhook ID
+     * @returns The result of the removal
+     */
+    removeWebhook({ webhookId }: {
+        webhookId: string;
+    }): Promise<import("./webhook").IRemoveResult>;
+    /**
+     * 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
+     */
+    createWebhook({ triggerType, filter, url, }: {
+        url: string;
+        siteId: string;
+        triggerType: string;
+        filter?: WebhookFilter;
+    }): Promise<Webhook>;
+}

package/dist/api/site.js

@@ -1,59 +1,137 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.domains = exports.publish = exports.getOne = exports.list = void 0;
+exports.Site = void 0;
+const _1 = require(".");
 const core_1 = require("../core");
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
-/**
- * Get a list of Sites
- * @param client The Webflow client
- * @param params The query string parameters (optional)
- * @returns
- */
-function list(client, params) {
-    const path = "/sites";
-    return client.get(path, { params });
+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.list = list;
-/**
- * Get a single Site
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.siteId The site ID
- * @param params.params The query string parameters (optional)
- * @returns A single Site
- */
-function getOne(client, { siteId, params }) {
-    (0, core_1.requireArgs)({ siteId });
-    const path = `/sites/${siteId}`;
-    return client.get(path, { params });
-}
-exports.getOne = getOne;
-/**
- * Publish a site
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.siteId The site ID
- * @param params.domains The domains to publish to
- * @returns The publish result
- */
-function publish(client, { siteId, domains }) {
-    (0, core_1.requireArgs)({ siteId, domains });
-    const path = `/sites/${siteId}/publish`;
-    return client.post(path, { domains });
-}
-exports.publish = publish;
-/**
- * Get a list of domains for a site
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.siteId The site ID
- * @returns A list of domains
- */
-function domains(client, { siteId }) {
-    (0, core_1.requireArgs)({ siteId });
-    const path = `/sites/${siteId}/domains`;
-    return client.get(path);
-}
-exports.domains = domains;
+exports.Site = Site;

package/dist/{wrapper/membership.d.ts → api/user.d.ts}

@@ -1,79 +1,105 @@
-import { Client, PaginationFilter } from "../core";
-import { Membership } from "../api";
-export declare class MembershipWrapper implements Membership.IUser {
-    private client;
-    private siteId;
+import { AxiosInstance } from "axios";
+import { PaginatedData, WebflowRecord } from "../core";
+/**************************************************************
+ * Interfaces
+ **************************************************************/
+export interface IUser {
     emailVerified: boolean;
     lastUpdated?: string;
     createdOn: string;
     _id: string;
     data: any;
-    constructor(client: Client, siteId: string, membership: Membership.IUser);
+}
+export interface IUserDelete {
+    deleted: number;
+}
+/**************************************************************
+ * Types
+ **************************************************************/
+export declare type PaginatedUsers = PaginatedData & {
+    users: IUser[];
+};
+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 single User
-     * @param client The Webflow client
+     * Get a list of Users
      * @param params The params for the request
      * @param params.siteId The site ID
-     * @param params.userId The user ID
-     * @returns A single User
+     * @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 getOne(client: Client, { userId, siteId }: {
+    static list({ siteId, limit, offset }: {
         siteId: string;
-        userId: string;
-    }): Promise<MembershipWrapper>;
+        limit?: number;
+        offset?: number;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<PaginatedUsers, any>>;
     /**
-     * Get a list of Users
-     * @param client The Webflow client
+     * Get a single User
      * @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)
-     * @returns A list of Users
+     * @param params.userId The user ID
+     * @param client The Axios client instance
+     * @returns A single User
      */
-    static list(client: Client, { siteId, limit, offset }: {
+    static getOne({ siteId, userId }: {
         siteId: string;
-    } & PaginationFilter): Promise<import("./response").MetaResponse<MembershipWrapper[]>>;
+        userId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IUser, any>>;
     /**
      * Update a User
-     * @param client The Webflow client
      * @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(client: Client, { userId, siteId, data }: {
-        userId: string;
+    static update({ siteId, userId, data, }: {
+        data: object;
         siteId: string;
-        data: any;
-    }): Promise<MembershipWrapper>;
+        userId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IUser, any>>;
     /**
      * Invite a User to a site
-     * @param client The Webflow client
      * @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(client: Client, { siteId, email }: {
+    static invite({ siteId, email }: {
         siteId: string;
         email: string;
-    }): Promise<import("./response").MetaResponse<Membership.IUser>>;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IUser, any>>;
     /**
      * Remove a User
-     * @param client The Webflow client
      * @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(client: Client, { siteId, userId }: {
+    static remove({ siteId, userId }: {
         siteId: string;
         userId: string;
-    }): Promise<import("./response").MetaResponse<Membership.IUserDelete>>;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IUserDelete, any>>;
     /**************************************************************
      * Instance Methods
      **************************************************************/
@@ -82,10 +108,10 @@ export declare class MembershipWrapper implements Membership.IUser {
      * @param data The data to update
      * @returns The updated User
      */
-    update(data: any): Promise<MembershipWrapper>;
+    update(data: any): Promise<User>;
     /**
      * Remove a User
      * @returns The result of the remove
      */
-    remove(): Promise<import("./response").MetaResponse<Membership.IUserDelete>>;
+    remove(): Promise<IUserDelete>;
 }

package/dist/api/user.js

@@ -0,0 +1,103 @@
+"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);
+    }
+    /**************************************************************
+     * 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;