webflow-api 1.1.1 → 1.2.0

package/dist/{webflow.d.ts → core/webflow.d.ts}

@@ -1,15 +1,24 @@
-import { QueryString, Options, Client, PaginationFilter } from "./core";
-import { Meta, OAuth, Webhook } from "./api";
-import { MembershipWrapper, CollectionWrapper, WebhookWrapper, SiteWrapper, ItemWrapper } from "./wrapper";
+import { AxiosRequestConfig } from "axios";
+import { PaginationFilter } from "../core";
+import { Collection, IAccessTokenParams, IAuthorizeUrlParams, IRevokeTokenParams, User, Site, Webhook, WebhookFilter, Item } from "../api";
+export declare const DEFAULT_HOST = "webflow.com";
+export declare const USER_AGENT = "Webflow Javascript SDK / 1.0";
+export interface Options {
+    host?: string;
+    token?: string;
+    version?: string;
+    headers?: Record<string, string>;
+}
 /**************************************************************
  * Class
  **************************************************************/
 export declare class Webflow {
     options: Options;
-    client: Client;
+    private client;
     constructor(options?: Options);
     set token(value: string);
     clearToken(): void;
+    get config(): AxiosRequestConfig<any>;
     /**************************************************************
      * HTTP Methods
      **************************************************************/
@@ -19,14 +28,14 @@ export declare class Webflow {
      * @param params The query parameters (optional)
      * @returns The response from the Webflow API
      */
-    get(path: string, params?: QueryString): Promise<import("axios").AxiosResponse<any, any>>;
+    get(path: string, params?: Record<string, any>): Promise<import("axios").AxiosResponse<any, any>>;
     /**
      * Send a DELETE request to the Webflow API
      * @param path The path to the endpoint
      * @param params The query parameters (optional)
      * @returns The response from the Webflow API
      */
-    delete(path: string, params?: QueryString): Promise<import("axios").AxiosResponse<any, any>>;
+    delete(path: string, params?: Record<string, any>): Promise<import("axios").AxiosResponse<any, any>>;
     /**
      * Send a POST request to create a new Collection
      * @param path The path to the endpoint
@@ -34,7 +43,7 @@ export declare class Webflow {
      * @param params The query parameters (optional)
      * @returns The response from the Webflow API
      */
-    post(path: string, data: any, params?: QueryString): Promise<import("axios").AxiosResponse<any, any>>;
+    post(path: string, data: any, params?: Record<string, any>): Promise<import("axios").AxiosResponse<any, any>>;
     /**
      * Send a PUT request to create a new Collection
      * @param path The path to the endpoint
@@ -42,7 +51,7 @@ export declare class Webflow {
      * @param params The query parameters (optional)
      * @returns The response from the Webflow API
      */
-    put(path: string, data: any, params?: QueryString): Promise<import("axios").AxiosResponse<any, any>>;
+    put(path: string, data: any, params?: Record<string, any>): Promise<import("axios").AxiosResponse<any, any>>;
     /**
      * Send a PATCH request to create a new Collection
      * @param path The path to the endpoint
@@ -50,7 +59,7 @@ export declare class Webflow {
      * @param params The query parameters (optional)
      * @returns The response from the Webflow API
      */
-    patch(path: string, data: any, params?: QueryString): Promise<import("axios").AxiosResponse<any, any>>;
+    patch(path: string, data: any, params?: Record<string, any>): Promise<import("axios").AxiosResponse<any, any>>;
     /**************************************************************
      * OAuth Endpoints
      **************************************************************/
@@ -64,7 +73,7 @@ export declare class Webflow {
      * @param params.response_type The response_type parameter (default: "code")
      * @returns The url to redirect to
      */
-    authorizeUrl(params: OAuth.IAuthorizeUrlParams): string;
+    authorizeUrl(params: IAuthorizeUrlParams): string;
     /**
      * Create an OAuth Access Token
      * @param params The OAuth information
@@ -75,7 +84,7 @@ export declare class Webflow {
      * @param params.grant_type The grant_type parameter (default: "authorization_code")
      * @returns The access token
      */
-    accessToken(params: OAuth.IAccessTokenParams): Promise<import("./wrapper").MetaResponse<OAuth.IAccessToken>>;
+    accessToken(params: IAccessTokenParams): Promise<import("../api").IAccessToken>;
     /**
      * Revoke an OAuth Access Token
      * @param params The access token information
@@ -84,7 +93,7 @@ export declare class Webflow {
      * @param params.client_secret The client_secret parameter
      * @returns The result of the revoked token
      */
-    revokeToken(params: OAuth.IRevokeTokenParams): Promise<import("./wrapper").MetaResponse<OAuth.IRevokeToken>>;
+    revokeToken(params: IRevokeTokenParams): Promise<import("../api").IRevokeToken>;
     /**************************************************************
      * Meta Endpoints
      **************************************************************/
@@ -92,21 +101,20 @@ export declare class Webflow {
      * Get the current authorization information
      * @returns The authorization information
      */
-    info(): Promise<import("./wrapper").MetaResponse<Meta.IAuthentiationInfo>>;
+    info(): Promise<import("../api").IAuthentiationInfo>;
     /**
      * Get the current authenticated user
      * @returns The current authenticated user
      */
-    authenticatedUser(): Promise<import("./wrapper").MetaResponse<Meta.IAuthenticatedUser>>;
+    authenticatedUser(): Promise<import("../api").IAuthenticatedUser>;
     /**************************************************************
      * Site Endpoints
      **************************************************************/
     /**
      * Get a list of Sites available
-     * @param query The query parameters (optional)
      * @returns A list of Sites
      */
-    sites(query?: QueryString): Promise<import("./wrapper").MetaResponse<SiteWrapper[]>>;
+    sites(): Promise<Site[]>;
     /**
      * Get a single Site
      * @param params The Site information
@@ -115,7 +123,7 @@ export declare class Webflow {
      */
     site({ siteId }: {
         siteId: string;
-    }): Promise<import("./wrapper").MetaResponse<SiteWrapper>>;
+    }): Promise<Site>;
     /**
      * Publish a Site
      * @param params The Site information
@@ -127,7 +135,7 @@ export declare class Webflow {
         siteId: string;
     } & {
         domains: string[];
-    }): Promise<import("./wrapper").MetaResponse<import("./api/site").IPublishSite>>;
+    }): Promise<import("../api").IPublishSite>;
     /**
      * Get a list of Domains for a Site
      * @param params The Site information
@@ -136,7 +144,7 @@ export declare class Webflow {
      */
     domains({ siteId }: {
         siteId: string;
-    }): Promise<import("./wrapper").MetaResponse<import("./api/site").IDomain[]>>;
+    }): Promise<import("../api").IDomain[]>;
     /**************************************************************
      * Collection Endpoints
      **************************************************************/
@@ -144,12 +152,11 @@ export declare class Webflow {
      * Get a list of Collections
      * @param params The Site information
      * @param params.siteId The Site ID
-     * @param query The query parameters (optional)
      * @returns A list of Collections
      */
     collections({ siteId }: {
         siteId: string;
-    }, query?: QueryString): Promise<import("./wrapper").MetaResponse<CollectionWrapper[]>>;
+    }): Promise<Collection[]>;
     /**
      * Get a single Collection
      * @param params The Collection information
@@ -158,7 +165,7 @@ export declare class Webflow {
      */
     collection({ collectionId }: {
         collectionId: string;
-    }): Promise<import("./wrapper").MetaResponse<CollectionWrapper>>;
+    }): Promise<Collection>;
     /**************************************************************
      * Item Endpoints
      **************************************************************/
@@ -166,12 +173,13 @@ export declare class Webflow {
      * Get a list of Collection Items
      * @param params The Collection information
      * @param params.collectionId The Collection ID
-     * @param pageParams The pagination parameters (optional)
+     * @param params.limit The number of items to return
+     * @param params.offset The number of items to skip
      * @returns A list of Items
      */
-    items({ collectionId }: {
+    items({ collectionId, limit, offset }: {
         collectionId: string;
-    }, pageParams?: PaginationFilter): Promise<import("./wrapper").MetaResponse<ItemWrapper[]>>;
+    } & PaginationFilter): Promise<Item[]>;
     /**
      * Get a single Collection Item
      * @param params The Item information
@@ -179,20 +187,20 @@ export declare class Webflow {
      * @param params.itemId The Item ID
      * @returns A single Collection Item
      */
-    item({ itemId, collectionId, }: {
+    item({ itemId, collectionId }: {
         itemId: string;
         collectionId: string;
-    }): Promise<import("./wrapper").MetaResponse<ItemWrapper>>;
+    }): Promise<Item>;
     /**
      * Create a new Collection Item
      * @param params The Item information
      * @param params.collectionId The Collection ID
      * @returns The created Collection Item
      */
-    createItem({ collectionId, fields, }: {
+    createItem({ collectionId, fields }: {
         collectionId: string;
         fields: any;
-    }): Promise<import("./wrapper").MetaResponse<ItemWrapper>>;
+    }): Promise<Item>;
     /**
      * Update a Collection Item
      * @param params The Item information
@@ -204,19 +212,18 @@ export declare class Webflow {
     updateItem({ collectionId, itemId, ...fields }: {
         itemId: string;
         collectionId: string;
-    }): Promise<import("./wrapper").MetaResponse<ItemWrapper>>;
+    }): Promise<Item>;
     /**
      * Patch a Collection Item
      * @param params The Item information
      * @param params.collectionId The Collection ID
      * @param params.itemId The Item ID
-     * @param query The query parameters (optional)
      * @returns The patched Collection Item
      */
     patchItem({ collectionId, itemId, ...fields }: {
         collectionId: string;
         itemId: string;
-    }, query?: QueryString): Promise<import("./wrapper").MetaResponse<ItemWrapper>>;
+    }): Promise<Item>;
     /**
      * Delete a Collection Item
      * @param params The Item information
@@ -224,38 +231,36 @@ export declare class Webflow {
      * @param params.itemId The Item ID
      * @returns The deleted Collection Item result
      */
-    removeItem({ collectionId, itemId, }: {
+    removeItem({ collectionId, itemId }: {
         itemId: string;
         collectionId: string;
-    }): Promise<import("./wrapper").MetaResponse<import("./api/item").IItemDelete>>;
+    }): Promise<import("../api").IItemDelete>;
     /**
      * Upublish a Collection Item
      * @param params The Item information
      * @param params.collectionId The Collection ID
      * @param params.itemId The Item ID
-     * @param query The query parameters (optional)
-     * @param query.live Update the live version
+     * @param params.live Update the live version
      * @returns The unpublished Collection Item result
      */
-    deleteItems({ collectionId, itemIds, live, }: {
+    deleteItems({ collectionId, itemIds, live }: {
         collectionId: string;
         itemIds: string[];
         live?: boolean;
-    }): Promise<import("./wrapper").MetaResponse<import("./api/item").IDeletedItems>>;
+    }): Promise<import("../api").IDeletedItems>;
     /**
      * Publish a Collection Item
      * @param params The Item information
      * @param params.collectionId The Collection ID
      * @param params.itemId The Item ID
-     * @param query The query parameters (optional)
-     * @param query.live Update the live version
+     * @param params.live Update the live version
      * @returns The Published Collection Item result
      */
-    publishItems({ collectionId, itemIds, live, }: {
+    publishItems({ collectionId, itemIds, live }: {
         collectionId: string;
         itemIds: string[];
         live?: boolean;
-    }): Promise<import("./wrapper").MetaResponse<import("./api/item").IPublishItems>>;
+    }): Promise<import("../api").IPublishItems>;
     /**************************************************************
      * Membership Endpoints
      **************************************************************/
@@ -268,7 +273,7 @@ export declare class Webflow {
      */
     users({ siteId }: {
         siteId: string;
-    }, pageParams?: PaginationFilter): Promise<import("./wrapper").MetaResponse<MembershipWrapper[]>>;
+    }, pageParams?: PaginationFilter): Promise<User[]>;
     /**
      * Get a single User account
      * @param param The Site and User information
@@ -279,7 +284,7 @@ export declare class Webflow {
     user({ siteId, userId }: {
         siteId: string;
         userId: string;
-    }): Promise<MembershipWrapper>;
+    }): Promise<User>;
     /**
      * Update a User account
      * @param params The Site and User information
@@ -291,7 +296,7 @@ export declare class Webflow {
         siteId: string;
         userId: string;
         data: any;
-    }): Promise<MembershipWrapper>;
+    }): Promise<User>;
     /**
      * Invite a User to a Site
      * @param params The Site and User information
@@ -302,7 +307,7 @@ export declare class Webflow {
     inviteUser({ siteId, email }: {
         siteId: string;
         email: string;
-    }): Promise<import("./wrapper").MetaResponse<import("./api/membership").IUser>>;
+    }): Promise<User>;
     /**
      * Remove a user from a Site
      * @param params The Site and User information
@@ -313,7 +318,7 @@ export declare class Webflow {
     removeUser({ siteId, userId }: {
         siteId: string;
         userId: string;
-    }): Promise<import("./wrapper").MetaResponse<import("./api/membership").IUserDelete>>;
+    }): Promise<import("../api").IUserDelete>;
     /**************************************************************
      * Webhook Endpoints
      **************************************************************/
@@ -325,7 +330,7 @@ export declare class Webflow {
      */
     webhooks({ siteId }: {
         siteId: string;
-    }, query?: QueryString): Promise<import("./wrapper").MetaResponse<WebhookWrapper[]>>;
+    }): Promise<Webhook[]>;
     /**
      * Get a single Webhook
      * @param params The Webhook and Site information
@@ -336,7 +341,7 @@ export declare class Webflow {
     webhook({ siteId, webhookId }: {
         siteId: string;
         webhookId: string;
-    }): Promise<import("./wrapper").MetaResponse<WebhookWrapper>>;
+    }): Promise<Webhook>;
     /**
      * Remove a Webhook
      * @param params The Webhook and Site information
@@ -347,7 +352,7 @@ export declare class Webflow {
     removeWebhook({ siteId, webhookId }: {
         siteId: string;
         webhookId: string;
-    }): Promise<import("./wrapper").MetaResponse<Webhook.IRemoveResult>>;
+    }): Promise<import("../api").IRemoveResult>;
     /**
      * Create a Webhook
      * @param params The params to create a webhooks
@@ -361,6 +366,6 @@ export declare class Webflow {
         url: string;
         siteId: string;
         triggerType: string;
-        filter?: Webhook.Filter;
-    }): Promise<import("./wrapper").MetaResponse<WebhookWrapper>>;
+        filter?: WebhookFilter;
+    }): Promise<Webhook>;
 }