webflow-api 1.1.2 → 1.2.0

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,155 +0,0 @@
-import { Client, PaginatedData, requireArgs } from "../core";
-
-/**************************************************************
- * Interfaces
- **************************************************************/
-export interface IUser {
-  emailVerified: boolean;
-  lastUpdated?: string;
-  createdOn: string;
-  _id: string;
-  data: any;
-}
-
-export interface IAccessGroup {
-  _id: string;
-  name: string;
-  shortId: string;
-  slug: string;
-  createdOn: string;
-}
-
-export interface IUserDelete {
-  deleted: number;
-}
-
-/**************************************************************
- * Types
- **************************************************************/
-export type PaginatedUsers = PaginatedData & {
-  users: IUser[];
-};
-
-export type PaginatedAccessGroups = PaginatedData & {
-  accessGroups: IAccessGroup[];
-};
-
-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
-  }: {
-    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);
-}
-
-/**
- * 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
- */
-export function accessGroups(
-  client: Client,
-  { siteId, limit, offset }: { siteId: string; limit?: number; offset?: number }
-) {
-  requireArgs({ siteId });
-  const params = { limit, offset };
-  const path = `/sites/${siteId}/users/accessgroups`;
-  return client.get<PaginatedAccessGroups>(path, { params });
-}

package/src/core/client.ts

@@ -1,82 +0,0 @@
-import { Axios } from "axios";
-import { DEFAULT_HOST, USER_AGENT, Options, RequestError } from "../core";
-
-/**************************************************************
- * Types
- **************************************************************/
-export type QueryString = Record<string, any>;
-export type PaginationFilter = { limit?: number; offset?: number };
-
-/**************************************************************
- * Interfaces
- ************************************************************* */
-export interface PaginatedData {
-  count: number;
-  limit: number;
-  offset: number;
-  total: number;
-}
-
-/**************************************************************
- * Functions
- **************************************************************/
-
-/**
- * Transforms JSON response to an object
- * if the response is a Webflow error, it will throw an error
- * @param data JSON response
- * @returns response object
- */
-function transformResponse(data: any = {}) {
-  // parse json if string
-  if (String(data) === data) data = JSON.parse(data);
-
-  // throw an error if Webflow returns an error obejct
-  if (data.err) throw new RequestError(data);
-  return data;
-}
-
-/**
- * Transforms POST/PUT/PATCH request data to JSON
- * @param data A JavaScript object
- * @returns JSON string
- */
-function transformRequest(data: any = {}) {
-  return JSON.stringify(data);
-}
-
-/**************************************************************
- * Classes
- **************************************************************/
-export class Client extends Axios {
-  constructor({
-    host = DEFAULT_HOST,
-    headers = {},
-    version,
-    token,
-  }: Options = {}) {
-    super({
-      transformRequest: [transformRequest],
-      transformResponse: [transformResponse],
-      baseURL: `https://api.${host}/`,
-      headers: {
-        "Content-Type": "application/json",
-        "User-Agent": USER_AGENT,
-        "Accept-Version": version,
-        ...headers,
-      },
-    });
-
-    if (token) this.token = token;
-  }
-
-  // set the Authorization header
-  set token(value: string) {
-    this.defaults.headers["Authorization"] = `Bearer ${value}`;
-  }
-
-  // clear the Authorization header
-  clearToken() {
-    delete this.defaults.headers["Authorization"];
-  }
-}

package/src/core/options.ts

@@ -1,9 +0,0 @@
-export const DEFAULT_HOST = "webflow.com";
-export const USER_AGENT = "Webflow Javascript SDK / 1.0";
-
-export interface Options {
-  host?: string;
-  token?: string;
-  version?: string;
-  headers?: Record<string, string>;
-}

package/src/wrapper/collection.ts

@@ -1,115 +0,0 @@
-import { ResponseWrapper, ItemWrapper } from ".";
-import { Client, QueryString } from "../core";
-import { Collection } from "../api";
-
-export class CollectionWrapper implements Collection.ICollection {
-  fields: Collection.CollectionField[];
-  singularName: string;
-  lastUpdated: string;
-  createdOn: string;
-  _id: string;
-  name: string;
-  slug: string;
-
-  constructor(private client: Client, collection: Collection.ICollection) {
-    Object.assign(this, collection);
-  }
-
-  /**************************************************************
-   * Static Methods
-   **************************************************************/
-
-  /**
-   * Get a single Collection
-   * @param client The Webflow client
-   * @param params The Collection information
-   * @param params.collectionId The Collection ID
-   * @returns A single Collection
-   */
-  static async getOne(
-    client: Client,
-    { collectionId }: { collectionId: string }
-  ) {
-    const res = await Collection.getOne(client, { collectionId });
-    const collection = new CollectionWrapper(client, res.data);
-    return ResponseWrapper<typeof collection>(res, collection);
-  }
-
-  /**
-   * Get a list of Collections
-   * @param client The Webflow client
-   * @param params1 The Site information
-   * @param params1.siteId The Site ID
-   * @param params The query parameters (optional)
-   * @returns A list of Collections
-   */
-  static async list(
-    client: Client,
-    { siteId }: { siteId: string },
-    params?: QueryString
-  ) {
-    const res = await Collection.list(client, { siteId }, params);
-    const collections = res.data.map((c) => new CollectionWrapper(client, c));
-    return ResponseWrapper<typeof collections>(res, collections);
-  }
-
-  /**************************************************************
-   * Instance Methods
-   **************************************************************/
-
-  /**
-   * Get a single Item
-   * @param params The params for the request
-   * @param params.itemId The Item ID
-   * @returns A single Item
-   */
-  async item({ itemId }: { itemId: string }) {
-    return ItemWrapper.getOne(this.client, { itemId, collectionId: this._id });
-  }
-
-  /**
-   * Get a list of Items
-   * @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 Items
-   */
-  async items(params?: QueryString) {
-    return ItemWrapper.list(this.client, { collectionId: this._id, ...params });
-  }
-
-  /**
-   * Remove a single Item
-   * @param params The params for the request
-   * @param params.itemId The Item ID
-   * @returns The result from the removal
-   */
-  async removeItem({ itemId }: { itemId: string }) {
-    return ItemWrapper.remove(this.client, { itemId, collectionId: this._id });
-  }
-
-  /**
-   * Create a new Item
-   * @param params The params for the request
-   * @param params.fields The Item fields to create
-   * @returns The created Item
-   */
-  async createItem(fields: any) {
-    return ItemWrapper.create(this.client, { collectionId: this._id, fields });
-  }
-
-  /**
-   * Update a single Item
-   * @param params The params for the request
-   * @param params.itemId The Item ID
-   * @param params.fields The fields to update
-   * @returns The updated Item
-   */
-  async updateItem({ itemId, fields }: { itemId: string; fields: any }) {
-    return ItemWrapper.update(this.client, {
-      collectionId: this._id,
-      itemId,
-      fields,
-    });
-  }
-}

package/src/wrapper/index.ts

@@ -1,6 +0,0 @@
-export * from "./membership";
-export * from "./collection";
-export * from "./response";
-export * from "./webhook";
-export * from "./site";
-export * from "./item";