webflow-api 1.1.2 → 1.2.1

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;

package/dist/api/site.d.ts

@@ -1,4 +1,6 @@
-import { Client, QueryString } from "../core";
+import { AxiosInstance } from "axios";
+import { Webhook, Collection, WebhookFilter } from ".";
+import { WebflowRecord } from "../core";
 /**************************************************************
  * Interfaces
  *************************************************************/
@@ -20,46 +22,119 @@ export interface IPublishSite {
     queued: boolean;
 }
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
-/**
- * Get a list of Sites
- * @param client The Webflow client
- * @param params The query string parameters (optional)
- * @returns
- */
-export declare function list(client: Client, params?: QueryString): Promise<import("axios").AxiosResponse<ISite[], any>>;
-/**
- * Get a single Site
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.siteId The site ID
- * @param params.params The query string parameters (optional)
- * @returns A single Site
- */
-export declare function getOne(client: Client, { siteId, params }: {
-    siteId: string;
-    params?: QueryString;
-}): Promise<import("axios").AxiosResponse<ISite, any>>;
-/**
- * Publish a site
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.siteId The site ID
- * @param params.domains The domains to publish to
- * @returns The publish result
- */
-export declare function publish(client: Client, { siteId, domains }: {
-    siteId: string;
-    domains: string[];
-}): Promise<import("axios").AxiosResponse<IPublishSite, any>>;
-/**
- * Get a list of domains for a site
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.siteId The site ID
- * @returns A list of domains
- */
-export declare function domains(client: Client, { siteId }: {
-    siteId: string;
-}): Promise<import("axios").AxiosResponse<IDomain[], any>>;
+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,59 +1,137 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.domains = exports.publish = exports.getOne = exports.list = void 0;
+exports.Site = void 0;
+const _1 = require(".");
 const core_1 = require("../core");
 /**************************************************************
- * Functions
+ * Class
  **************************************************************/
-/**
- * Get a list of Sites
- * @param client The Webflow client
- * @param params The query string parameters (optional)
- * @returns
- */
-function list(client, params) {
-    const path = "/sites";
-    return client.get(path, { params });
+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.list = list;
-/**
- * Get a single Site
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.siteId The site ID
- * @param params.params The query string parameters (optional)
- * @returns A single Site
- */
-function getOne(client, { siteId, params }) {
-    (0, core_1.requireArgs)({ siteId });
-    const path = `/sites/${siteId}`;
-    return client.get(path, { params });
-}
-exports.getOne = getOne;
-/**
- * Publish a site
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.siteId The site ID
- * @param params.domains The domains to publish to
- * @returns The publish result
- */
-function publish(client, { siteId, domains }) {
-    (0, core_1.requireArgs)({ siteId, domains });
-    const path = `/sites/${siteId}/publish`;
-    return client.post(path, { domains });
-}
-exports.publish = publish;
-/**
- * Get a list of domains for a site
- * @param client The Webflow client
- * @param params The params for the request
- * @param params.siteId The site ID
- * @returns A list of domains
- */
-function domains(client, { siteId }) {
-    (0, core_1.requireArgs)({ siteId });
-    const path = `/sites/${siteId}/domains`;
-    return client.get(path);
-}
-exports.domains = domains;
+exports.Site = Site;