@flexbe/sdk 0.2.0 → 0.2.1

package/dist/browser/client/pages.js

@@ -13,6 +13,14 @@ export class Pages {
     }
     /**
      * Get list of pages for a site
+     * @param params - Query parameters including:
+     * - offset: Number of items to skip (default: 0)
+     * - limit: Maximum number of items to return (default: 100)
+     * - type: Filter by page type
+     * - status: Filter by page status
+     * - uri: Search by URI (exact match with '/' or partial match with '%word%')
+     * - title: Search by title
+     * - folderId: Filter by folder ID
      */
     getPages(params) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -49,6 +57,10 @@ export class Pages {
     }
     /**
      * Update a folder's properties
+     * @param folderId - ID of the folder to update
+     * @param data - Update parameters:
+     * - title: New title for the folder
+     * - sortIndex: New position in the folder list
      */
     updateFolder(folderId, data) {
         return __awaiter(this, void 0, void 0, function* () {
@@ -58,6 +70,9 @@ export class Pages {
     }
     /**
      * Create a new folder
+     * @param data - Create parameters:
+     * - title: Title of the new folder (required)
+     * - sortIndex: Position in the folder list (optional)
      */
     createFolder(data) {
         return __awaiter(this, void 0, void 0, function* () {

package/dist/cjs/client/pages.js

@@ -7,6 +7,14 @@ class Pages {
     }
     /**
      * Get list of pages for a site
+     * @param params - Query parameters including:
+     * - offset: Number of items to skip (default: 0)
+     * - limit: Maximum number of items to return (default: 100)
+     * - type: Filter by page type
+     * - status: Filter by page status
+     * - uri: Search by URI (exact match with '/' or partial match with '%word%')
+     * - title: Search by title
+     * - folderId: Filter by folder ID
      */
     async getPages(params) {
         const response = await this.api.get('/sites/:siteId:/pages', { params });
@@ -35,6 +43,10 @@ class Pages {
     }
     /**
      * Update a folder's properties
+     * @param folderId - ID of the folder to update
+     * @param data - Update parameters:
+     * - title: New title for the folder
+     * - sortIndex: New position in the folder list
      */
     async updateFolder(folderId, data) {
         const response = await this.api.patch(`/sites/:siteId:/pages-folders/${folderId}`, data);
@@ -42,6 +54,9 @@ class Pages {
     }
     /**
      * Create a new folder
+     * @param data - Create parameters:
+     * - title: Title of the new folder (required)
+     * - sortIndex: Position in the folder list (optional)
      */
     async createFolder(data) {
         const response = await this.api.post('/sites/:siteId:/pages-folders', data);

package/dist/esm/client/pages.js

@@ -4,6 +4,14 @@ export class Pages {
     }
     /**
      * Get list of pages for a site
+     * @param params - Query parameters including:
+     * - offset: Number of items to skip (default: 0)
+     * - limit: Maximum number of items to return (default: 100)
+     * - type: Filter by page type
+     * - status: Filter by page status
+     * - uri: Search by URI (exact match with '/' or partial match with '%word%')
+     * - title: Search by title
+     * - folderId: Filter by folder ID
      */
     async getPages(params) {
         const response = await this.api.get('/sites/:siteId:/pages', { params });
@@ -32,6 +40,10 @@ export class Pages {
     }
     /**
      * Update a folder's properties
+     * @param folderId - ID of the folder to update
+     * @param data - Update parameters:
+     * - title: New title for the folder
+     * - sortIndex: New position in the folder list
      */
     async updateFolder(folderId, data) {
         const response = await this.api.patch(`/sites/:siteId:/pages-folders/${folderId}`, data);
@@ -39,6 +51,9 @@ export class Pages {
     }
     /**
      * Create a new folder
+     * @param data - Create parameters:
+     * - title: Title of the new folder (required)
+     * - sortIndex: Position in the folder list (optional)
      */
     async createFolder(data) {
         const response = await this.api.post('/sites/:siteId:/pages-folders', data);

package/dist/types/client/pages.d.ts

@@ -5,6 +5,14 @@ export declare class Pages {
     constructor(api: ApiClient);
     /**
      * Get list of pages for a site
+     * @param params - Query parameters including:
+     * - offset: Number of items to skip (default: 0)
+     * - limit: Maximum number of items to return (default: 100)
+     * - type: Filter by page type
+     * - status: Filter by page status
+     * - uri: Search by URI (exact match with '/' or partial match with '%word%')
+     * - title: Search by title
+     * - folderId: Filter by folder ID
      */
     getPages(params?: GetPagesParams): Promise<PageListResponse>;
     /**
@@ -21,10 +29,17 @@ export declare class Pages {
     getFolder(folderId: number): Promise<PageFolder>;
     /**
      * Update a folder's properties
+     * @param folderId - ID of the folder to update
+     * @param data - Update parameters:
+     * - title: New title for the folder
+     * - sortIndex: New position in the folder list
      */
     updateFolder(folderId: number, data: UpdateFolderParams): Promise<PageFolder>;
     /**
      * Create a new folder
+     * @param data - Create parameters:
+     * - title: Title of the new folder (required)
+     * - sortIndex: Position in the folder list (optional)
      */
     createFolder(data: CreateFolderParams): Promise<PageFolder>;
     /**

package/dist/types/types/pages.d.ts

@@ -1,4 +1,33 @@
 import { Pagination } from './index';
+export interface GridConfig {
+    color?: string;
+    desktop?: {
+        columns: number;
+        containerWidth: number;
+        columnWidth: number;
+        gap: number;
+    };
+    mobile?: {
+        columns: number;
+        containerWidth: number;
+        columnWidth: number;
+        gap: number;
+    };
+}
+export interface Screenshot {
+    id: number | null;
+    ext: string;
+    url: string | null;
+}
+export interface PageMeta {
+    title: string | null;
+    description: string | null;
+    keywords: string | null;
+    ogImage: string | null;
+    ogTitle: string | null;
+    ogDescription: string | null;
+    noindex: boolean;
+}
 export declare enum PageType {
     PAGE = "page",
     FILE = "file",
@@ -16,20 +45,25 @@ export declare enum PageStatus {
 export interface Page {
     id: number;
     type: PageType;
-    uri: string;
-    title: string | null;
     status: PageStatus;
-    updatedAt?: Date;
-    imgId: number | null;
-    folderId: number | null;
+    name: string;
+    uri: string | null;
+    language: string;
+    folderId: number;
     sortIndex: number;
+    updatedAt?: Date;
+    deletedAt: Date | null;
+    screenshot: Screenshot | null;
+    meta: PageMeta | null;
+    grid?: GridConfig;
 }
 export interface GetPagesParams {
     offset?: number;
     limit?: number;
     type?: PageType;
     status?: PageStatus;
-    search?: string;
+    uri?: string;
+    title?: string;
     folderId?: number;
 }
 export interface PageListResponse {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@flexbe/sdk",
-    "version": "0.2.0",
+    "version": "0.2.1",
     "description": "TypeScript SDK for Flexbe API",
     "main": "dist/cjs/index.js",
     "module": "dist/esm/index.js",