webflow-api 1.3.1 → 2.0.0

package/dist/api/collection.d.ts

@@ -1,112 +0,0 @@
-import { AxiosInstance } from "axios";
-import { WebflowRecord } from "../core";
-import { Item } from ".";
-/**************************************************************
- * Types
- **************************************************************/
-export declare type CollectionFieldType = "Bool" | "Color" | "Date" | "ExtFileRef" | "Set" | "ImageRef" | "Set" | "ItemRef" | "ItemRefSet" | "Link" | "Number" | "Option" | "PlainText" | "RichText" | "Video" | "User" | string;
-export declare type CollectionField = {
-    id: string;
-    type: CollectionFieldType;
-    slug: string;
-    name: string;
-    required: boolean;
-    editable: boolean;
-    validations?: Record<string, any>;
-};
-/**************************************************************
- * Interfaces
- **************************************************************/
-export interface ICollection {
-    _id: string;
-    lastUpdated: string;
-    createdOn: string;
-    name: string;
-    slug: string;
-    singularName: string;
-    fields: CollectionField[];
-}
-/**************************************************************
- * Class
- **************************************************************/
-export declare class Collection extends WebflowRecord<ICollection> implements ICollection {
-    fields: CollectionField[];
-    singularName: string;
-    lastUpdated: string;
-    createdOn: string;
-    _id: string;
-    name: string;
-    slug: string;
-    /**************************************************************
-     * Static Methods
-     **************************************************************/
-    /**
-     * Get a list of Collections
-     * @param params The params for the request
-     * @param params.siteId The site ID
-     * @param client The Axios client instance
-     * @returns A list of Collections
-     */
-    static list({ siteId }: {
-        siteId: string;
-    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<ICollection[], any>>;
-    /**
-     * Get a single Collection
-     * @param params The params for the request
-     * @param params.collectionId The collection ID
-     * @param client The Axios client instance
-     * @returns A single Collection
-     */
-    static getOne({ collectionId }: {
-        collectionId: string;
-    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<ICollection, any>>;
-    /**************************************************************
-     * 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<Item>;
-    /**
-     * 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({ limit, offset }?: {
-        limit?: number;
-        offset?: number;
-    }): Promise<Item[]>;
-    /**
-     * 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("./item").IItemDelete>;
-    /**
-     * Create a new Item
-     * @param fields The Item fields to create
-     * @returns The created Item
-     */
-    createItem(fields: object): Promise<Item>;
-    /**
-     * 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: object;
-    }): Promise<Item>;
-}

package/dist/api/collection.js

@@ -1,94 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Collection = void 0;
-const core_1 = require("../core");
-const _1 = require(".");
-/**************************************************************
- * Class
- **************************************************************/
-class Collection extends core_1.WebflowRecord {
-    /**************************************************************
-     * Static Methods
-     **************************************************************/
-    /**
-     * Get a list of Collections
-     * @param params The params for the request
-     * @param params.siteId The site ID
-     * @param client The Axios client instance
-     * @returns A list of Collections
-     */
-    static list({ siteId }, client) {
-        (0, core_1.requireArgs)({ siteId });
-        const path = `/sites/${siteId}/collections`;
-        return client.get(path);
-    }
-    /**
-     * Get a single Collection
-     * @param params The params for the request
-     * @param params.collectionId The collection ID
-     * @param client The Axios client instance
-     * @returns A single Collection
-     */
-    static getOne({ collectionId }, client) {
-        (0, core_1.requireArgs)({ collectionId });
-        const path = `/collections/${collectionId}`;
-        return client.get(path);
-    }
-    /**************************************************************
-     * 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 }) {
-        const res = await _1.Item.getOne({ itemId, collectionId: this._id }, this.client);
-        const [item] = res.data.items.map((data) => new _1.Item(this.client, { ...res, data }));
-        return item;
-    }
-    /**
-     * 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({ limit, offset } = {}) {
-        const res = await _1.Item.list({ collectionId: this._id, limit, offset }, this.client);
-        return res.data.items.map((data) => new _1.Item(this.client, { ...res, data }));
-    }
-    /**
-     * 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 }) {
-        const res = await _1.Item.remove({ itemId, collectionId: this._id }, this.client);
-        return res.data;
-    }
-    /**
-     * Create a new Item
-     * @param fields The Item fields to create
-     * @returns The created Item
-     */
-    async createItem(fields) {
-        const res = await _1.Item.create({ collectionId: this._id, fields }, this.client);
-        return new _1.Item(this.client, res);
-    }
-    /**
-     * 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 }) {
-        const params = { itemId, collectionId: this._id, fields };
-        const res = await _1.Item.update(params, this.client);
-        return new _1.Item(this.client, res);
-    }
-}
-exports.Collection = Collection;

package/dist/api/item.d.ts

@@ -1,177 +0,0 @@
-import { AxiosInstance } from "axios";
-import { PaginatedData, WebflowRecord } from "../core";
-/**************************************************************
- * Interfaces
- **************************************************************/
-export interface IItem {
-    _archived: boolean;
-    _draft: boolean;
-    _id: string;
-    _cid: string;
-    name: string;
-    slug: string;
-    "updated-on": string;
-    "created-on": string;
-    "updated-by": string;
-    "created-by": string;
-    "published-on"?: string | null;
-    "published-by"?: string | null;
-}
-export interface IItemDelete {
-    deleted: number;
-}
-export interface IPublishItems {
-    publishedItemIds: string[];
-    errors: string[];
-}
-export interface IDeletedItems {
-    deletedItemIds: string[];
-    errors: string[];
-}
-/**************************************************************
- * Types
- **************************************************************/
-export declare type PaginatedItems = PaginatedData & {
-    items: IItem[];
-};
-/**************************************************************
- * Class
- **************************************************************/
-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<PaginatedItems, 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<PaginatedItems, 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>>;
-    /**
-     * Unpublish 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,151 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Item = void 0;
-const core_1 = require("../core");
-/**************************************************************
- * Class
- **************************************************************/
-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);
-    }
-    /**
-     * Unpublish 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.Item = Item;

package/dist/api/meta.d.ts

@@ -1,53 +0,0 @@
-import { AxiosInstance } from "axios";
-/**************************************************************
- * Types
- **************************************************************/
-export declare type InfoApplication = {
-    description: string;
-    ownerType: string;
-    homepage: string;
-    owner: string;
-    name: string;
-    _id: string;
-};
-/**************************************************************
- * Interfaces
- **************************************************************/
-export interface IAuthenticatedUser {
-    user: {
-        firstName: string;
-        lastName: string;
-        email: string;
-        _id: string;
-    };
-}
-export interface IAuthenticationInfo {
-    application: InfoApplication;
-    workspaces: string[];
-    rateLimit: number;
-    createdOn: string;
-    grantType: string;
-    lastUsed: string;
-    sites: string[];
-    users: string[];
-    orgs: string[];
-    status: string;
-    _id: string;
-}
-/**************************************************************
- * Class
- **************************************************************/
-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<IAuthenticationInfo, 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,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Meta = void 0;
-/**************************************************************
- * Class
- **************************************************************/
-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.Meta = Meta;

package/dist/api/oauth.d.ts

@@ -1,71 +0,0 @@
-import { AxiosInstance } from "axios";
-import { SupportedScope } from "../core";
-/**************************************************************
- * Interfaces
- **************************************************************/
-export interface IAuthorizeUrlParams {
-    state?: string;
-    scope?: string;
-    scopes?: SupportedScope[];
-    client_id: string;
-    redirect_uri?: string;
-    response_type?: string;
-}
-export interface IRevokeTokenParams {
-    client_secret: string;
-    access_token: string;
-    client_id: string;
-}
-export interface IAccessTokenParams {
-    code: string;
-    client_id: string;
-    grant_type?: string;
-    client_secret: string;
-    redirect_uri?: string;
-}
-export interface IAccessToken {
-    token_type: string;
-    access_token: string;
-}
-export interface IRevokeToken {
-    didRevoke: boolean;
-}
-/**************************************************************
- * Class
- **************************************************************/
-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, scopes }: 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>>;
-}