@flexbe/sdk 0.2.32 → 0.2.34

package/dist/browser/client/pages.js

@@ -144,6 +144,7 @@ export class Pages {
      * @param pageId - ID of the page to update
      * @param data - Update parameters including:
      * - status: New status for the page
+     * - versionId: ID of the version to set as current
      * - name: New name for the page (max 150 characters)
      * - uri: New URI for the page (max 255 characters, automatically normalized with leading and trailing slashes)
      * - language: New language for the page
@@ -157,10 +158,9 @@ export class Pages {
      *   - ogTitle: Open Graph title for social sharing (max 200 characters)
      *   - ogDescription: Open Graph description for social sharing (max 1000 characters)
      *   - noindex: Whether to prevent search engine indexing
-     * - grid: Grid configuration for the page
      * @throws {UnauthorizedException} When the API key is invalid or expired
-     * @throws {NotFoundException} When the page is not found
-     * @throws {ForbiddenException} When the page does not belong to the site
+     * @throws {NotFoundException} When the page or version is not found
+     * @throws {ForbiddenException} When the page does not belong to the site or version belongs to a different page
      * @throws {BadRequestException} When the update parameters are invalid
      * @throws {ServerException} When the server encounters an error
      * @throws {TimeoutException} When the request times out
@@ -272,6 +272,39 @@ export class Pages {
             return response.data;
         });
     }
+    /**
+     * Get list of page history items
+     * @param pageId - ID of the page to get history for
+     * @returns List of page history items
+     * @throws {UnauthorizedException} When the API key is invalid or expired
+     * @throws {NotFoundException} When the page is not found
+     * @throws {ForbiddenException} When the page does not belong to the site
+     * @throws {ServerException} When the server encounters an error
+     * @throws {TimeoutException} When the request times out
+     */
+    getPageHistory(pageId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.api.get(`/sites/${this.siteId}/pages/${pageId}/history`);
+            return response.data;
+        });
+    }
+    /**
+     * Get a specific page history item
+     * @param pageId - ID of the page
+     * @param versionId - ID of the history item to get
+     * @returns The requested page history item with data
+     * @throws {UnauthorizedException} When the API key is invalid or expired
+     * @throws {NotFoundException} When the page or history item is not found
+     * @throws {ForbiddenException} When the page does not belong to the site
+     * @throws {ServerException} When the server encounters an error
+     * @throws {TimeoutException} When the request times out
+     */
+    getPageHistoryItem(pageId, versionId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.api.get(`/sites/${this.siteId}/pages/${pageId}/history/${versionId}`);
+            return response.data;
+        });
+    }
     /**
      * Get list of page versions
      * @param pageId - ID of the page to get versions for
@@ -282,9 +315,9 @@ export class Pages {
      * @throws {ServerException} When the server encounters an error
      * @throws {TimeoutException} When the request times out
      */
-    getPageHistory(pageId) {
+    getPageVersions(pageId) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.api.get(`/sites/${this.siteId}/pages/${pageId}/history`);
+            const response = yield this.api.get(`/sites/${this.siteId}/pages/${pageId}/versions`);
             return response.data;
         });
     }
@@ -299,9 +332,9 @@ export class Pages {
      * @throws {ServerException} When the server encounters an error
      * @throws {TimeoutException} When the request times out
      */
-    getPageHistoryItem(pageId, versionId) {
+    getPageVersion(pageId, versionId) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.api.get(`/sites/${this.siteId}/pages/${pageId}/history/${versionId}`);
+            const response = yield this.api.get(`/sites/${this.siteId}/pages/${pageId}/versions/${versionId}`);
             return response.data;
         });
     }

package/dist/cjs/client/pages.js

@@ -126,6 +126,7 @@ class Pages {
      * @param pageId - ID of the page to update
      * @param data - Update parameters including:
      * - status: New status for the page
+     * - versionId: ID of the version to set as current
      * - name: New name for the page (max 150 characters)
      * - uri: New URI for the page (max 255 characters, automatically normalized with leading and trailing slashes)
      * - language: New language for the page
@@ -139,10 +140,9 @@ class Pages {
      *   - ogTitle: Open Graph title for social sharing (max 200 characters)
      *   - ogDescription: Open Graph description for social sharing (max 1000 characters)
      *   - noindex: Whether to prevent search engine indexing
-     * - grid: Grid configuration for the page
      * @throws {UnauthorizedException} When the API key is invalid or expired
-     * @throws {NotFoundException} When the page is not found
-     * @throws {ForbiddenException} When the page does not belong to the site
+     * @throws {NotFoundException} When the page or version is not found
+     * @throws {ForbiddenException} When the page does not belong to the site or version belongs to a different page
      * @throws {BadRequestException} When the update parameters are invalid
      * @throws {ServerException} When the server encounters an error
      * @throws {TimeoutException} When the request times out
@@ -242,6 +242,35 @@ class Pages {
         const response = await this.api.put(`/sites/${this.siteId}/pages/${pageId}/content`, content);
         return response.data;
     }
+    /**
+     * Get list of page history items
+     * @param pageId - ID of the page to get history for
+     * @returns List of page history items
+     * @throws {UnauthorizedException} When the API key is invalid or expired
+     * @throws {NotFoundException} When the page is not found
+     * @throws {ForbiddenException} When the page does not belong to the site
+     * @throws {ServerException} When the server encounters an error
+     * @throws {TimeoutException} When the request times out
+     */
+    async getPageHistory(pageId) {
+        const response = await this.api.get(`/sites/${this.siteId}/pages/${pageId}/history`);
+        return response.data;
+    }
+    /**
+     * Get a specific page history item
+     * @param pageId - ID of the page
+     * @param versionId - ID of the history item to get
+     * @returns The requested page history item with data
+     * @throws {UnauthorizedException} When the API key is invalid or expired
+     * @throws {NotFoundException} When the page or history item is not found
+     * @throws {ForbiddenException} When the page does not belong to the site
+     * @throws {ServerException} When the server encounters an error
+     * @throws {TimeoutException} When the request times out
+     */
+    async getPageHistoryItem(pageId, versionId) {
+        const response = await this.api.get(`/sites/${this.siteId}/pages/${pageId}/history/${versionId}`);
+        return response.data;
+    }
     /**
      * Get list of page versions
      * @param pageId - ID of the page to get versions for
@@ -252,8 +281,8 @@ class Pages {
      * @throws {ServerException} When the server encounters an error
      * @throws {TimeoutException} When the request times out
      */
-    async getPageHistory(pageId) {
-        const response = await this.api.get(`/sites/${this.siteId}/pages/${pageId}/history`);
+    async getPageVersions(pageId) {
+        const response = await this.api.get(`/sites/${this.siteId}/pages/${pageId}/versions`);
         return response.data;
     }
     /**
@@ -267,8 +296,8 @@ class Pages {
      * @throws {ServerException} When the server encounters an error
      * @throws {TimeoutException} When the request times out
      */
-    async getPageHistoryItem(pageId, versionId) {
-        const response = await this.api.get(`/sites/${this.siteId}/pages/${pageId}/history/${versionId}`);
+    async getPageVersion(pageId, versionId) {
+        const response = await this.api.get(`/sites/${this.siteId}/pages/${pageId}/versions/${versionId}`);
         return response.data;
     }
 }

package/dist/esm/client/pages.js

@@ -123,6 +123,7 @@ export class Pages {
      * @param pageId - ID of the page to update
      * @param data - Update parameters including:
      * - status: New status for the page
+     * - versionId: ID of the version to set as current
      * - name: New name for the page (max 150 characters)
      * - uri: New URI for the page (max 255 characters, automatically normalized with leading and trailing slashes)
      * - language: New language for the page
@@ -136,10 +137,9 @@ export class Pages {
      *   - ogTitle: Open Graph title for social sharing (max 200 characters)
      *   - ogDescription: Open Graph description for social sharing (max 1000 characters)
      *   - noindex: Whether to prevent search engine indexing
-     * - grid: Grid configuration for the page
      * @throws {UnauthorizedException} When the API key is invalid or expired
-     * @throws {NotFoundException} When the page is not found
-     * @throws {ForbiddenException} When the page does not belong to the site
+     * @throws {NotFoundException} When the page or version is not found
+     * @throws {ForbiddenException} When the page does not belong to the site or version belongs to a different page
      * @throws {BadRequestException} When the update parameters are invalid
      * @throws {ServerException} When the server encounters an error
      * @throws {TimeoutException} When the request times out
@@ -239,6 +239,35 @@ export class Pages {
         const response = await this.api.put(`/sites/${this.siteId}/pages/${pageId}/content`, content);
         return response.data;
     }
+    /**
+     * Get list of page history items
+     * @param pageId - ID of the page to get history for
+     * @returns List of page history items
+     * @throws {UnauthorizedException} When the API key is invalid or expired
+     * @throws {NotFoundException} When the page is not found
+     * @throws {ForbiddenException} When the page does not belong to the site
+     * @throws {ServerException} When the server encounters an error
+     * @throws {TimeoutException} When the request times out
+     */
+    async getPageHistory(pageId) {
+        const response = await this.api.get(`/sites/${this.siteId}/pages/${pageId}/history`);
+        return response.data;
+    }
+    /**
+     * Get a specific page history item
+     * @param pageId - ID of the page
+     * @param versionId - ID of the history item to get
+     * @returns The requested page history item with data
+     * @throws {UnauthorizedException} When the API key is invalid or expired
+     * @throws {NotFoundException} When the page or history item is not found
+     * @throws {ForbiddenException} When the page does not belong to the site
+     * @throws {ServerException} When the server encounters an error
+     * @throws {TimeoutException} When the request times out
+     */
+    async getPageHistoryItem(pageId, versionId) {
+        const response = await this.api.get(`/sites/${this.siteId}/pages/${pageId}/history/${versionId}`);
+        return response.data;
+    }
     /**
      * Get list of page versions
      * @param pageId - ID of the page to get versions for
@@ -249,8 +278,8 @@ export class Pages {
      * @throws {ServerException} When the server encounters an error
      * @throws {TimeoutException} When the request times out
      */
-    async getPageHistory(pageId) {
-        const response = await this.api.get(`/sites/${this.siteId}/pages/${pageId}/history`);
+    async getPageVersions(pageId) {
+        const response = await this.api.get(`/sites/${this.siteId}/pages/${pageId}/versions`);
         return response.data;
     }
     /**
@@ -264,8 +293,8 @@ export class Pages {
      * @throws {ServerException} When the server encounters an error
      * @throws {TimeoutException} When the request times out
      */
-    async getPageHistoryItem(pageId, versionId) {
-        const response = await this.api.get(`/sites/${this.siteId}/pages/${pageId}/history/${versionId}`);
+    async getPageVersion(pageId, versionId) {
+        const response = await this.api.get(`/sites/${this.siteId}/pages/${pageId}/versions/${versionId}`);
         return response.data;
     }
 }

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

@@ -1,4 +1,4 @@
-import { Page, GetPagesParams, PageListResponse, PageFolder, PageFolderListResponse, UpdateFolderParams, CreateFolderParams, UpdatePageParams, BulkUpdatePageItem, BulkUpdateResponse, BulkUpdateFolderItem, BulkUpdateFolderResponse, BulkDeleteResponse, PageContent, UpdatePageContentParams, PageVersionListResponse, PageHistoryItemData } from '../types/pages';
+import { Page, GetPagesParams, PageListResponse, PageFolder, PageFolderListResponse, UpdateFolderParams, CreateFolderParams, UpdatePageParams, BulkUpdatePageItem, BulkUpdateResponse, BulkUpdateFolderItem, BulkUpdateFolderResponse, BulkDeleteResponse, PageContent, UpdatePageContentParams, PageHistoryListResponse, PageHistoryItemData, PageVersionListResponse, PageVersionDataResponse } from '../types/pages';
 import { ApiClient } from './api-client';
 export declare class Pages {
     private readonly api;
@@ -97,6 +97,7 @@ export declare class Pages {
      * @param pageId - ID of the page to update
      * @param data - Update parameters including:
      * - status: New status for the page
+     * - versionId: ID of the version to set as current
      * - name: New name for the page (max 150 characters)
      * - uri: New URI for the page (max 255 characters, automatically normalized with leading and trailing slashes)
      * - language: New language for the page
@@ -110,10 +111,9 @@ export declare class Pages {
      *   - ogTitle: Open Graph title for social sharing (max 200 characters)
      *   - ogDescription: Open Graph description for social sharing (max 1000 characters)
      *   - noindex: Whether to prevent search engine indexing
-     * - grid: Grid configuration for the page
      * @throws {UnauthorizedException} When the API key is invalid or expired
-     * @throws {NotFoundException} When the page is not found
-     * @throws {ForbiddenException} When the page does not belong to the site
+     * @throws {NotFoundException} When the page or version is not found
+     * @throws {ForbiddenException} When the page does not belong to the site or version belongs to a different page
      * @throws {BadRequestException} When the update parameters are invalid
      * @throws {ServerException} When the server encounters an error
      * @throws {TimeoutException} When the request times out
@@ -193,6 +193,29 @@ export declare class Pages {
      * @throws {TimeoutException} When the request times out
      */
     updatePageContent(pageId: number, content: Partial<UpdatePageContentParams>): Promise<PageContent>;
+    /**
+     * Get list of page history items
+     * @param pageId - ID of the page to get history for
+     * @returns List of page history items
+     * @throws {UnauthorizedException} When the API key is invalid or expired
+     * @throws {NotFoundException} When the page is not found
+     * @throws {ForbiddenException} When the page does not belong to the site
+     * @throws {ServerException} When the server encounters an error
+     * @throws {TimeoutException} When the request times out
+     */
+    getPageHistory(pageId: number): Promise<PageHistoryListResponse>;
+    /**
+     * Get a specific page history item
+     * @param pageId - ID of the page
+     * @param versionId - ID of the history item to get
+     * @returns The requested page history item with data
+     * @throws {UnauthorizedException} When the API key is invalid or expired
+     * @throws {NotFoundException} When the page or history item is not found
+     * @throws {ForbiddenException} When the page does not belong to the site
+     * @throws {ServerException} When the server encounters an error
+     * @throws {TimeoutException} When the request times out
+     */
+    getPageHistoryItem(pageId: number, versionId: number): Promise<PageHistoryItemData>;
     /**
      * Get list of page versions
      * @param pageId - ID of the page to get versions for
@@ -203,7 +226,7 @@ export declare class Pages {
      * @throws {ServerException} When the server encounters an error
      * @throws {TimeoutException} When the request times out
      */
-    getPageHistory(pageId: number): Promise<PageVersionListResponse>;
+    getPageVersions(pageId: number): Promise<PageVersionListResponse>;
     /**
      * Get a specific page version
      * @param pageId - ID of the page
@@ -215,5 +238,5 @@ export declare class Pages {
      * @throws {ServerException} When the server encounters an error
      * @throws {TimeoutException} When the request times out
      */
-    getPageHistoryItem(pageId: number, versionId: number): Promise<PageHistoryItemData>;
+    getPageVersion(pageId: number, versionId: number): Promise<PageVersionDataResponse>;
 }

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

@@ -45,6 +45,7 @@ export declare enum PageStatus {
 }
 export interface Page {
     id: number;
+    versionId: number | null;
     type: PageType;
     status: PageStatus;
     name: string;
@@ -89,6 +90,7 @@ export interface CreateFolderParams {
 }
 export interface UpdatePageParams {
     status?: PageStatus;
+    versionId?: number;
     name?: string;
     uri?: string;
     language?: string;
@@ -292,10 +294,20 @@ export interface PageHistoryItem {
     createdAt: string;
     selected?: boolean;
 }
-export interface PageVersionListResponse {
+export interface PageHistoryListResponse {
     list: PageHistoryItem[];
 }
 export interface PageHistoryItemData extends PageHistoryItem {
     data: Record<string, unknown>;
 }
+export interface PageVersionItem {
+    id: number;
+    createdAt: string;
+}
+export interface PageVersionListResponse {
+    list: PageVersionItem[];
+}
+export interface PageVersionDataResponse {
+    data: PageContent;
+}
 export {};

package/package.json

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