@flexbe/sdk 0.2.37 → 0.2.39

package/dist/browser/client/pages.js

@@ -274,69 +274,51 @@ export class Pages {
         });
     }
     /**
-     * Get list of page history items
-     * @param pageId - ID of the page to get history for
-     * @returns List of page history items
+     * Get list of page versions
+     * @param pageId - ID of the page to get versions for
+     * @returns List of page versions
      * @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) {
+    getVersions(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;
         });
     }
     /**
-     * Get a specific page history item
+     * Get a specific page version
      * @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
-     * @returns List of page versions
+     * @param versionId - ID of the version to get or 'published' to get the published version
+     * @returns The requested page version with data
      * @throws {UnauthorizedException} When the API key is invalid or expired
-     * @throws {NotFoundException} When the page is not found
+     * @throws {NotFoundException} When the page or version 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
      */
-    getPageVersions(pageId) {
+    getVersion(pageId, versionId) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.api.get(`/sites/${this.siteId}/pages/${pageId}/versions`);
+            const response = yield this.api.get(`/sites/${this.siteId}/pages/${pageId}/versions/${versionId}`);
             return response.data;
         });
     }
     /**
-     * Get a specific page version
+     * Get the published version of a page
      * @param pageId - ID of the page
-     * @param versionId - ID of the version to get
-     * @returns The requested page version with data
+     * @returns The published page version with data
      * @throws {UnauthorizedException} When the API key is invalid or expired
-     * @throws {NotFoundException} When the page or version is not found
+     * @throws {NotFoundException} When the page is not found or has no published version
      * @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
      */
-    getPageVersion(pageId, versionId) {
+    getPublishedVersion(pageId) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.api.get(`/sites/${this.siteId}/pages/${pageId}/versions/${versionId}`);
-            return response.data;
+            return this.getVersion(pageId, 'published');
         });
     }
     /**

package/dist/cjs/client/pages.js

@@ -244,35 +244,6 @@ 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
@@ -283,14 +254,14 @@ class Pages {
      * @throws {ServerException} When the server encounters an error
      * @throws {TimeoutException} When the request times out
      */
-    async getPageVersions(pageId) {
+    async getVersions(pageId) {
         const response = await this.api.get(`/sites/${this.siteId}/pages/${pageId}/versions`);
         return response.data;
     }
     /**
      * Get a specific page version
      * @param pageId - ID of the page
-     * @param versionId - ID of the version to get
+     * @param versionId - ID of the version to get or 'published' to get the published version
      * @returns The requested page version with data
      * @throws {UnauthorizedException} When the API key is invalid or expired
      * @throws {NotFoundException} When the page or version is not found
@@ -298,10 +269,23 @@ class Pages {
      * @throws {ServerException} When the server encounters an error
      * @throws {TimeoutException} When the request times out
      */
-    async getPageVersion(pageId, versionId) {
+    async getVersion(pageId, versionId) {
         const response = await this.api.get(`/sites/${this.siteId}/pages/${pageId}/versions/${versionId}`);
         return response.data;
     }
+    /**
+     * Get the published version of a page
+     * @param pageId - ID of the page
+     * @returns The published page version with data
+     * @throws {UnauthorizedException} When the API key is invalid or expired
+     * @throws {NotFoundException} When the page is not found or has no published version
+     * @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 getPublishedVersion(pageId) {
+        return this.getVersion(pageId, 'published');
+    }
     /**
      * Create a new page version
      * @param pageId - ID of the page to create version for

package/dist/esm/client/pages.js

@@ -241,35 +241,6 @@ 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
@@ -280,14 +251,14 @@ export class Pages {
      * @throws {ServerException} When the server encounters an error
      * @throws {TimeoutException} When the request times out
      */
-    async getPageVersions(pageId) {
+    async getVersions(pageId) {
         const response = await this.api.get(`/sites/${this.siteId}/pages/${pageId}/versions`);
         return response.data;
     }
     /**
      * Get a specific page version
      * @param pageId - ID of the page
-     * @param versionId - ID of the version to get
+     * @param versionId - ID of the version to get or 'published' to get the published version
      * @returns The requested page version with data
      * @throws {UnauthorizedException} When the API key is invalid or expired
      * @throws {NotFoundException} When the page or version is not found
@@ -295,10 +266,23 @@ export class Pages {
      * @throws {ServerException} When the server encounters an error
      * @throws {TimeoutException} When the request times out
      */
-    async getPageVersion(pageId, versionId) {
+    async getVersion(pageId, versionId) {
         const response = await this.api.get(`/sites/${this.siteId}/pages/${pageId}/versions/${versionId}`);
         return response.data;
     }
+    /**
+     * Get the published version of a page
+     * @param pageId - ID of the page
+     * @returns The published page version with data
+     * @throws {UnauthorizedException} When the API key is invalid or expired
+     * @throws {NotFoundException} When the page is not found or has no published version
+     * @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 getPublishedVersion(pageId) {
+        return this.getVersion(pageId, 'published');
+    }
     /**
      * Create a new page version
      * @param pageId - ID of the page to create version for

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

@@ -1,5 +1,5 @@
 import { ApiClient } from './api-client';
-import { BulkDeleteResponse, BulkUpdateFolderItem, BulkUpdateFolderResponse, BulkUpdatePageItem, BulkUpdateResponse, CreateFolderParams, CreatePageVersionParams, GetPagesParams, Page, PageContent, PageFolder, PageFolderListResponse, PageHistoryItemData, PageHistoryListResponse, PageListResponse, PageVersionDataResponse, PageVersionListResponse, UpdateFolderParams, UpdatePageContentParams, UpdatePageParams } from '../types/pages';
+import { BulkDeleteResponse, BulkUpdateFolderItem, BulkUpdateFolderResponse, BulkUpdatePageItem, BulkUpdateResponse, CreateFolderParams, CreatePageVersionParams, GetPagesParams, Page, PageContent, PageFolder, PageFolderListResponse, PageListResponse, PageVersionDataResponse, PageVersionListResponse, UpdateFolderParams, UpdatePageContentParams, UpdatePageParams } from '../types/pages';
 export declare class Pages {
     private readonly api;
     private readonly siteId;
@@ -194,51 +194,39 @@ export declare class Pages {
      */
     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
+     * Get list of page versions
+     * @param pageId - ID of the page to get versions for
+     * @returns List of page versions
      * @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>;
+    getVersions(pageId: number): Promise<PageVersionListResponse>;
     /**
-     * Get a specific page history item
+     * Get a specific page version
      * @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
-     * @returns List of page versions
+     * @param versionId - ID of the version to get or 'published' to get the published version
+     * @returns The requested page version with data
      * @throws {UnauthorizedException} When the API key is invalid or expired
-     * @throws {NotFoundException} When the page is not found
+     * @throws {NotFoundException} When the page or version 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
      */
-    getPageVersions(pageId: number): Promise<PageVersionListResponse>;
+    getVersion(pageId: number, versionId: number | 'published'): Promise<PageVersionDataResponse>;
     /**
-     * Get a specific page version
+     * Get the published version of a page
      * @param pageId - ID of the page
-     * @param versionId - ID of the version to get
-     * @returns The requested page version with data
+     * @returns The published page version with data
      * @throws {UnauthorizedException} When the API key is invalid or expired
-     * @throws {NotFoundException} When the page or version is not found
+     * @throws {NotFoundException} When the page is not found or has no published version
      * @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
      */
-    getPageVersion(pageId: number, versionId: number): Promise<PageVersionDataResponse>;
+    getPublishedVersion(pageId: number): Promise<PageVersionDataResponse>;
     /**
      * Create a new page version
      * @param pageId - ID of the page to create version for

package/package.json

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