webflow-api 1.1.1 → 1.2.0

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;

package/dist/api/oauth.d.ts

@@ -1,4 +1,4 @@
-import { Client } from "../core";
+import { AxiosInstance } from "axios";
 /**************************************************************
  * Interfaces
  **************************************************************/
@@ -29,39 +29,41 @@ export interface IRevokeToken {
     didRevoke: boolean;
 }
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
-/**
- * Get the URL to authorize a user
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.client_id The OAuth client ID
- * @param params.scope The scope (optional)
- * @param params.state The state (optional)
- * @param params.redirect_uri The redirect URI (optional)
- * @param params.response_type The response type (default: code)
- * @returns The URL to authorize a user
- */
-export declare function authorizeUrl(client: Client, { response_type, redirect_uri, client_id, state, scope, }: IAuthorizeUrlParams): string;
-/**
- * Get an access token
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.code The OAuth code
- * @param params.client_id The OAuth client ID
- * @param params.client_secret The OAuth client secret
- * @param params.redirect_uri The redirect URI (optional)
- * @param params.grant_type The grant type (default: "authorization_code")
- * @returns An access token
- */
-export declare function accessToken(client: Client, { grant_type, client_secret, redirect_uri, client_id, code, }: IAccessTokenParams): Promise<import("axios").AxiosResponse<IAccessToken, any>>;
-/**
- * Revoke an access token
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.client_id The OAuth client ID
- * @param params.client_secret The OAuth client secret
- * @param params.access_token The OAuth access token
- * @returns The result of the revoke
- */
-export declare function revokeToken(client: Client, { client_secret, access_token, client_id }: IRevokeTokenParams): Promise<import("axios").AxiosResponse<IRevokeToken, any>>;
+export declare class OAuth {
+    /**
+     * Get the URL to authorize a user
+     * @param params The params for the request
+     * @param params.client_id The OAuth client ID
+     * @param params.scope The scope (optional)
+     * @param params.state The state (optional)
+     * @param params.redirect_uri The redirect URI (optional)
+     * @param params.response_type The response type (default: code)
+     * @param client The Axios client instance
+     * @returns The URL to authorize a user
+     */
+    static authorizeUrl({ response_type, redirect_uri, client_id, state, scope }: IAuthorizeUrlParams, client: AxiosInstance): string;
+    /**
+     * Get an access token
+     * @param params The params for the request
+     * @param params.code The OAuth code
+     * @param params.client_id The OAuth client ID
+     * @param params.client_secret The OAuth client secret
+     * @param params.redirect_uri The redirect URI (optional)
+     * @param params.grant_type The grant type (default: "authorization_code")
+     * @param client The Axios client instance
+     * @returns An access token
+     */
+    static accessToken({ grant_type, client_secret, redirect_uri, client_id, code }: IAccessTokenParams, client: AxiosInstance): Promise<import("axios").AxiosResponse<IAccessToken, any>>;
+    /**
+     * Revoke an access token
+     * @param params The params for the request
+     * @param params.client_id The OAuth client ID
+     * @param params.client_secret The OAuth client secret
+     * @param params.access_token The OAuth access token
+     * @param client The Axios client instance
+     * @returns The result of the revoke
+     */
+    static revokeToken({ client_secret, access_token, client_id }: IRevokeTokenParams, client: AxiosInstance): Promise<import("axios").AxiosResponse<IRevokeToken, any>>;
+}

package/dist/api/oauth.js

@@ -1,65 +1,65 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.revokeToken = exports.accessToken = exports.authorizeUrl = void 0;
+exports.OAuth = void 0;
 const core_1 = require("../core");
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
-/**
- * Get the URL to authorize a user
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.client_id The OAuth client ID
- * @param params.scope The scope (optional)
- * @param params.state The state (optional)
- * @param params.redirect_uri The redirect URI (optional)
- * @param params.response_type The response type (default: code)
- * @returns The URL to authorize a user
- */
-function authorizeUrl(client, { response_type = "code", redirect_uri, client_id, state, scope, }) {
-    (0, core_1.requireArgs)({ client_id });
-    const params = { response_type, client_id };
-    if (redirect_uri)
-        params["redirect_uri"] = redirect_uri;
-    if (state)
-        params["state"] = state;
-    if (scope)
-        params["scope"] = scope;
-    const url = "/oauth/authorize";
-    return client.getUri({ url, method: "GET", params });
+class OAuth {
+    /**
+     * Get the URL to authorize a user
+     * @param params The params for the request
+     * @param params.client_id The OAuth client ID
+     * @param params.scope The scope (optional)
+     * @param params.state The state (optional)
+     * @param params.redirect_uri The redirect URI (optional)
+     * @param params.response_type The response type (default: code)
+     * @param client The Axios client instance
+     * @returns The URL to authorize a user
+     */
+    static authorizeUrl({ response_type = "code", redirect_uri, client_id, state, scope }, client) {
+        (0, core_1.requireArgs)({ client_id });
+        const params = { response_type, client_id };
+        if (redirect_uri)
+            params["redirect_uri"] = redirect_uri;
+        if (state)
+            params["state"] = state;
+        if (scope)
+            params["scope"] = scope;
+        const url = "/oauth/authorize";
+        return client.getUri({ url, method: "GET", params });
+    }
+    /**
+     * Get an access token
+     * @param params The params for the request
+     * @param params.code The OAuth code
+     * @param params.client_id The OAuth client ID
+     * @param params.client_secret The OAuth client secret
+     * @param params.redirect_uri The redirect URI (optional)
+     * @param params.grant_type The grant type (default: "authorization_code")
+     * @param client The Axios client instance
+     * @returns An access token
+     */
+    static accessToken({ grant_type = "authorization_code", client_secret, redirect_uri, client_id, code }, client) {
+        (0, core_1.requireArgs)({ client_id, client_secret, code });
+        const path = "/oauth/access_token";
+        const data = { client_secret, redirect_uri, grant_type, client_id, code };
+        return client.post(path, data);
+    }
+    /**
+     * Revoke an access token
+     * @param params The params for the request
+     * @param params.client_id The OAuth client ID
+     * @param params.client_secret The OAuth client secret
+     * @param params.access_token The OAuth access token
+     * @param client The Axios client instance
+     * @returns The result of the revoke
+     */
+    static revokeToken({ client_secret, access_token, client_id }, client) {
+        (0, core_1.requireArgs)({ client_id, client_secret, access_token });
+        const path = "/oauth/revoke_authorization";
+        const data = { client_secret, access_token, client_id };
+        return client.post(path, data);
+    }
 }
-exports.authorizeUrl = authorizeUrl;
-/**
- * Get an access token
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.code The OAuth code
- * @param params.client_id The OAuth client ID
- * @param params.client_secret The OAuth client secret
- * @param params.redirect_uri The redirect URI (optional)
- * @param params.grant_type The grant type (default: "authorization_code")
- * @returns An access token
- */
-function accessToken(client, { grant_type = "authorization_code", client_secret, redirect_uri, client_id, code, }) {
-    (0, core_1.requireArgs)({ client_id, client_secret, code });
-    const path = "/oauth/access_token";
-    const data = { client_secret, redirect_uri, grant_type, client_id, code };
-    return client.post(path, data);
-}
-exports.accessToken = accessToken;
-/**
- * Revoke an access token
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.client_id The OAuth client ID
- * @param params.client_secret The OAuth client secret
- * @param params.access_token The OAuth access token
- * @returns The result of the revoke
- */
-function revokeToken(client, { client_secret, access_token, client_id }) {
-    (0, core_1.requireArgs)({ client_id, client_secret, access_token });
-    const path = "/oauth/revoke_authorization";
-    const data = { client_secret, access_token, client_id };
-    return client.post(path, data);
-}
-exports.revokeToken = revokeToken;
+exports.OAuth = OAuth;