webflow-api 1.3.1 → 2.0.0

package/dist/api/oauth.js

@@ -1,71 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.OAuth = void 0;
-const core_1 = require("../core");
-/**************************************************************
- * Class
- **************************************************************/
-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, scopes }, client) {
-        (0, core_1.requireArgs)({ client_id });
-        if (scope && scopes) {
-            throw new Error("Please provide either 'scope' or 'scopes', but not both.");
-        }
-        const params = { response_type, client_id };
-        if (redirect_uri)
-            params["redirect_uri"] = redirect_uri;
-        if (state)
-            params["state"] = state;
-        if (scope)
-            params["scope"] = scope;
-        if (scopes && scopes.length > 0)
-            params["scope"] = scopes.join("+");
-        const url = "/oauth/authorize";
-        const baseURL = client.defaults.baseURL.replace("api.", "");
-        return client.getUri({ baseURL, 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.OAuth = OAuth;

package/dist/api/site.d.ts

@@ -1,140 +0,0 @@
-import { AxiosInstance } from "axios";
-import { Webhook, Collection, WebhookFilter } from ".";
-import { WebflowRecord } from "../core";
-/**************************************************************
- * Interfaces
- *************************************************************/
-export interface IDomain {
-    _id: string;
-    name: string;
-}
-export interface ISite {
-    lastPublished: string;
-    previewUrl: string;
-    createdOn: string;
-    shortName: string;
-    timezone: string;
-    database: string;
-    name: string;
-    _id: string;
-}
-export interface IPublishSite {
-    queued: boolean;
-}
-/**************************************************************
- * Class
- **************************************************************/
-export declare class Site extends WebflowRecord<ISite> implements ISite {
-    lastPublished: string;
-    previewUrl: string;
-    createdOn: string;
-    shortName: string;
-    timezone: string;
-    database: string;
-    name: string;
-    _id: string;
-    /**
-     * Get a list of Sites
-     * @param client The Axios client instance
-     * @returns a list of Sites
-     */
-    static list(client: AxiosInstance): Promise<import("axios").AxiosResponse<ISite[], any>>;
-    /**
-     * Get a single Site
-     * @param params The params for the request
-     * @param params.siteId The site ID
-     * @param params.params The query string parameters (optional)
-     * @param client The Axios client instance
-     * @returns A single Site
-     */
-    static getOne({ siteId }: {
-        siteId: string;
-    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<ISite, any>>;
-    /**
-     * Publish a site
-     * @param params The params for the request
-     * @param params.siteId The site ID
-     * @param params.domains The domains to publish to
-     * @param client The Axios client instance
-     * @returns The publish result
-     */
-    static publish({ siteId, domains }: {
-        siteId: string;
-        domains: string[];
-    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IPublishSite, any>>;
-    /**
-     * Get a list of domains for a site
-     * @param params The params for the request
-     * @param params.siteId The site ID
-     * @param client The Axios client instance
-     * @returns A list of domains
-     */
-    static domains({ siteId }: {
-        siteId: string;
-    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IDomain[], any>>;
-    /**************************************************************
-     * Instance Methods
-     **************************************************************/
-    /**
-     * Get a list of domains for a site
-     * @returns A list of domains
-     */
-    domains(): Promise<IDomain[]>;
-    /**
-     * Publish a site
-     * @param domains The domains to publish to
-     * @returns The publish result
-     */
-    publishSite(domains: string[]): Promise<IPublishSite>;
-    /**
-     * Get a single Collection
-     * @param params The params for the request
-     * @param params.collectionId The collection ID
-     * @returns A single Collection
-     */
-    collection({ collectionId }: {
-        collectionId: string;
-    }): Promise<Collection>;
-    /**
-     * Get a list of Collections
-     * @returns A list of Collections
-     */
-    collections(): Promise<Collection[]>;
-    /**
-     * Get a single Webhook
-     * @param params The params for the request
-     * @param params.webhookId The webhook ID
-     * @returns A single Webhook
-     */
-    webhook({ webhookId }: {
-        webhookId: string;
-    }): Promise<Webhook>;
-    /**
-     * Get a list of Webhooks
-     * @returns A list of Webhooks
-     */
-    webhooks(): Promise<Webhook[]>;
-    /**
-     * Remove a Webhook
-     * @param params The query string parameters (optional)
-     * @param params.webhookId The Webhook ID
-     * @returns The result of the removal
-     */
-    removeWebhook({ webhookId }: {
-        webhookId: string;
-    }): Promise<import("./webhook").IRemoveResult>;
-    /**
-     * Create a new Webhook
-     * @param params The params for the request
-     * @param params.url The URL to send the webhook to
-     * @param params.triggerType The event to trigger the webhook
-     * @param params.filter The filter to apply to the webhook (optional: form_submission only)
-     * @returns The created webhook
-     */
-    createWebhook({ triggerType, filter, url, }: {
-        url: string;
-        siteId: string;
-        triggerType: string;
-        filter?: WebhookFilter;
-    }): Promise<Webhook>;
-}

package/dist/api/site.js

@@ -1,137 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Site = void 0;
-const _1 = require(".");
-const core_1 = require("../core");
-/**************************************************************
- * Class
- **************************************************************/
-class Site extends core_1.WebflowRecord {
-    /**
-     * Get a list of Sites
-     * @param client The Axios client instance
-     * @returns a list of Sites
-     */
-    static list(client) {
-        const path = "/sites";
-        return client.get(path);
-    }
-    /**
-     * Get a single Site
-     * @param params The params for the request
-     * @param params.siteId The site ID
-     * @param params.params The query string parameters (optional)
-     * @param client The Axios client instance
-     * @returns A single Site
-     */
-    static getOne({ siteId }, client) {
-        (0, core_1.requireArgs)({ siteId });
-        const path = `/sites/${siteId}`;
-        return client.get(path);
-    }
-    /**
-     * Publish a site
-     * @param params The params for the request
-     * @param params.siteId The site ID
-     * @param params.domains The domains to publish to
-     * @param client The Axios client instance
-     * @returns The publish result
-     */
-    static publish({ siteId, domains }, client) {
-        (0, core_1.requireArgs)({ siteId, domains });
-        const path = `/sites/${siteId}/publish`;
-        return client.post(path, { domains });
-    }
-    /**
-     * Get a list of domains for a site
-     * @param params The params for the request
-     * @param params.siteId The site ID
-     * @param client The Axios client instance
-     * @returns A list of domains
-     */
-    static domains({ siteId }, client) {
-        (0, core_1.requireArgs)({ siteId });
-        const path = `/sites/${siteId}/domains`;
-        return client.get(path);
-    }
-    /**************************************************************
-     * Instance Methods
-     **************************************************************/
-    /**
-     * Get a list of domains for a site
-     * @returns A list of domains
-     */
-    async domains() {
-        const res = await Site.domains({ siteId: this._id }, this.client);
-        return res.data;
-    }
-    /**
-     * Publish a site
-     * @param domains The domains to publish to
-     * @returns The publish result
-     */
-    async publishSite(domains) {
-        const res = await Site.publish({ siteId: this._id, domains }, this.client);
-        return res.data;
-    }
-    /**
-     * Get a single Collection
-     * @param params The params for the request
-     * @param params.collectionId The collection ID
-     * @returns A single Collection
-     */
-    async collection({ collectionId }) {
-        const res = await _1.Collection.getOne({ collectionId }, this.client);
-        return new _1.Collection(this.client, res);
-    }
-    /**
-     * Get a list of Collections
-     * @returns A list of Collections
-     */
-    async collections() {
-        const res = await _1.Collection.list({ siteId: this._id }, this.client);
-        return res.data.map((data) => new _1.Collection(this.client, { ...res, data }));
-    }
-    /**
-     * Get a single Webhook
-     * @param params The params for the request
-     * @param params.webhookId The webhook ID
-     * @returns A single Webhook
-     */
-    async webhook({ webhookId }) {
-        const res = await _1.Webhook.getOne({ siteId: this._id, webhookId }, this.client);
-        return new _1.Webhook(this.client, res);
-    }
-    /**
-     * Get a list of Webhooks
-     * @returns A list of Webhooks
-     */
-    async webhooks() {
-        const res = await _1.Webhook.list({ siteId: this._id }, this.client);
-        return res.data.map((data) => new _1.Webhook(this.client, { ...res, data }));
-    }
-    /**
-     * Remove a Webhook
-     * @param params The query string parameters (optional)
-     * @param params.webhookId The Webhook ID
-     * @returns The result of the removal
-     */
-    async removeWebhook({ webhookId }) {
-        const res = await _1.Webhook.remove({ siteId: this._id, webhookId }, this.client);
-        return res.data;
-    }
-    /**
-     * Create a new Webhook
-     * @param params The params for the request
-     * @param params.url The URL to send the webhook to
-     * @param params.triggerType The event to trigger the webhook
-     * @param params.filter The filter to apply to the webhook (optional: form_submission only)
-     * @returns The created webhook
-     */
-    async createWebhook({ triggerType, filter, url, }) {
-        const _params = { url, siteId: this._id, triggerType, filter };
-        const res = await _1.Webhook.create(_params, this.client);
-        return new _1.Webhook(this.client, res);
-    }
-}
-exports.Site = Site;

package/dist/api/user.d.ts

@@ -1,143 +0,0 @@
-import { AxiosInstance } from "axios";
-import { PaginatedData, WebflowRecord } from "../core";
-/**************************************************************
- * Interfaces
- **************************************************************/
-export interface IUser {
-    emailVerified: boolean;
-    lastUpdated?: string;
-    createdOn: string;
-    _id: string;
-    data: any;
-}
-export interface IAcessGroup {
-    _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: IAcessGroup[];
-};
-export declare type UserIdParam = {
-    siteId: string;
-    userId: string;
-};
-/**************************************************************
- * Class
- **************************************************************/
-export declare class User extends WebflowRecord<IUser> implements IUser {
-    emailVerified: boolean;
-    lastUpdated?: string;
-    createdOn: string;
-    siteId: string;
-    _id: string;
-    data: any;
-    /**************************************************************
-     * Static Methods
-     **************************************************************/
-    /**
-     * Get a list of Users
-     * @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)
-     * @param client The Axios client instance
-     * @returns A list of Users
-     */
-    static list({ siteId, limit, offset }: {
-        siteId: string;
-        limit?: number;
-        offset?: number;
-    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<PaginatedUsers, any>>;
-    /**
-     * Get a single User
-     * @param params The params for the request
-     * @param params.siteId The site ID
-     * @param params.userId The user ID
-     * @param client The Axios client instance
-     * @returns A single User
-     */
-    static getOne({ siteId, userId }: {
-        siteId: string;
-        userId: string;
-    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IUser, any>>;
-    /**
-     * Update a User
-     * @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
-     * @param client The Axios client instance
-     * @returns The updated User
-     */
-    static update({ siteId, userId, data, }: {
-        data: object;
-        siteId: string;
-        userId: string;
-    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IUser, any>>;
-    /**
-     * Invite a User to a site
-     * @param params The params for the request
-     * @param params.siteId The site ID
-     * @param params.email The email address of the user to invite
-     * @param client The Axios client instance
-     * @returns The newly created User
-     */
-    static invite({ siteId, email }: {
-        siteId: string;
-        email: string;
-    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IUser, any>>;
-    /**
-     * Remove a User
-     * @param params The params for the request
-     * @param params.siteId The site ID
-     * @param params.userId The user ID
-     * @param client The Axios client instance
-     * @returns The result of the remove
-     */
-    static remove({ siteId, userId }: {
-        siteId: string;
-        userId: string;
-    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<IUserDelete, any>>;
-    /**
-     * Get a list of User Access Groups
-     * @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)
-     * @param params.sort The sort order of the groups (optional)
-     * @param client The Axios client instance
-     * @returns A list of Access Groups
-     */
-    static accessGroups({ siteId, limit, offset, sort, }: {
-        siteId: string;
-        limit?: number;
-        offset?: number;
-        sort?: string;
-    }, client: AxiosInstance): Promise<import("axios").AxiosResponse<PaginatedAccessGroups, any>>;
-    /**************************************************************
-     * Instance Methods
-     **************************************************************/
-    /**
-     * Update a User
-     * @param data The data to update
-     * @returns The updated User
-     */
-    update(data: any): Promise<User>;
-    /**
-     * Remove a User
-     * @returns The result of the remove
-     */
-    remove(): Promise<IUserDelete>;
-}

package/dist/api/user.js

@@ -1,119 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.User = void 0;
-const core_1 = require("../core");
-/**************************************************************
- * Class
- **************************************************************/
-class User extends core_1.WebflowRecord {
-    /**************************************************************
-     * Static Methods
-     **************************************************************/
-    /**
-     * Get a list of Users
-     * @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)
-     * @param client The Axios client instance
-     * @returns A list of Users
-     */
-    static list({ siteId, limit, offset }, client) {
-        (0, core_1.requireArgs)({ siteId });
-        const params = { limit, offset };
-        const path = `/sites/${siteId}/users`;
-        return client.get(path, { params });
-    }
-    /**
-     * Get a single User
-     * @param params The params for the request
-     * @param params.siteId The site ID
-     * @param params.userId The user ID
-     * @param client The Axios client instance
-     * @returns A single User
-     */
-    static getOne({ siteId, userId }, client) {
-        (0, core_1.requireArgs)({ siteId, userId });
-        const path = `/sites/${siteId}/users/${userId}`;
-        return client.get(path);
-    }
-    /**
-     * Update a User
-     * @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
-     * @param client The Axios client instance
-     * @returns The updated User
-     */
-    static update({ siteId, userId, data, }, client) {
-        (0, core_1.requireArgs)({ siteId, userId });
-        const path = `/sites/${siteId}/users/${userId}`;
-        return client.patch(path, data);
-    }
-    /**
-     * Invite a User to a site
-     * @param params The params for the request
-     * @param params.siteId The site ID
-     * @param params.email The email address of the user to invite
-     * @param client The Axios client instance
-     * @returns The newly created User
-     */
-    static async invite({ siteId, email }, client) {
-        (0, core_1.requireArgs)({ siteId, email });
-        const path = `/sites/${siteId}/users/invite`;
-        return client.post(path, { email });
-    }
-    /**
-     * Remove a User
-     * @param params The params for the request
-     * @param params.siteId The site ID
-     * @param params.userId The user ID
-     * @param client The Axios client instance
-     * @returns The result of the remove
-     */
-    static remove({ siteId, userId }, client) {
-        (0, core_1.requireArgs)({ siteId, userId });
-        const path = `/sites/${siteId}/users/${userId}`;
-        return client.delete(path);
-    }
-    /**
-     * Get a list of User Access Groups
-     * @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)
-     * @param params.sort The sort order of the groups (optional)
-     * @param client The Axios client instance
-     * @returns A list of Access Groups
-     */
-    static accessGroups({ siteId, limit, offset, sort, }, client) {
-        (0, core_1.requireArgs)({ siteId });
-        const params = { limit, offset, sort };
-        const path = `/sites/${siteId}/accessgroups`;
-        return client.get(path, { params });
-    }
-    /**************************************************************
-     * Instance Methods
-     **************************************************************/
-    /**
-     * Update a User
-     * @param data The data to update
-     * @returns The updated User
-     */
-    async update(data) {
-        const params = { siteId: this.siteId, userId: this._id, data };
-        const res = await User.update(params, this.client);
-        return new User(this.client, res);
-    }
-    /**
-     * Remove a User
-     * @returns The result of the remove
-     */
-    async remove() {
-        const params = { siteId: this.siteId, userId: this._id };
-        const res = await User.remove(params, this.client);
-        return res.data;
-    }
-}
-exports.User = User;