webflow-api 1.0.3 → 1.1.1

package/dist/webflow.js

@@ -0,0 +1,388 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Webflow = void 0;
+const core_1 = require("./core");
+const api_1 = require("./api");
+const wrapper_1 = require("./wrapper");
+/**************************************************************
+ * Class
+ **************************************************************/
+class Webflow {
+    constructor(options = {}) {
+        this.options = options;
+        this.client = new core_1.Client(options);
+    }
+    // Set the Authentication token
+    set token(value) {
+        this.client.token = value;
+    }
+    // clear the Authorization header
+    clearToken() {
+        this.client.clearToken();
+    }
+    /**************************************************************
+     * HTTP Methods
+     **************************************************************/
+    /**
+     * Send a GET request to the Webflow API
+     * @param path The path to the endpoint
+     * @param params The query parameters (optional)
+     * @returns The response from the Webflow API
+     */
+    get(path, params) {
+        return this.client.get(path, { params });
+    }
+    /**
+     * Send a DELETE request to the Webflow API
+     * @param path The path to the endpoint
+     * @param params The query parameters (optional)
+     * @returns The response from the Webflow API
+     */
+    delete(path, params) {
+        return this.client.delete(path, { params });
+    }
+    /**
+     * Send a POST request to create a new Collection
+     * @param path The path to the endpoint
+     * @param data The data to send
+     * @param params The query parameters (optional)
+     * @returns The response from the Webflow API
+     */
+    post(path, data, params) {
+        return this.client.post(path, data, { params });
+    }
+    /**
+     * Send a PUT request to create a new Collection
+     * @param path The path to the endpoint
+     * @param data The data to send
+     * @param params The query parameters (optional)
+     * @returns The response from the Webflow API
+     */
+    put(path, data, params) {
+        return this.client.put(path, data, { params });
+    }
+    /**
+     * Send a PATCH request to create a new Collection
+     * @param path The path to the endpoint
+     * @param data The data to send
+     * @param params The query parameters (optional)
+     * @returns The response from the Webflow API
+     */
+    patch(path, data, params) {
+        return this.client.patch(path, data, { params });
+    }
+    /**************************************************************
+     * OAuth Endpoints
+     **************************************************************/
+    /**
+     * Create an OAuth Authorization url
+     * @param params The OAuth information
+     * @param params.state The state parameter (optional)
+     * @param params.scope The scope parameter (optional)
+     * @param params.client_id The client_id parameter (optional)
+     * @param params.redirect_uri The redirect_uri parameter (optional)
+     * @param params.response_type The response_type parameter (default: "code")
+     * @returns The url to redirect to
+     */
+    authorizeUrl(params) {
+        return api_1.OAuth.authorizeUrl(this.client, params);
+    }
+    /**
+     * Create an OAuth Access Token
+     * @param params The OAuth information
+     * @param params.code The code parameter
+     * @param params.client_id The client_id parameter
+     * @param params.client_secret The client_secret parameter
+     * @param params.redirect_uri The redirect_uri parameter (optional)
+     * @param params.grant_type The grant_type parameter (default: "authorization_code")
+     * @returns The access token
+     */
+    async accessToken(params) {
+        const res = await api_1.OAuth.accessToken(this.client, params);
+        return (0, wrapper_1.ResponseWrapper)(res);
+    }
+    /**
+     * Revoke an OAuth Access Token
+     * @param params The access token information
+     * @param params.access_token The access token
+     * @param params.client_id The client_id parameter
+     * @param params.client_secret The client_secret parameter
+     * @returns The result of the revoked token
+     */
+    async revokeToken(params) {
+        const res = await api_1.OAuth.revokeToken(this.client, params);
+        return (0, wrapper_1.ResponseWrapper)(res);
+    }
+    /**************************************************************
+     * Meta Endpoints
+     **************************************************************/
+    /**
+     * Get the current authorization information
+     * @returns The authorization information
+     */
+    async info() {
+        const res = await api_1.Meta.info(this.client);
+        return (0, wrapper_1.ResponseWrapper)(res);
+    }
+    /**
+     * Get the current authenticated user
+     * @returns The current authenticated user
+     */
+    async authenticatedUser() {
+        const res = await api_1.Meta.user(this.client);
+        return (0, wrapper_1.ResponseWrapper)(res);
+    }
+    /**************************************************************
+     * Site Endpoints
+     **************************************************************/
+    /**
+     * Get a list of Sites available
+     * @param query The query parameters (optional)
+     * @returns A list of Sites
+     */
+    async sites(query) {
+        return wrapper_1.SiteWrapper.list(this.client, query);
+    }
+    /**
+     * Get a single Site
+     * @param params The Site information
+     * @param params.siteId The Site ID
+     * @returns The Site
+     */
+    async site({ siteId }) {
+        return wrapper_1.SiteWrapper.getOne(this.client, { siteId });
+    }
+    /**
+     * Publish a Site
+     * @param params The Site information
+     * @param params.siteId The Site ID
+     * @param params.domain The domains to publish
+     * @returns The result of the publish
+     */
+    publishSite({ siteId, domains }) {
+        return wrapper_1.SiteWrapper.publish(this.client, { siteId, domains });
+    }
+    /**
+     * Get a list of Domains for a Site
+     * @param params The Site information
+     * @param params.siteId The Site ID
+     * @returns A list of Domains
+     */
+    async domains({ siteId }) {
+        return wrapper_1.SiteWrapper.domains(this.client, { siteId });
+    }
+    /**************************************************************
+     * Collection Endpoints
+     **************************************************************/
+    /**
+     * Get a list of Collections
+     * @param params The Site information
+     * @param params.siteId The Site ID
+     * @param query The query parameters (optional)
+     * @returns A list of Collections
+     */
+    async collections({ siteId }, query) {
+        return wrapper_1.CollectionWrapper.list(this.client, { siteId }, query);
+    }
+    /**
+     * Get a single Collection
+     * @param params The Collection information
+     * @param params.collectionId The Collection ID
+     * @returns A single Collection
+     */
+    async collection({ collectionId }) {
+        return wrapper_1.CollectionWrapper.getOne(this.client, { collectionId });
+    }
+    /**************************************************************
+     * Item Endpoints
+     **************************************************************/
+    /**
+     * Get a list of Collection Items
+     * @param params The Collection information
+     * @param params.collectionId The Collection ID
+     * @param pageParams The pagination parameters (optional)
+     * @returns A list of Items
+     */
+    async items({ collectionId }, pageParams) {
+        return wrapper_1.ItemWrapper.list(this.client, { collectionId, ...pageParams });
+    }
+    /**
+     * Get a single Collection Item
+     * @param params The Item information
+     * @param params.collectionId The Collection ID
+     * @param params.itemId The Item ID
+     * @returns A single Collection Item
+     */
+    async item({ itemId, collectionId, }) {
+        return wrapper_1.ItemWrapper.getOne(this.client, { itemId, collectionId });
+    }
+    /**
+     * Create a new Collection Item
+     * @param params The Item information
+     * @param params.collectionId The Collection ID
+     * @returns The created Collection Item
+     */
+    async createItem({ collectionId, fields, }) {
+        return wrapper_1.ItemWrapper.create(this.client, { collectionId, fields });
+    }
+    /**
+     * Update a Collection Item
+     * @param params The Item information
+     * @param params.collectionId The Collection ID
+     * @param params.itemId The Item ID
+     * @param query The query parameters (optional)
+     * @returns The updated Collection Item
+     */
+    updateItem({ collectionId, itemId, ...fields }) {
+        const _params = { collectionId, itemId, fields };
+        return wrapper_1.ItemWrapper.update(this.client, _params);
+    }
+    /**
+     * Patch a Collection Item
+     * @param params The Item information
+     * @param params.collectionId The Collection ID
+     * @param params.itemId The Item ID
+     * @param query The query parameters (optional)
+     * @returns The patched Collection Item
+     */
+    patchItem({ collectionId, itemId, ...fields }, query) {
+        const _params = { collectionId, itemId, fields };
+        return wrapper_1.ItemWrapper.patch(this.client, _params, query);
+    }
+    /**
+     * Delete a Collection Item
+     * @param params The Item information
+     * @param params.collectionId The Collection ID
+     * @param params.itemId The Item ID
+     * @returns The deleted Collection Item result
+     */
+    removeItem({ collectionId, itemId, }) {
+        return wrapper_1.ItemWrapper.remove(this.client, { collectionId, itemId });
+    }
+    /**
+     * Upublish a Collection Item
+     * @param params The Item information
+     * @param params.collectionId The Collection ID
+     * @param params.itemId The Item ID
+     * @param query The query parameters (optional)
+     * @param query.live Update the live version
+     * @returns The unpublished Collection Item result
+     */
+    deleteItems({ collectionId, itemIds, live, }) {
+        const params = { collectionId, itemIds, live };
+        return wrapper_1.ItemWrapper.unpublish(this.client, params);
+    }
+    /**
+     * Publish a Collection Item
+     * @param params The Item information
+     * @param params.collectionId The Collection ID
+     * @param params.itemId The Item ID
+     * @param query The query parameters (optional)
+     * @param query.live Update the live version
+     * @returns The Published Collection Item result
+     */
+    publishItems({ collectionId, itemIds, live, }) {
+        const params = { collectionId, itemIds, live };
+        return wrapper_1.ItemWrapper.publish(this.client, params);
+    }
+    /**************************************************************
+     * Membership Endpoints
+     **************************************************************/
+    /**
+     * Get a list of User accounts
+     * @param params The Site information
+     * @param params.siteId The Site ID
+     * @param pageParams The pagination information (optional)
+     * @returns A list of User accounts
+     */
+    async users({ siteId }, pageParams) {
+        return wrapper_1.MembershipWrapper.list(this.client, { siteId, ...pageParams });
+    }
+    /**
+     * Get a single User account
+     * @param param The Site and User information
+     * @param param.siteId The Site ID
+     * @param param.userId The User ID
+     * @returns The User information
+     */
+    async user({ siteId, userId }) {
+        return wrapper_1.MembershipWrapper.getOne(this.client, { siteId, userId });
+    }
+    /**
+     * Update a User account
+     * @param params The Site and User information
+     * @param params.siteId The Site ID
+     * @param params.userId The User ID
+     * @returns The updated User
+     */
+    async updateUser({ siteId, userId, ...data }) {
+        const _params = { siteId, userId, data };
+        return wrapper_1.MembershipWrapper.update(this.client, _params);
+    }
+    /**
+     * Invite a User to a Site
+     * @param params The Site and User information
+     * @param params.siteId The Site ID
+     * @param params.email The User's email address
+     * @returns The created User account
+     */
+    async inviteUser({ siteId, email }) {
+        return wrapper_1.MembershipWrapper.invite(this.client, { siteId, email });
+    }
+    /**
+     * Remove a user from a Site
+     * @param params The Site and User information
+     * @param params.siteId The Site ID
+     * @param params.userId The User ID
+     * @returns The result from the remove request
+     */
+    removeUser({ siteId, userId }) {
+        return wrapper_1.MembershipWrapper.remove(this.client, { siteId, userId });
+    }
+    /**************************************************************
+     * Webhook Endpoints
+     **************************************************************/
+    /**
+     * Get a list of webhooks for a Site
+     * @param params The site information to get the Webhooks from
+     * @param params.siteId The Site ID
+     * @returns A list of Webhooks
+     */
+    async webhooks({ siteId }, query) {
+        return wrapper_1.WebhookWrapper.list(this.client, { siteId }, query);
+    }
+    /**
+     * Get a single Webhook
+     * @param params The Webhook and Site information
+     * @param params.siteId The Site Id
+     * @param params.webhookId The Webhook Id
+     * @returns The Webhook
+     */
+    async webhook({ siteId, webhookId }) {
+        return wrapper_1.WebhookWrapper.getOne(this.client, { siteId, webhookId });
+    }
+    /**
+     * Remove a Webhook
+     * @param params The Webhook and Site information
+     * @param params.siteId The Site Id
+     * @param params.webhookId The Webhook Id
+     * @returns the result from the remove request
+     */
+    removeWebhook({ siteId, webhookId }) {
+        return wrapper_1.WebhookWrapper.remove(this.client, { siteId, webhookId });
+    }
+    /**
+     * Create a Webhook
+     * @param params The params to create a webhooks
+     * @param params.siteId The Site Id
+     * @param params.url The Url the Webhook should call on events
+     * @param params.triggerType The type of event that should trigger the Webhook
+     * @param params.filter The filter to apply to the Webhook (form_submssion only)
+     * @returns The created webhook
+     */
+    async createWebhook({ url, siteId, triggerType, filter, }) {
+        const _params = { url, siteId, triggerType, filter };
+        return wrapper_1.WebhookWrapper.create(this.client, _params);
+    }
+}
+exports.Webflow = Webflow;

package/dist/wrapper/collection.d.ts

@@ -0,0 +1,85 @@
+import { ItemWrapper } from ".";
+import { Client, QueryString } from "../core";
+import { Collection, Item } from "../api";
+export declare class CollectionWrapper implements Collection.ICollection {
+    private client;
+    fields: Collection.CollectionField[];
+    singularName: string;
+    lastUpdated: string;
+    createdOn: string;
+    _id: string;
+    name: string;
+    slug: string;
+    constructor(client: Client, collection: Collection.ICollection);
+    /**************************************************************
+     * 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 getOne(client: Client, { collectionId }: {
+        collectionId: string;
+    }): Promise<import("./response").MetaResponse<CollectionWrapper>>;
+    /**
+     * 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 list(client: Client, { siteId }: {
+        siteId: string;
+    }, params?: QueryString): Promise<import("./response").MetaResponse<CollectionWrapper[]>>;
+    /**************************************************************
+     * Instance Methods
+     **************************************************************/
+    /**
+     * Get a single Item
+     * @param params The params for the request
+     * @param params.itemId The Item ID
+     * @returns A single Item
+     */
+    item({ itemId }: {
+        itemId: string;
+    }): Promise<import("./response").MetaResponse<ItemWrapper>>;
+    /**
+     * 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
+     */
+    items(params?: QueryString): Promise<import("./response").MetaResponse<ItemWrapper[]>>;
+    /**
+     * Remove a single Item
+     * @param params The params for the request
+     * @param params.itemId The Item ID
+     * @returns The result from the removal
+     */
+    removeItem({ itemId }: {
+        itemId: string;
+    }): Promise<import("./response").MetaResponse<Item.IItemDelete>>;
+    /**
+     * Create a new Item
+     * @param params The params for the request
+     * @param params.fields The Item fields to create
+     * @returns The created Item
+     */
+    createItem(fields: any): Promise<import("./response").MetaResponse<ItemWrapper>>;
+    /**
+     * 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
+     */
+    updateItem({ itemId, fields }: {
+        itemId: string;
+        fields: any;
+    }): Promise<import("./response").MetaResponse<ItemWrapper>>;
+}

package/dist/wrapper/collection.js

@@ -0,0 +1,94 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CollectionWrapper = void 0;
+const _1 = require(".");
+const api_1 = require("../api");
+class CollectionWrapper {
+    constructor(client, collection) {
+        this.client = client;
+        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, { collectionId }) {
+        const res = await api_1.Collection.getOne(client, { collectionId });
+        const collection = new CollectionWrapper(client, res.data);
+        return (0, _1.ResponseWrapper)(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, { siteId }, params) {
+        const res = await api_1.Collection.list(client, { siteId }, params);
+        const collections = res.data.map((c) => new CollectionWrapper(client, c));
+        return (0, _1.ResponseWrapper)(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 }) {
+        return _1.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) {
+        return _1.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 }) {
+        return _1.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) {
+        return _1.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 }) {
+        return _1.ItemWrapper.update(this.client, {
+            collectionId: this._id,
+            itemId,
+            fields,
+        });
+    }
+}
+exports.CollectionWrapper = CollectionWrapper;

package/dist/wrapper/index.d.ts

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

package/dist/wrapper/index.js

@@ -0,0 +1,22 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./membership"), exports);
+__exportStar(require("./collection"), exports);
+__exportStar(require("./response"), exports);
+__exportStar(require("./webhook"), exports);
+__exportStar(require("./site"), exports);
+__exportStar(require("./item"), exports);