webflow-api 1.1.2 → 1.2.1

package/dist/api/item.d.ts

@@ -1,4 +1,5 @@
-import { Client, PaginatedData } from "../core";
+import { AxiosInstance } from "axios";
+import { PaginatedData, WebflowRecord } from "../core";
 /**************************************************************
  * Interfaces
  **************************************************************/
@@ -34,110 +35,143 @@ export declare type PageinatedItems = PaginatedData & {
     items: IItem[];
 };
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
-/**
- * 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
- */
-export declare function getOne(client: Client, { collectionId, itemId }: {
-    collectionId: string;
-    itemId: string;
-}): Promise<import("axios").AxiosResponse<PageinatedItems, any>>;
-/**
- * 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
- */
-export declare function list(client: Client, { collectionId, limit, offset, }: {
-    collectionId: string;
-    limit?: number;
-    offset?: number;
-}): Promise<import("axios").AxiosResponse<PageinatedItems, any>>;
-/**
- * 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
- */
-export declare function create(client: Client, { collectionId, fields }: {
-    fields: any;
-    collectionId: string;
-}): Promise<import("axios").AxiosResponse<IItem, any>>;
-/**
- * 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
- */
-export declare function update(client: Client, { collectionId, itemId, fields, }: {
-    fields: any;
-    itemId: string;
-    collectionId: string;
-}): Promise<import("axios").AxiosResponse<IItem, any>>;
-/**
- * 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
- */
-export declare function patch(client: Client, { collectionId, itemId, fields, }: {
-    fields: any;
-    itemId: string;
-    collectionId: string;
-}): Promise<import("axios").AxiosResponse<IItem, any>>;
-/**
- * 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
- */
-export declare function remove(client: Client, { collectionId, itemId, }: {
-    itemId: string;
-    collectionId: string;
-}): Promise<import("axios").AxiosResponse<IItemDelete, any>>;
-/**
- * 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
- */
-export declare function unpublish(client: Client, { collectionId, itemIds, live, }: {
-    live?: boolean;
-    itemIds: string[];
-    collectionId: string;
-}): Promise<import("axios").AxiosResponse<IDeletedItems, any>>;
-/**
- * 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
- */
-export declare function publish(client: Client, { itemIds, live, collectionId, }: {
-    live?: boolean;
-    itemIds: string[];
-    collectionId: string;
-}): Promise<import("axios").AxiosResponse<IPublishItems, any>>;
+export declare class Item extends WebflowRecord<IItem> implements IItem {
+    "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;
+    /**************************************************************
+     * Static Methods
+     **************************************************************/
+    /**
+     * Get a single Item
+     * @param params The params for the request
+     * @param params.collectionId The Collection ID
+     * @param params.itemId The Item ID
+     * @param client The Axios client instance
+     * @returns A single Item
+     */
+    static getOne({ collectionId, itemId }: {
+        collectionId: string;
+        itemId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<PageinatedItems, any>>;
+    /**
+     * Get a list of Items
+     * @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)
+     * @param client The Axios client instance
+     * @returns A list of Items
+     */
+    static list({ collectionId, limit, offset }: {
+        collectionId: string;
+        limit?: number;
+        offset?: number;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<PageinatedItems, any>>;
+    /**
+     * Create a new Item
+     * @param params The params for the request
+     * @param params.collectionId The Collection ID
+     * @param params.fields The Item fields to create
+     * @param client The Axios client instance
+     * @returns The created Item
+     */
+    static create({ collectionId, fields }: {
+        fields: any;
+        collectionId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IItem, any>>;
+    /**
+     * Update a single Item
+     * @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
+     * @param client The Axios client instance
+     * @returns The updated Item
+     */
+    static update({ collectionId, itemId, fields, }: {
+        fields: any;
+        itemId: string;
+        collectionId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IItem, any>>;
+    /**
+     * Patch a single Item
+     * @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
+     * @param client The Axios client instance
+     * @returns The patched Item
+     */
+    static patch({ collectionId, itemId, fields, }: {
+        fields: any;
+        itemId: string;
+        collectionId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IItem, any>>;
+    /**
+     * Remove a single Item
+     * @param params The params for the request
+     * @param params.collectionId The Collection ID
+     * @param params.itemId The Item ID
+     * @param client The Axios client instance
+     * @returns The result from the removal
+     */
+    static remove({ collectionId, itemId, }: {
+        itemId: string;
+        collectionId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IItemDelete, any>>;
+    /**
+     * Unpublishes a list of Items
+     * @param params The params for the request
+     * @param params.collectionId The Collection ID
+     * @param params.live Unpublish from the live site
+     * @param client The Axios client instance
+     * @returns The result of the unpublish
+     */
+    static unpublish({ collectionId, itemIds, live, }: {
+        live?: boolean;
+        itemIds: string[];
+        collectionId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IDeletedItems, any>>;
+    /**
+     * Publishes a list of Items
+     * @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
+     * @param client The Axios client instance
+     * @returns The result of the publish
+     */
+    static publish({ itemIds, live, collectionId, }: {
+        live?: boolean;
+        itemIds: string[];
+        collectionId: string;
+    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IPublishItems, any>>;
+    /**************************************************************
+     * Instance Methods
+     **************************************************************/
+    /**
+     * Update a single Item
+     * @param fields The fields to update
+     * @returns The updated Item
+     */
+    update({ ...fields }: {
+        [x: string]: any;
+    }): Promise<Item>;
+    /**
+     * Remove a single Item
+     * @returns The result from the removal
+     */
+    remove(): Promise<IItemDelete>;
+}

package/dist/api/item.js

@@ -1,131 +1,151 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.publish = exports.unpublish = exports.remove = exports.patch = exports.update = exports.create = exports.list = exports.getOne = void 0;
+exports.Item = void 0;
 const core_1 = require("../core");
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
-/**
- * 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
- */
-function getOne(client, { collectionId, itemId }) {
-    (0, core_1.requireArgs)({ collectionId, itemId });
-    const path = `/collections/${collectionId}/items/${itemId}`;
-    // The API returns a paginated list with one record :(
-    return client.get(path);
+class Item extends core_1.WebflowRecord {
+    /**************************************************************
+     * Static Methods
+     **************************************************************/
+    /**
+     * Get a single Item
+     * @param params The params for the request
+     * @param params.collectionId The Collection ID
+     * @param params.itemId The Item ID
+     * @param client The Axios client instance
+     * @returns A single Item
+     */
+    static getOne({ collectionId, itemId }, client) {
+        (0, core_1.requireArgs)({ collectionId, itemId });
+        const path = `/collections/${collectionId}/items/${itemId}`;
+        // The API returns a paginated list with one record :(
+        return client.get(path);
+    }
+    /**
+     * Get a list of Items
+     * @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)
+     * @param client The Axios client instance
+     * @returns A list of Items
+     */
+    static list({ collectionId, limit, offset }, client) {
+        (0, core_1.requireArgs)({ collectionId });
+        const params = { limit, offset };
+        const path = `/collections/${collectionId}/items`;
+        return client.get(path, { params });
+    }
+    /**
+     * Create a new Item
+     * @param params The params for the request
+     * @param params.collectionId The Collection ID
+     * @param params.fields The Item fields to create
+     * @param client The Axios client instance
+     * @returns The created Item
+     */
+    static create({ collectionId, fields }, client) {
+        (0, core_1.requireArgs)({ collectionId });
+        const path = `/collections/${collectionId}/items`;
+        return client.post(path, { fields });
+    }
+    /**
+     * Update a single Item
+     * @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
+     * @param client The Axios client instance
+     * @returns The updated Item
+     */
+    static update({ collectionId, itemId, fields, }, client) {
+        (0, core_1.requireArgs)({ collectionId, itemId });
+        const path = `/collections/${collectionId}/items/${itemId}`;
+        return client.put(path, { fields });
+    }
+    /**
+     * Patch a single Item
+     * @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
+     * @param client The Axios client instance
+     * @returns The patched Item
+     */
+    static patch({ collectionId, itemId, fields, }, client) {
+        (0, core_1.requireArgs)({ collectionId, itemId });
+        const path = `/collections/${collectionId}/items/${itemId}`;
+        return client.patch(path, { fields });
+    }
+    /**
+     * Remove a single Item
+     * @param params The params for the request
+     * @param params.collectionId The Collection ID
+     * @param params.itemId The Item ID
+     * @param client The Axios client instance
+     * @returns The result from the removal
+     */
+    static remove({ collectionId, itemId, }, client) {
+        (0, core_1.requireArgs)({ collectionId, itemId });
+        const path = `/collections/${collectionId}/items/${itemId}`;
+        return client.delete(path);
+    }
+    /**
+     * Unpublishes a list of Items
+     * @param params The params for the request
+     * @param params.collectionId The Collection ID
+     * @param params.live Unpublish from the live site
+     * @param client The Axios client instance
+     * @returns The result of the unpublish
+     */
+    static unpublish({ collectionId, itemIds, live = false, }, client) {
+        (0, core_1.requireArgs)({ collectionId, itemIds });
+        const params = { live };
+        const data = { itemIds };
+        const url = `/collections/${collectionId}/items`;
+        const _params = { method: "DELETE", url, data, params };
+        // DELETE spec doesn't support body in delete
+        // RFC-9110 https://tools.ietf.org/html/rfc9110
+        return client.request(_params);
+    }
+    /**
+     * Publishes a list of Items
+     * @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
+     * @param client The Axios client instance
+     * @returns The result of the publish
+     */
+    static publish({ itemIds, live = false, collectionId, }, client) {
+        (0, core_1.requireArgs)({ collectionId, itemIds });
+        const params = { live };
+        const path = `/collections/${collectionId}/items/publish`;
+        return client.put(path, { itemIds }, { params });
+    }
+    /**************************************************************
+     * Instance Methods
+     **************************************************************/
+    /**
+     * Update a single Item
+     * @param fields The fields to update
+     * @returns The updated Item
+     */
+    async update({ ...fields }) {
+        const params = { collectionId: this._cid, itemId: this._id, fields };
+        const res = await Item.update(params, this.client);
+        return new Item(this.client, res);
+    }
+    /**
+     * Remove a single Item
+     * @returns The result from the removal
+     */
+    async remove() {
+        const params = { collectionId: this._cid, itemId: this._id };
+        const res = await Item.remove(params, this.client);
+        return res.data;
+    }
 }
-exports.getOne = getOne;
-/**
- * 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
- */
-function list(client, { collectionId, limit, offset, }) {
-    (0, core_1.requireArgs)({ collectionId });
-    const params = { limit, offset };
-    const path = `/collections/${collectionId}/items`;
-    return client.get(path, { params });
-}
-exports.list = list;
-/**
- * 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
- */
-function create(client, { collectionId, fields }) {
-    (0, core_1.requireArgs)({ collectionId });
-    const path = `/collections/${collectionId}/items`;
-    return client.post(path, { fields });
-}
-exports.create = create;
-/**
- * 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
- */
-function update(client, { collectionId, itemId, fields, }) {
-    (0, core_1.requireArgs)({ collectionId, itemId });
-    const path = `/collections/${collectionId}/items/${itemId}`;
-    return client.put(path, { fields });
-}
-exports.update = update;
-/**
- * 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
- */
-function patch(client, { collectionId, itemId, fields, }) {
-    (0, core_1.requireArgs)({ collectionId, itemId });
-    const path = `/collections/${collectionId}/items/${itemId}`;
-    return client.patch(path, { fields });
-}
-exports.patch = patch;
-/**
- * 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
- */
-function remove(client, { collectionId, itemId, }) {
-    (0, core_1.requireArgs)({ collectionId, itemId });
-    const path = `/collections/${collectionId}/items/${itemId}`;
-    return client.delete(path);
-}
-exports.remove = remove;
-/**
- * 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
- */
-function unpublish(client, { collectionId, itemIds, live = false, }) {
-    (0, core_1.requireArgs)({ collectionId, itemIds });
-    const params = { live };
-    const data = { itemIds };
-    const url = `/collections/${collectionId}/items`;
-    const _params = { method: "DELETE", url, data, params };
-    // DELETE spec doesn't support body in delete
-    // RFC-9110 https://tools.ietf.org/html/rfc9110
-    return client.request(_params);
-}
-exports.unpublish = unpublish;
-/**
- * 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
- */
-function publish(client, { itemIds, live = false, collectionId, }) {
-    (0, core_1.requireArgs)({ collectionId, itemIds });
-    const params = { live };
-    const path = `/collections/${collectionId}/items/publish`;
-    return client.put(path, { itemIds }, { params });
-}
-exports.publish = publish;
+exports.Item = Item;

package/dist/api/meta.d.ts

@@ -1,4 +1,4 @@
-import { Client } from "../core";
+import { AxiosInstance } from "axios";
 /**************************************************************
  * Types
  **************************************************************/
@@ -35,17 +35,19 @@ export interface IAuthentiationInfo {
     _id: string;
 }
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
-/**
- * Get the authentication info for the current token
- * @param client The Webflow client
- * @returns The authentication info
- */
-export declare function info(client: Client): Promise<import("axios").AxiosResponse<IAuthentiationInfo, any>>;
-/**
- * Get the authenticated user
- * @param client The Webflow client
- * @returns The authenticated user
- */
-export declare function user(client: Client): Promise<import("axios").AxiosResponse<IAuthenticatedUser, any>>;
+export declare class Meta {
+    /**
+     * Get the authentication info for the current token
+     * @param client The Axios client instance
+     * @returns The authentication info
+     */
+    static info(client: AxiosInstance): Promise<import("axios").AxiosResponse<IAuthentiationInfo, any>>;
+    /**
+     * Get the authenticated user
+     * @param client The Axios client instance
+     * @returns The authenticated user
+     */
+    static user(client: AxiosInstance): Promise<import("axios").AxiosResponse<IAuthenticatedUser, any>>;
+}

package/dist/api/meta.js

@@ -1,24 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.user = exports.info = void 0;
+exports.Meta = void 0;
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
-/**
- * Get the authentication info for the current token
- * @param client The Webflow client
- * @returns The authentication info
- */
-function info(client) {
-    return client.get("/info");
+class Meta {
+    /**
+     * Get the authentication info for the current token
+     * @param client The Axios client instance
+     * @returns The authentication info
+     */
+    static info(client) {
+        return client.get("/info");
+    }
+    /**
+     * Get the authenticated user
+     * @param client The Axios client instance
+     * @returns The authenticated user
+     */
+    static user(client) {
+        return client.get("/user");
+    }
 }
-exports.info = info;
-/**
- * Get the authenticated user
- * @param client The Webflow client
- * @returns The authenticated user
- */
-function user(client) {
-    return client.get("/user");
-}
-exports.user = user;
+exports.Meta = Meta;