webflow-api 1.1.2 → 1.2.0

package/dist/wrapper/item.js

@@ -1,153 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ItemWrapper = void 0;
-const _1 = require(".");
-const api_1 = require("../api");
-class ItemWrapper {
-    constructor(client, item) {
-        this.client = client;
-        Object.assign(this, item);
-    }
-    /**************************************************************
-     * Static Methods
-     **************************************************************/
-    /**
-     * Create a new Item
-     * @param client The Webflow client
-     * @param params The params for the request
-     * @param params.collectionId The Collection ID
-     * @param params.fields The Item fields to create
-     * @returns The created Item
-     */
-    static async create(client, { collectionId, fields }) {
-        const res = await api_1.Item.create(client, { collectionId, fields });
-        const item = new ItemWrapper(client, res.data);
-        return (0, _1.ResponseWrapper)(res, item);
-    }
-    /**
-     * Get a single Item
-     * @param client The Webflow client
-     * @param params The params for the request
-     * @param params.collectionId The Collection ID
-     * @param params.itemId The Item ID
-     * @returns A single Item
-     */
-    static async getOne(client, itemParams) {
-        const res = await api_1.Item.getOne(client, itemParams);
-        const item = new ItemWrapper(client, res.data.items[0]);
-        return (0, _1.ResponseWrapper)(res, item);
-    }
-    /**
-     * Get a list of Items
-     * @param client The Webflow client
-     * @param params The params for the request
-     * @param params.collectionId The Collection 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 Items
-     */
-    static async list(client, { collectionId, limit, offset }) {
-        const res = await api_1.Item.list(client, { collectionId, limit, offset });
-        const items = res.data.items.map((i) => new ItemWrapper(client, i));
-        return (0, _1.ResponseWrapper)(res, items);
-    }
-    /**
-     * Remove a single Item
-     * @param client The Webflow client
-     * @param params The params for the request
-     * @param params.collectionId The Collection ID
-     * @param params.itemId The Item ID
-     * @returns The result from the removal
-     */
-    static async remove(client, { collectionId, itemId }) {
-        const res = await api_1.Item.remove(client, { collectionId, itemId });
-        return (0, _1.ResponseWrapper)(res);
-    }
-    /**
-     * Publishes a list of Items
-     * @param client The Webflow client
-     * @param params The request parameters
-     * @param params.collectionId The Collection ID
-     * @param params.itemIds The list of Item IDs to publish
-     * @param params.live Publish to live site
-     * @returns The result of the publish
-     */
-    static async publish(client, { collectionId, itemIds, live, }) {
-        const res = await api_1.Item.publish(client, { collectionId, itemIds, live });
-        return (0, _1.ResponseWrapper)(res);
-    }
-    /**
-     * Unpublishes a list of Items
-     * @param client The Webflow client
-     * @param params The params for the request
-     * @param params.collectionId The Collection ID
-     * @param params.live Unpublish from the live site
-     * @returns The result of the unpublish
-     */
-    static async unpublish(client, { collectionId, itemIds, live, }) {
-        const res = await api_1.Item.unpublish(client, { collectionId, itemIds, live });
-        return (0, _1.ResponseWrapper)(res);
-    }
-    /**
-     * Update a single Item
-     * @param client The Webflow client
-     * @param params The params for the request
-     * @param params.collectionId The Collection ID
-     * @param params.itemId The Item ID
-     * @param params.fields The fields to update
-     * @returns The updated Item
-     */
-    static async update(client, { collectionId, itemId, fields, }) {
-        const res = await api_1.Item.update(client, {
-            collectionId,
-            fields,
-            itemId,
-        });
-        const item = new ItemWrapper(client, res.data);
-        return (0, _1.ResponseWrapper)(res, item);
-    }
-    /**
-     * Patch a single Item
-     * @param client The Webflow client
-     * @param params The params for the request
-     * @param params.collectionId The Collection ID
-     * @param params.itemId The Item ID
-     * @param params.fields The fields to patch
-     * @returns The patched Item
-     */
-    static async patch(client, { collectionId, itemId, fields, }, params) {
-        const res = await api_1.Item.patch(client, {
-            collectionId,
-            fields,
-            itemId,
-        });
-        const item = new ItemWrapper(client, res.data);
-        return (0, _1.ResponseWrapper)(res, item);
-    }
-    /**************************************************************
-     * Instance Methods
-     **************************************************************/
-    /**
-     * Update a single Item
-     * @param fields The fields to update
-     * @returns The updated Item
-     */
-    update({ ...fields }) {
-        return ItemWrapper.update(this.client, {
-            collectionId: this._cid,
-            itemId: this._id,
-            fields,
-        });
-    }
-    /**
-     * Remove a single Item
-     * @returns The result from the removal
-     */
-    remove() {
-        return ItemWrapper.remove(this.client, {
-            collectionId: this._cid,
-            itemId: this._id,
-        });
-    }
-}
-exports.ItemWrapper = ItemWrapper;

package/dist/wrapper/membership.js

@@ -1,123 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MembershipWrapper = void 0;
-const _1 = require(".");
-const api_1 = require("../api");
-class MembershipWrapper {
-    constructor(client, siteId, membership) {
-        this.client = client;
-        this.siteId = siteId;
-        Object.assign(this, membership);
-    }
-    /**************************************************************
-     * Static Methods
-     **************************************************************/
-    /**
-     * Get a single 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
-     * @returns A single User
-     */
-    static async getOne(client, { userId, siteId }) {
-        const res = await api_1.Membership.getOne(client, { userId, siteId });
-        const user = (0, _1.ResponseWrapper)(res);
-        return new MembershipWrapper(client, siteId, user);
-    }
-    /**
-     * Get a list of Users
-     * @param client The Webflow client
-     * @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
-     */
-    static async list(client, { siteId, limit, offset }) {
-        const res = await api_1.Membership.list(client, { siteId, limit, offset });
-        const users = res.data.users.map((u) => new MembershipWrapper(client, siteId, u));
-        return (0, _1.ResponseWrapper)(res, users);
-    }
-    /**
-     * 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
-     * @returns The updated User
-     */
-    static async update(client, { userId, siteId, data }) {
-        const res = await api_1.Membership.update(client, { userId, siteId, ...data });
-        const user = (0, _1.ResponseWrapper)(res);
-        return new MembershipWrapper(client, siteId, user);
-    }
-    /**
-     * 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
-     * @returns The newly created User
-     */
-    static async invite(client, { siteId, email }) {
-        const res = await api_1.Membership.invite(client, { siteId, email });
-        return (0, _1.ResponseWrapper)(res);
-    }
-    /**
-     * Get a list of Access Groups
-     * @param client The Webflow client
-     * @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 Access Groups
-     */
-    static async accessGroups(client, { siteId, limit, offset, }) {
-        const res = await api_1.Membership.accessGroups(client, {
-            siteId,
-            limit,
-            offset,
-        });
-        return (0, _1.ResponseWrapper)(res);
-    }
-    /**
-     * 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
-     * @returns The result of the remove
-     */
-    static async remove(client, { siteId, userId }) {
-        const res = await api_1.Membership.remove(client, { userId, siteId });
-        return (0, _1.ResponseWrapper)(res);
-    }
-    /**************************************************************
-     * Instance Methods
-     **************************************************************/
-    /**
-     * Update a User
-     * @param data The data to update
-     * @returns The updated User
-     */
-    async update(data) {
-        return MembershipWrapper.update(this.client, {
-            siteId: this.siteId,
-            userId: this._id,
-            data,
-        });
-    }
-    /**
-     * Remove a User
-     * @returns The result of the remove
-     */
-    async remove() {
-        return MembershipWrapper.remove(this.client, {
-            siteId: this.siteId,
-            userId: this._id,
-        });
-    }
-}
-exports.MembershipWrapper = MembershipWrapper;

package/dist/wrapper/response.d.ts

@@ -1,16 +0,0 @@
-import { AxiosResponse } from "axios";
-export declare type MetaResponse<T> = T & {
-    _meta: {
-        rateLimit: {
-            limit: number;
-            remaining: number;
-        };
-    };
-};
-/**
- * Wraps an HTTP response with Webflow Rate Limiting information
- * @param response The HTTP response
- * @param data The data to use (defaults to response.data)
- * @returns The response with Webflow Rate Limiting information
- */
-export declare function ResponseWrapper<T>(response: AxiosResponse, data?: T): MetaResponse<T>;

package/dist/wrapper/response.js

@@ -1,17 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ResponseWrapper = void 0;
-/**
- * Wraps an HTTP response with Webflow Rate Limiting information
- * @param response The HTTP response
- * @param data The data to use (defaults to response.data)
- * @returns The response with Webflow Rate Limiting information
- */
-function ResponseWrapper(response, data) {
-    const limit = parseInt(response.headers["x-ratelimit-limit"], 10);
-    const remaining = parseInt(response.headers["x-ratelimit-remaining"], 10);
-    const result = data || response.data;
-    result._meta = { rateLimit: { limit, remaining } };
-    return result;
-}
-exports.ResponseWrapper = ResponseWrapper;

package/dist/wrapper/site.d.ts

@@ -1,168 +0,0 @@
-import { CreateWebhookParams, CollectionWrapper, WebhookWrapper, MembershipWrapper } from ".";
-import { Client, QueryString } from "../core";
-import { Site } from "../api";
-export declare class SiteWrapper implements Site.ISite {
-    private client;
-    lastPublished: string;
-    previewUrl: string;
-    createdOn: string;
-    shortName: string;
-    timezone: string;
-    database: string;
-    name: string;
-    _id: string;
-    constructor(client: Client, site: Site.ISite);
-    /**************************************************************
-     * Static Methods
-     **************************************************************/
-    /**
-     * Get a single Site
-     * @param client The Webflow client
-     * @param params The Site information
-     * @param params.siteId The Site ID
-     * @returns The Site
-     */
-    static getOne(client: Client, { siteId }: {
-        siteId: string;
-    }): Promise<import("./response").MetaResponse<SiteWrapper>>;
-    /**
-     * Get a list of Sites available
-     * @param client The Webflow client
-     * @param params The query parameters (optional)
-     * @returns A list of Sites
-     */
-    static list(client: Client, params?: QueryString): Promise<import("./response").MetaResponse<SiteWrapper[]>>;
-    /**
-     * Get a list of Domains for a Site
-     * @param client The Webflow client
-     * @param params The Site information
-     * @param params.siteId The Site ID
-     * @returns A list of Domains
-     */
-    static domains(client: Client, { siteId }: {
-        siteId: string;
-    }): Promise<import("./response").MetaResponse<Site.IDomain[]>>;
-    /**
-     * Publish a Site
-     * @param client The Webflow client
-     * @param params The Site information
-     * @param params.siteId The Site ID
-     * @param params.domain The domains to publish
-     * @returns The result of the publish
-     */
-    static publish(client: Client, { siteId, domains }: {
-        siteId: string;
-        domains: string[];
-    }): Promise<import("./response").MetaResponse<Site.IPublishSite>>;
-    /**************************************************************
-     * Instance Methods
-     **************************************************************/
-    /**
-     * Get a list of domains for a site
-     * @returns A list of domains
-     */
-    domains(): Promise<import("./response").MetaResponse<Site.IDomain[]>>;
-    /**
-     * Publish a site
-     * @param domains The domains to publish to
-     * @returns The publish result
-     */
-    publishSite(domains: string[]): Promise<import("./response").MetaResponse<Site.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<import("./response").MetaResponse<CollectionWrapper>>;
-    /**
-     * Get a list of Collections
-     * @returns A list of Collections
-     */
-    collections(): Promise<import("./response").MetaResponse<CollectionWrapper[]>>;
-    /**
-     * 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<import("./response").MetaResponse<WebhookWrapper>>;
-    /**
-     * Get a list of Webhooks
-     * @param params The query string parameters (optional)
-     * @returns A list of Webhooks
-     */
-    webhooks(params?: QueryString): Promise<import("./response").MetaResponse<WebhookWrapper[]>>;
-    /**
-     * 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("./response").MetaResponse<import("../api/webhook").IRemoveResult>>;
-    /**
-     * Create a new Webhook
-     * @param params1 The params for the request
-     * @param params1.url The URL to send the webhook to
-     * @param params1.triggerType The event to trigger the webhook
-     * @param params1.filter The filter to apply to the webhook (optional: form_submission only)
-     * @param params The query string parameters (optional)
-     * @returns The created webhook
-     */
-    createWebhook({ triggerType, filter, url }: CreateWebhookParams): Promise<import("./response").MetaResponse<WebhookWrapper>>;
-    /**
-     * Get a list of Users
-     * @param params The params for the request
-     * @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
-     */
-    users({ limit, offset }?: {
-        limit?: number;
-        offset?: number;
-    }): Promise<import("./response").MetaResponse<MembershipWrapper[]>>;
-    /**
-     * Get a single User
-     * @param params The params for the request
-     * @param params.userId The user ID
-     * @returns A single User
-     */
-    user({ userId }: {
-        userId: string;
-    }): Promise<MembershipWrapper>;
-    /**
-     * Invite a User to a site
-     * @param params The params for the request
-     * @param params.email The email address of the user to invite
-     * @returns The newly created User
-     */
-    inviteUser({ email }: {
-        email: string;
-    }): Promise<import("./response").MetaResponse<import("../api/membership").IUser>>;
-    /**
-     * Get a list of Access Groups
-     * @param params The params for the request
-     * @param params.limit The number of items to return (optional)
-     * @param params.offset The number of items to skip (optional)
-     * @returns A list of Access Groups
-     */
-    accessGroups({ limit, offset, }?: {
-        limit?: number;
-        offset?: number;
-    }): Promise<import("./response").MetaResponse<import("../api/membership").PaginatedAccessGroups>>;
-    /**
-     * Remove a User
-     * @param params The params for the request
-     * @param params.userId The user ID
-     * @returns The result of the remove
-     */
-    removeUser({ userId }: {
-        userId: string;
-    }): Promise<import("./response").MetaResponse<import("../api/membership").IUserDelete>>;
-}

package/dist/wrapper/site.js

@@ -1,191 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SiteWrapper = void 0;
-const _1 = require(".");
-const api_1 = require("../api");
-class SiteWrapper {
-    constructor(client, site) {
-        this.client = client;
-        Object.assign(this, site);
-    }
-    /**************************************************************
-     * Static Methods
-     **************************************************************/
-    /**
-     * Get a single Site
-     * @param client The Webflow client
-     * @param params The Site information
-     * @param params.siteId The Site ID
-     * @returns The Site
-     */
-    static async getOne(client, { siteId }) {
-        const res = await api_1.Site.getOne(client, { siteId });
-        const site = new SiteWrapper(client, res.data);
-        return (0, _1.ResponseWrapper)(res, site);
-    }
-    /**
-     * Get a list of Sites available
-     * @param client The Webflow client
-     * @param params The query parameters (optional)
-     * @returns A list of Sites
-     */
-    static async list(client, params) {
-        const res = await api_1.Site.list(client, params);
-        const sites = res.data.map((s) => new SiteWrapper(client, s));
-        return (0, _1.ResponseWrapper)(res, sites);
-    }
-    /**
-     * Get a list of Domains for a Site
-     * @param client The Webflow client
-     * @param params The Site information
-     * @param params.siteId The Site ID
-     * @returns A list of Domains
-     */
-    static async domains(client, { siteId }) {
-        const res = await api_1.Site.domains(client, { siteId });
-        return (0, _1.ResponseWrapper)(res, res.data);
-    }
-    /**
-     * Publish a Site
-     * @param client The Webflow client
-     * @param params The Site information
-     * @param params.siteId The Site ID
-     * @param params.domain The domains to publish
-     * @returns The result of the publish
-     */
-    static async publish(client, { siteId, domains }) {
-        const res = await api_1.Site.publish(client, { siteId, domains });
-        return (0, _1.ResponseWrapper)(res);
-    }
-    /**************************************************************
-     * Instance Methods
-     **************************************************************/
-    /**
-     * Get a list of domains for a site
-     * @returns A list of domains
-     */
-    async domains() {
-        const res = await api_1.Site.domains(this.client, { siteId: this._id });
-        return (0, _1.ResponseWrapper)(res);
-    }
-    /**
-     * Publish a site
-     * @param domains The domains to publish to
-     * @returns The publish result
-     */
-    async publishSite(domains) {
-        const res = await api_1.Site.publish(this.client, { siteId: this._id, domains });
-        return (0, _1.ResponseWrapper)(res);
-    }
-    /**
-     * Get a single Collection
-     * @param params The params for the request
-     * @param params.collectionId The collection ID
-     * @returns A single Collection
-     */
-    async collection({ collectionId }) {
-        return _1.CollectionWrapper.getOne(this.client, { collectionId });
-    }
-    /**
-     * Get a list of Collections
-     * @returns A list of Collections
-     */
-    async collections() {
-        return _1.CollectionWrapper.list(this.client, { siteId: this._id });
-    }
-    /**
-     * Get a single Webhook
-     * @param params The params for the request
-     * @param params.webhookId The webhook ID
-     * @returns A single Webhook
-     */
-    async webhook({ webhookId }) {
-        return _1.WebhookWrapper.getOne(this.client, { siteId: this._id, webhookId });
-    }
-    /**
-     * Get a list of Webhooks
-     * @param params The query string parameters (optional)
-     * @returns A list of Webhooks
-     */
-    async webhooks(params) {
-        return _1.WebhookWrapper.list(this.client, { siteId: this._id }, params);
-    }
-    /**
-     * 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 }) {
-        return _1.WebhookWrapper.remove(this.client, { siteId: this._id, webhookId });
-    }
-    /**
-     * Create a new Webhook
-     * @param params1 The params for the request
-     * @param params1.url The URL to send the webhook to
-     * @param params1.triggerType The event to trigger the webhook
-     * @param params1.filter The filter to apply to the webhook (optional: form_submission only)
-     * @param params The query string parameters (optional)
-     * @returns The created webhook
-     */
-    async createWebhook({ triggerType, filter, url }) {
-        const _params = { url, siteId: this._id, triggerType, filter };
-        return _1.WebhookWrapper.create(this.client, _params);
-    }
-    /**
-     * Get a list of Users
-     * @param params The params for the request
-     * @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
-     */
-    async users({ limit, offset } = {}) {
-        return _1.MembershipWrapper.list(this.client, {
-            siteId: this._id,
-            limit,
-            offset,
-        });
-    }
-    /**
-     * Get a single User
-     * @param params The params for the request
-     * @param params.userId The user ID
-     * @returns A single User
-     */
-    async user({ userId }) {
-        return _1.MembershipWrapper.getOne(this.client, { siteId: this._id, userId });
-    }
-    /**
-     * Invite a User to a site
-     * @param params The params for the request
-     * @param params.email The email address of the user to invite
-     * @returns The newly created User
-     */
-    async inviteUser({ email }) {
-        return _1.MembershipWrapper.invite(this.client, { siteId: this._id, email });
-    }
-    /**
-     * Get a list of Access Groups
-     * @param params The params for the request
-     * @param params.limit The number of items to return (optional)
-     * @param params.offset The number of items to skip (optional)
-     * @returns A list of Access Groups
-     */
-    async accessGroups({ limit, offset, } = {}) {
-        return _1.MembershipWrapper.accessGroups(this.client, {
-            siteId: this._id,
-            limit,
-            offset,
-        });
-    }
-    /**
-     * Remove a User
-     * @param params The params for the request
-     * @param params.userId The user ID
-     * @returns The result of the remove
-     */
-    async removeUser({ userId }) {
-        return _1.MembershipWrapper.remove(this.client, { siteId: this._id, userId });
-    }
-}
-exports.SiteWrapper = SiteWrapper;