webflow-api 1.1.2 → 1.2.1

package/src/wrapper/site.ts

@@ -1,228 +0,0 @@
-import {
-  CreateWebhookParams,
-  CollectionWrapper,
-  ResponseWrapper,
-  WebhookWrapper,
-  MembershipWrapper,
-} from ".";
-import { Client, QueryString } from "../core";
-import { Site } from "../api";
-
-export class SiteWrapper implements Site.ISite {
-  lastPublished: string;
-  previewUrl: string;
-  createdOn: string;
-  shortName: string;
-  timezone: string;
-  database: string;
-  name: string;
-  _id: string;
-
-  constructor(private client: Client, site: Site.ISite) {
-    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: Client, { siteId }: { siteId: string }) {
-    const res = await Site.getOne(client, { siteId });
-    const site = new SiteWrapper(client, res.data);
-    return ResponseWrapper<typeof site>(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: Client, params?: QueryString) {
-    const res = await Site.list(client, params);
-    const sites = res.data.map((s) => new SiteWrapper(client, s));
-    return ResponseWrapper<typeof sites>(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: Client, { siteId }: { siteId: string }) {
-    const res = await Site.domains(client, { siteId });
-    return ResponseWrapper<typeof res.data>(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: Client,
-    { siteId, domains }: { siteId: string; domains: string[] }
-  ) {
-    const res = await Site.publish(client, { siteId, domains });
-    return ResponseWrapper<typeof res.data>(res);
-  }
-
-  /**************************************************************
-   * Instance Methods
-   **************************************************************/
-
-  /**
-   * Get a list of domains for a site
-   * @returns A list of domains
-   */
-  async domains() {
-    const res = await Site.domains(this.client, { siteId: this._id });
-    return ResponseWrapper<typeof res.data>(res);
-  }
-
-  /**
-   * Publish a site
-   * @param domains The domains to publish to
-   * @returns The publish result
-   */
-  async publishSite(domains: string[]) {
-    const res = await Site.publish(this.client, { siteId: this._id, domains });
-    return ResponseWrapper<typeof res.data>(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 }: { collectionId: string }) {
-    return CollectionWrapper.getOne(this.client, { collectionId });
-  }
-
-  /**
-   * Get a list of Collections
-   * @returns A list of Collections
-   */
-  async collections() {
-    return 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 }: { webhookId: string }) {
-    return 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?: QueryString) {
-    return 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 }: { webhookId: string }) {
-    return 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 }: CreateWebhookParams) {
-    const _params = { url, siteId: this._id, triggerType, filter };
-    return 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 }: { limit?: number; offset?: number } = {}) {
-    return 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 }: { userId: string }) {
-    return 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 }: { email: string }) {
-    return 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,
-  }: { limit?: number; offset?: number } = {}) {
-    return 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 }: { userId: string }) {
-    return MembershipWrapper.remove(this.client, { siteId: this._id, userId });
-  }
-}

package/src/wrapper/webhook.ts

@@ -1,116 +0,0 @@
-import { Client, QueryString } from "../core";
-import { ResponseWrapper } from ".";
-import { Webhook } from "../api";
-
-export type CreateWebhookParams = {
-  url: string;
-  siteId: string;
-  triggerType: string;
-  filter?: Webhook.Filter;
-};
-
-export class WebhookWrapper implements Webhook.IWebhook {
-  triggerType: Webhook.TriggerType;
-  triggerId: string;
-  createdOn: string;
-  lastUsed?: string;
-  site: string;
-  _id: string;
-  filter?: {
-    name: string;
-  };
-
-  constructor(private client: Client, webhook: Webhook.IWebhook) {
-    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: Client,
-    { siteId, webhookId }: { siteId: string; webhookId: string }
-  ) {
-    const res = await Webhook.getOne(client, { siteId, webhookId });
-    const webhook = new WebhookWrapper(client, res.data);
-    return ResponseWrapper<typeof webhook>(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: Client,
-    { siteId }: { siteId: string },
-    params?: QueryString
-  ) {
-    const res = await Webhook.list(client, { siteId }, params);
-    const webhooks = res.data.map((w) => new WebhookWrapper(client, w));
-    return ResponseWrapper<typeof webhooks>(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: Client,
-    { siteId, webhookId }: { siteId: string; webhookId: string }
-  ) {
-    const res = await Webhook.remove(client, { siteId, webhookId });
-    return ResponseWrapper<typeof res.data>(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: Client,
-    { triggerType, siteId, filter, url }: CreateWebhookParams
-  ) {
-    const args = { triggerType, siteId, filter, url };
-    const res = await Webhook.create(client, args);
-    const _webhook = new WebhookWrapper(client, res.data);
-    return ResponseWrapper<typeof _webhook>(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,
-    });
-  }
-}