@flexbe/sdk 0.2.37 → 0.2.38

package/dist/browser/client/pages.js

@@ -316,6 +316,22 @@ export class Pages {
      * @throws {ServerException} When the server encounters an error
      * @throws {TimeoutException} When the request times out
      */
+    getVersions(pageId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.api.get(`/sites/${this.siteId}/pages/${pageId}/versions`);
+            return response.data;
+        });
+    }
+    /**
+     * @deprecated Use getVersions instead, remove it after frontend will be updated
+     * @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
+     */
     getPageVersions(pageId) {
         return __awaiter(this, void 0, void 0, function* () {
             const response = yield this.api.get(`/sites/${this.siteId}/pages/${pageId}/versions`);
@@ -325,7 +341,7 @@ export class Pages {
     /**
      * 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
@@ -333,12 +349,27 @@ export class Pages {
      * @throws {ServerException} When the server encounters an error
      * @throws {TimeoutException} When the request times out
      */
-    getPageVersion(pageId, versionId) {
+    getVersion(pageId, versionId) {
         return __awaiter(this, void 0, void 0, function* () {
             const response = yield 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
+     */
+    getPublishedVersion(pageId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.getVersion(pageId, 'published');
+        });
+    }
     /**
      * Create a new page version
      * @param pageId - ID of the page to create version for

package/dist/cjs/client/pages.js

@@ -283,6 +283,20 @@ class Pages {
      * @throws {ServerException} When the server encounters an error
      * @throws {TimeoutException} When the request times out
      */
+    async getVersions(pageId) {
+        const response = await this.api.get(`/sites/${this.siteId}/pages/${pageId}/versions`);
+        return response.data;
+    }
+    /**
+     * @deprecated Use getVersions instead, remove it after frontend will be updated
+     * @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
+     */
     async getPageVersions(pageId) {
         const response = await this.api.get(`/sites/${this.siteId}/pages/${pageId}/versions`);
         return response.data;
@@ -290,7 +304,7 @@ class Pages {
     /**
      * 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 +312,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

@@ -280,6 +280,20 @@ export class Pages {
      * @throws {ServerException} When the server encounters an error
      * @throws {TimeoutException} When the request times out
      */
+    async getVersions(pageId) {
+        const response = await this.api.get(`/sites/${this.siteId}/pages/${pageId}/versions`);
+        return response.data;
+    }
+    /**
+     * @deprecated Use getVersions instead, remove it after frontend will be updated
+     * @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
+     */
     async getPageVersions(pageId) {
         const response = await this.api.get(`/sites/${this.siteId}/pages/${pageId}/versions`);
         return response.data;
@@ -287,7 +301,7 @@ export class Pages {
     /**
      * 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 +309,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

@@ -226,11 +226,22 @@ export declare class Pages {
      * @throws {ServerException} When the server encounters an error
      * @throws {TimeoutException} When the request times out
      */
+    getVersions(pageId: number): Promise<PageVersionListResponse>;
+    /**
+     * @deprecated Use getVersions instead, remove it after frontend will be updated
+     * @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
+     */
     getPageVersions(pageId: number): Promise<PageVersionListResponse>;
     /**
      * 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
@@ -238,7 +249,18 @@ export declare class Pages {
      * @throws {ServerException} When the server encounters an error
      * @throws {TimeoutException} When the request times out
      */
-    getPageVersion(pageId: number, versionId: number): Promise<PageVersionDataResponse>;
+    getVersion(pageId: number, versionId: number | 'published'): Promise<PageVersionDataResponse>;
+    /**
+     * 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
+     */
+    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.38",
   "description": "TypeScript SDK for Flexbe API",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",