webflow-api 1.1.1 → 1.2.0

package/dist/wrapper/membership.js

@@ -1,106 +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);
-    }
-    /**
-     * 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,119 +0,0 @@
-import { CreateWebhookParams, CollectionWrapper, WebhookWrapper } 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>>;
-}

package/dist/wrapper/site.js

@@ -1,136 +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);
-    }
-}
-exports.SiteWrapper = SiteWrapper;

package/dist/wrapper/webhook.d.ts

@@ -1,78 +0,0 @@
-import { Client, QueryString } from "../core";
-import { Webhook } from "../api";
-export declare type CreateWebhookParams = {
-    url: string;
-    siteId: string;
-    triggerType: string;
-    filter?: Webhook.Filter;
-};
-export declare class WebhookWrapper implements Webhook.IWebhook {
-    private client;
-    triggerType: Webhook.TriggerType;
-    triggerId: string;
-    createdOn: string;
-    lastUsed?: string;
-    site: string;
-    _id: string;
-    filter?: {
-        name: string;
-    };
-    constructor(client: Client, webhook: Webhook.IWebhook);
-    /**************************************************************
-     * Static Methods
-     **************************************************************/
-    /**
-     * Get a Webhook
-     * @param client The Webflow client
-     * @param params The Webhook params
-     * @param params.siteId The Site ID
-     * @param params.webhookId The Webhook ID
-     * @returns The Webhook
-     */
-    static getOne(client: Client, { siteId, webhookId }: {
-        siteId: string;
-        webhookId: string;
-    }): Promise<import("./response").MetaResponse<WebhookWrapper>>;
-    /**
-     * List Webhooks
-     * @param client The Webflow client
-     * @param param1 The Webhook params
-     * @param param1.siteId The Site ID
-     * @param params Query string params (optional)
-     * @returns A list of Webhooks
-     */
-    static list(client: Client, { siteId }: {
-        siteId: string;
-    }, params?: QueryString): Promise<import("./response").MetaResponse<WebhookWrapper[]>>;
-    /**
-     * Remove a Webhook
-     * @param client The Webflow client
-     * @param params The Webhook params
-     * @param params.siteId The Site ID
-     * @param params.webhookId The Webhook ID
-     * @returns The result of the removal
-     */
-    static remove(client: Client, { siteId, webhookId }: {
-        siteId: string;
-        webhookId: string;
-    }): Promise<import("./response").MetaResponse<Webhook.IRemoveResult>>;
-    /**
-     * Create a Webhook
-     * @param client The Webflow client
-     * @param param1 The Webhook params
-     * @param param1.siteId The Site ID
-     * @param param1.url The URL to send the Webhook to
-     * @param param1.triggerType The event to trigger the Webhook
-     * @param param1.filter The filter to use (optional: form_submission only)
-     * @returns The created Webhook
-     */
-    static create(client: Client, { triggerType, siteId, filter, url }: CreateWebhookParams): Promise<import("./response").MetaResponse<WebhookWrapper>>;
-    /**************************************************************
-     * Instance Methods
-     **************************************************************/
-    /**
-     * Remove a Webhook
-     * @returns The result of the removal
-     */
-    remove(): Promise<import("./response").MetaResponse<Webhook.IRemoveResult>>;
-}

package/dist/wrapper/webhook.js

@@ -1,82 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebhookWrapper = void 0;
-const _1 = require(".");
-const api_1 = require("../api");
-class WebhookWrapper {
-    constructor(client, webhook) {
-        this.client = client;
-        Object.assign(this, webhook);
-    }
-    /**************************************************************
-     * Static Methods
-     **************************************************************/
-    /**
-     * Get a Webhook
-     * @param client The Webflow client
-     * @param params The Webhook params
-     * @param params.siteId The Site ID
-     * @param params.webhookId The Webhook ID
-     * @returns The Webhook
-     */
-    static async getOne(client, { siteId, webhookId }) {
-        const res = await api_1.Webhook.getOne(client, { siteId, webhookId });
-        const webhook = new WebhookWrapper(client, res.data);
-        return (0, _1.ResponseWrapper)(res, webhook);
-    }
-    /**
-     * List Webhooks
-     * @param client The Webflow client
-     * @param param1 The Webhook params
-     * @param param1.siteId The Site ID
-     * @param params Query string params (optional)
-     * @returns A list of Webhooks
-     */
-    static async list(client, { siteId }, params) {
-        const res = await api_1.Webhook.list(client, { siteId }, params);
-        const webhooks = res.data.map((w) => new WebhookWrapper(client, w));
-        return (0, _1.ResponseWrapper)(res, webhooks);
-    }
-    /**
-     * Remove a Webhook
-     * @param client The Webflow client
-     * @param params The Webhook params
-     * @param params.siteId The Site ID
-     * @param params.webhookId The Webhook ID
-     * @returns The result of the removal
-     */
-    static async remove(client, { siteId, webhookId }) {
-        const res = await api_1.Webhook.remove(client, { siteId, webhookId });
-        return (0, _1.ResponseWrapper)(res);
-    }
-    /**
-     * Create a Webhook
-     * @param client The Webflow client
-     * @param param1 The Webhook params
-     * @param param1.siteId The Site ID
-     * @param param1.url The URL to send the Webhook to
-     * @param param1.triggerType The event to trigger the Webhook
-     * @param param1.filter The filter to use (optional: form_submission only)
-     * @returns The created Webhook
-     */
-    static async create(client, { triggerType, siteId, filter, url }) {
-        const args = { triggerType, siteId, filter, url };
-        const res = await api_1.Webhook.create(client, args);
-        const _webhook = new WebhookWrapper(client, res.data);
-        return (0, _1.ResponseWrapper)(res, _webhook);
-    }
-    /**************************************************************
-     * Instance Methods
-     **************************************************************/
-    /**
-     * Remove a Webhook
-     * @returns The result of the removal
-     */
-    async remove() {
-        return WebhookWrapper.remove(this.client, {
-            webhookId: this._id,
-            siteId: this.site,
-        });
-    }
-}
-exports.WebhookWrapper = WebhookWrapper;

package/src/api/membership.ts

@@ -1,125 +0,0 @@
-import { Client, PaginatedData, QueryString, requireArgs } from "../core";
-
-/**************************************************************
- * Interfaces
- **************************************************************/
-export interface IUser {
-  emailVerified: boolean;
-  lastUpdated?: string;
-  createdOn: string;
-  _id: string;
-  data: any;
-}
-
-export interface IUserDelete {
-  deleted: number;
-}
-
-/**************************************************************
- * Types
- **************************************************************/
-export type PaginatedUsers = PaginatedData & {
-  users: IUser[];
-};
-
-export type UserIdParam = { siteId: string; userId: string };
-
-/**************************************************************
- * Functions
- **************************************************************/
-
-/**
- * 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
- */
-export function list(
-  client: Client,
-  { siteId, limit, offset }: { siteId: string; limit?: number; offset?: number }
-) {
-  requireArgs({ siteId });
-  const params = { limit, offset };
-  const path = `/sites/${siteId}/users`;
-  return client.get<PaginatedUsers>(path, { params });
-}
-
-/**
- * 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
- */
-export function getOne(
-  client: Client,
-  { siteId, userId }: { siteId: string; userId: string }
-) {
-  requireArgs({ siteId, userId });
-  const path = `/sites/${siteId}/users/${userId}`;
-  return client.get<IUser>(path);
-}
-
-/**
- * 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
- */
-export function update(
-  client: Client,
-  {
-    siteId,
-    userId,
-    data,
-  }: {
-    data: object;
-    siteId: string;
-    userId: string;
-  }
-) {
-  requireArgs({ siteId, userId });
-  const path = `/sites/${siteId}/users/${userId}`;
-  return client.patch<IUser>(path, data);
-}
-
-/**
- * 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
- */
-export async function invite(
-  client: Client,
-  { siteId, email }: { siteId: string; email: string }
-) {
-  requireArgs({ siteId, email });
-  const path = `/sites/${siteId}/users/invite`;
-  return client.post<IUser>(path, { email });
-}
-
-/**
- * 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
- */
-export function remove(
-  client: Client,
-  { siteId, userId }: { siteId: string; userId: string }
-) {
-  requireArgs({ siteId, userId });
-  const path = `/sites/${siteId}/users/${userId}`;
-  return client.delete<IUserDelete>(path);
-}