webflow-api 1.1.2 → 1.2.1

package/dist/api/membership.d.ts

@@ -1,114 +0,0 @@
-import { Client, PaginatedData } 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 declare type PaginatedUsers = PaginatedData & {
-    users: IUser[];
-};
-export declare type PaginatedAccessGroups = PaginatedData & {
-    accessGroups: IAccessGroup[];
-};
-export declare 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 declare function list(client: Client, { siteId, limit, offset }: {
-    siteId: string;
-    limit?: number;
-    offset?: number;
-}): Promise<import("axios").AxiosResponse<PaginatedUsers, any>>;
-/**
- * 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 declare function getOne(client: Client, { siteId, userId }: {
-    siteId: string;
-    userId: string;
-}): Promise<import("axios").AxiosResponse<IUser, any>>;
-/**
- * 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 declare function update(client: Client, { siteId, userId, ...data }: {
-    siteId: string;
-    userId: string;
-}): Promise<import("axios").AxiosResponse<IUser, any>>;
-/**
- * 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 declare function invite(client: Client, { siteId, email }: {
-    siteId: string;
-    email: string;
-}): Promise<import("axios").AxiosResponse<IUser, any>>;
-/**
- * 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 declare function remove(client: Client, { siteId, userId }: {
-    siteId: string;
-    userId: string;
-}): Promise<import("axios").AxiosResponse<IUserDelete, any>>;
-/**
- * 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 declare function accessGroups(client: Client, { siteId, limit, offset }: {
-    siteId: string;
-    limit?: number;
-    offset?: number;
-}): Promise<import("axios").AxiosResponse<PaginatedAccessGroups, any>>;

package/dist/api/membership.js

@@ -1,96 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.accessGroups = exports.remove = exports.invite = exports.update = exports.getOne = exports.list = void 0;
-const core_1 = require("../core");
-/**************************************************************
- * 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
- */
-function list(client, { siteId, limit, offset }) {
-    (0, core_1.requireArgs)({ siteId });
-    const params = { limit, offset };
-    const path = `/sites/${siteId}/users`;
-    return client.get(path, { params });
-}
-exports.list = list;
-/**
- * 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
- */
-function getOne(client, { siteId, userId }) {
-    (0, core_1.requireArgs)({ siteId, userId });
-    const path = `/sites/${siteId}/users/${userId}`;
-    return client.get(path);
-}
-exports.getOne = getOne;
-/**
- * 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
- */
-function update(client, { siteId, userId, ...data }) {
-    (0, core_1.requireArgs)({ siteId, userId });
-    const path = `/sites/${siteId}/users/${userId}`;
-    return client.patch(path, data);
-}
-exports.update = update;
-/**
- * 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
- */
-async function invite(client, { siteId, email }) {
-    (0, core_1.requireArgs)({ siteId, email });
-    const path = `/sites/${siteId}/users/invite`;
-    return client.post(path, { email });
-}
-exports.invite = invite;
-/**
- * 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
- */
-function remove(client, { siteId, userId }) {
-    (0, core_1.requireArgs)({ siteId, userId });
-    const path = `/sites/${siteId}/users/${userId}`;
-    return client.delete(path);
-}
-exports.remove = remove;
-/**
- * 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
- */
-function accessGroups(client, { siteId, limit, offset }) {
-    (0, core_1.requireArgs)({ siteId });
-    const params = { limit, offset };
-    const path = `/sites/${siteId}/users/accessgroups`;
-    return client.get(path, { params });
-}
-exports.accessGroups = accessGroups;

package/dist/core/client.d.ts

@@ -1,27 +0,0 @@
-import { Axios } from "axios";
-import { Options } from "../core";
-/**************************************************************
- * Types
- **************************************************************/
-export declare type QueryString = Record<string, any>;
-export declare type PaginationFilter = {
-    limit?: number;
-    offset?: number;
-};
-/**************************************************************
- * Interfaces
- ************************************************************* */
-export interface PaginatedData {
-    count: number;
-    limit: number;
-    offset: number;
-    total: number;
-}
-/**************************************************************
- * Classes
- **************************************************************/
-export declare class Client extends Axios {
-    constructor({ host, headers, version, token, }?: Options);
-    set token(value: string);
-    clearToken(): void;
-}

package/dist/core/client.js

@@ -1,60 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Client = void 0;
-const axios_1 = require("axios");
-const core_1 = require("../core");
-/**************************************************************
- * 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 = {}) {
-    // 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 core_1.RequestError(data);
-    return data;
-}
-/**
- * Transforms POST/PUT/PATCH request data to JSON
- * @param data A JavaScript object
- * @returns JSON string
- */
-function transformRequest(data = {}) {
-    return JSON.stringify(data);
-}
-/**************************************************************
- * Classes
- **************************************************************/
-class Client extends axios_1.Axios {
-    constructor({ host = core_1.DEFAULT_HOST, headers = {}, version, token, } = {}) {
-        super({
-            transformRequest: [transformRequest],
-            transformResponse: [transformResponse],
-            baseURL: `https://api.${host}/`,
-            headers: {
-                "Content-Type": "application/json",
-                "User-Agent": core_1.USER_AGENT,
-                "Accept-Version": version,
-                ...headers,
-            },
-        });
-        if (token)
-            this.token = token;
-    }
-    // set the Authorization header
-    set token(value) {
-        this.defaults.headers["Authorization"] = `Bearer ${value}`;
-    }
-    // clear the Authorization header
-    clearToken() {
-        delete this.defaults.headers["Authorization"];
-    }
-}
-exports.Client = Client;

package/dist/core/options.d.ts

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

package/dist/core/options.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.USER_AGENT = exports.DEFAULT_HOST = void 0;
-exports.DEFAULT_HOST = "webflow.com";
-exports.USER_AGENT = "Webflow Javascript SDK / 1.0";

package/dist/wrapper/collection.d.ts

@@ -1,85 +0,0 @@
-import { ItemWrapper } from ".";
-import { Client, QueryString } from "../core";
-import { Collection } 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<import("../api/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

@@ -1,94 +0,0 @@
-"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

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

package/dist/wrapper/index.js

@@ -1,22 +0,0 @@
-"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);

package/dist/wrapper/item.d.ts

@@ -1,140 +0,0 @@
-import { Client, QueryString, PaginationFilter } from "../core";
-import { Item } from "../api";
-export declare class ItemWrapper implements Item.IItem {
-    private client;
-    "published-on"?: string | null;
-    "published-by"?: string | null;
-    "updated-on": string;
-    "created-on": string;
-    "updated-by": string;
-    "created-by": string;
-    _archived: boolean;
-    _draft: boolean;
-    _cid: string;
-    name: string;
-    slug: string;
-    _id: string;
-    constructor(client: Client, item: Item.IItem);
-    /**************************************************************
-     * 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 create(client: Client, { collectionId, fields }: {
-        collectionId: string;
-        fields: any;
-    }): Promise<import("./response").MetaResponse<ItemWrapper>>;
-    /**
-     * 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 getOne(client: Client, itemParams: {
-        collectionId: string;
-        itemId: string;
-    }): Promise<import("./response").MetaResponse<ItemWrapper>>;
-    /**
-     * 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 list(client: Client, { collectionId, limit, offset }: {
-        collectionId: string;
-    } & PaginationFilter): Promise<import("./response").MetaResponse<ItemWrapper[]>>;
-    /**
-     * 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 remove(client: Client, { collectionId, itemId }: {
-        collectionId: string;
-        itemId: string;
-    }): Promise<import("./response").MetaResponse<Item.IItemDelete>>;
-    /**
-     * 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 publish(client: Client, { collectionId, itemIds, live, }: {
-        collectionId: string;
-        itemIds: string[];
-        live: boolean;
-    }): Promise<import("./response").MetaResponse<Item.IPublishItems>>;
-    /**
-     * 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 unpublish(client: Client, { collectionId, itemIds, live, }: {
-        collectionId: string;
-        itemIds: string[];
-        live: boolean;
-    }): Promise<import("./response").MetaResponse<Item.IDeletedItems>>;
-    /**
-     * 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 update(client: Client, { collectionId, itemId, fields, }: {
-        collectionId: string;
-        itemId: string;
-        fields: any;
-    }): Promise<import("./response").MetaResponse<ItemWrapper>>;
-    /**
-     * 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 patch(client: Client, { collectionId, itemId, fields, }: {
-        collectionId: string;
-        itemId: string;
-        fields: any;
-    }, params?: QueryString): Promise<import("./response").MetaResponse<ItemWrapper>>;
-    /**************************************************************
-     * Instance Methods
-     **************************************************************/
-    /**
-     * Update a single Item
-     * @param fields The fields to update
-     * @returns The updated Item
-     */
-    update({ ...fields }: {
-        [x: string]: any;
-    }): Promise<import("./response").MetaResponse<ItemWrapper>>;
-    /**
-     * Remove a single Item
-     * @returns The result from the removal
-     */
-    remove(): Promise<import("./response").MetaResponse<Item.IItemDelete>>;
-}