@agility/management-sdk 0.1.36 → 0.1.38

package/dist/apiMethods/clientInstance.d.ts

@@ -1,7 +1,9 @@
 import { AxiosInstance } from 'axios';
+import https from 'https';
 import { Options } from "../models/options";
 export declare class ClientInstance {
     _options: Options;
+    _httpsAgent: https.Agent | undefined;
     constructor(options: Options);
     /**
      * Figure out the Base Url, which can be overriden using options.baseUrl

package/dist/apiMethods/clientInstance.js

@@ -41,9 +41,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ClientInstance = void 0;
 var axios_1 = __importDefault(require("axios"));
+var https_1 = __importDefault(require("https"));
 var ClientInstance = /** @class */ (function () {
     function ClientInstance(options) {
         this._options = options;
+        // Create an HTTPS agent that ignores SSL certificate errors for local development
+        if (process.env.NODE_TLS_REJECT_UNAUTHORIZED === '0') {
+            this._httpsAgent = new https_1.default.Agent({
+                rejectUnauthorized: false
+            });
+        }
     }
     /**
      * Figure out the Base Url, which can be overriden using options.baseUrl
@@ -83,7 +90,8 @@ var ClientInstance = /** @class */ (function () {
         var instance = axios_1.default.create({
             baseURL: "".concat(baseUrl, "/api/v1/instance/").concat(guid),
             maxContentLength: Infinity,
-            maxBodyLength: Infinity
+            maxBodyLength: Infinity,
+            httpsAgent: this._httpsAgent
         });
         return instance;
     };
@@ -92,7 +100,8 @@ var ClientInstance = /** @class */ (function () {
         var instance = axios_1.default.create({
             baseURL: "".concat(baseUrl, "/api/v1"),
             maxContentLength: Infinity,
-            maxBodyLength: Infinity
+            maxBodyLength: Infinity,
+            httpsAgent: this._httpsAgent
         });
         return instance;
     };

package/dist/apiMethods/containerMethods.d.ts

@@ -2,6 +2,8 @@ import { Options } from "../models/options";
 import { ClientInstance } from "./clientInstance";
 import { Container } from "../models/container";
 import { Notification } from "../models/notification";
+import { PagedResult } from "../models/pagedResult";
+import { ContentViewType } from "../enums/contentViewType";
 export declare class ContainerMethods {
     _options: Options;
     _clientInstance: ClientInstance;
@@ -18,6 +20,7 @@ export declare class ContainerMethods {
     getContainerByReferenceName(referenceName: string, guid: string): Promise<Container | null>;
     getContainerSecurity(id: number, guid: string): Promise<Container>;
     getContainerList(guid: string): Promise<Container[]>;
+    getContainerListPaged(guid: string, pageSize?: number, recordOffset?: number, contentType?: ContentViewType, includeModules?: boolean, updatedSince?: Date): Promise<PagedResult<Container>>;
     getNotificationList(id: number, guid: string): Promise<Notification[]>;
     saveContainer(container: Container, guid: string, forceReferenceName?: boolean): Promise<Container>;
     deleteContainer(id: number, guid: string): Promise<string>;

package/dist/apiMethods/containerMethods.js

@@ -39,6 +39,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ContainerMethods = void 0;
 var clientInstance_1 = require("./clientInstance");
 var exception_1 = require("../models/exception");
+var contentViewType_1 = require("../enums/contentViewType");
 var ContainerMethods = /** @class */ (function () {
     function ContainerMethods(options) {
         this._options = options;
@@ -155,9 +156,42 @@ var ContainerMethods = /** @class */ (function () {
             });
         });
     };
+    ContainerMethods.prototype.getContainerListPaged = function (guid_1) {
+        return __awaiter(this, arguments, void 0, function (guid, pageSize, recordOffset, contentType, includeModules, updatedSince) {
+            var params, apiPath, resp, err_6;
+            if (pageSize === void 0) { pageSize = 20; }
+            if (recordOffset === void 0) { recordOffset = 0; }
+            if (contentType === void 0) { contentType = contentViewType_1.ContentViewType.All; }
+            if (includeModules === void 0) { includeModules = true; }
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        params = new URLSearchParams({
+                            pageSize: pageSize.toString(),
+                            recordOffset: recordOffset.toString(),
+                            contentType: contentType.toString(),
+                            includeModules: includeModules.toString()
+                        });
+                        if (updatedSince) {
+                            params.append('updatedSince', updatedSince.toISOString());
+                        }
+                        apiPath = "container/list/paged?".concat(params.toString());
+                        return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
+                    case 1:
+                        resp = _a.sent();
+                        return [2 /*return*/, resp.data];
+                    case 2:
+                        err_6 = _a.sent();
+                        throw new exception_1.Exception("Unable to retrieve the paged container list", err_6);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
     ContainerMethods.prototype.getNotificationList = function (id, guid) {
         return __awaiter(this, void 0, void 0, function () {
-            var apiPath, resp, err_6;
+            var apiPath, resp, err_7;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -168,8 +202,8 @@ var ContainerMethods = /** @class */ (function () {
                         resp = _a.sent();
                         return [2 /*return*/, resp.data];
                     case 2:
-                        err_6 = _a.sent();
-                        throw new exception_1.Exception("Unable to retrieve the notifications for container id: ".concat(id), err_6);
+                        err_7 = _a.sent();
+                        throw new exception_1.Exception("Unable to retrieve the notifications for container id: ".concat(id), err_7);
                     case 3: return [2 /*return*/];
                 }
             });
@@ -177,7 +211,7 @@ var ContainerMethods = /** @class */ (function () {
     };
     ContainerMethods.prototype.saveContainer = function (container_1, guid_1) {
         return __awaiter(this, arguments, void 0, function (container, guid, forceReferenceName) {
-            var apiPath, resp, err_7;
+            var apiPath, resp, err_8;
             if (forceReferenceName === void 0) { forceReferenceName = false; }
             return __generator(this, function (_a) {
                 switch (_a.label) {
@@ -189,8 +223,8 @@ var ContainerMethods = /** @class */ (function () {
                         resp = _a.sent();
                         return [2 /*return*/, resp.data];
                     case 2:
-                        err_7 = _a.sent();
-                        throw new exception_1.Exception("Unable to save the container", err_7);
+                        err_8 = _a.sent();
+                        throw new exception_1.Exception("Unable to save the container", err_8);
                     case 3: return [2 /*return*/];
                 }
             });
@@ -198,7 +232,7 @@ var ContainerMethods = /** @class */ (function () {
     };
     ContainerMethods.prototype.deleteContainer = function (id, guid) {
         return __awaiter(this, void 0, void 0, function () {
-            var apiPath, resp, err_8;
+            var apiPath, resp, err_9;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -209,8 +243,8 @@ var ContainerMethods = /** @class */ (function () {
                         resp = _a.sent();
                         return [2 /*return*/, resp.data];
                     case 2:
-                        err_8 = _a.sent();
-                        throw new exception_1.Exception("Unable to delete the container for id: ".concat(id), err_8);
+                        err_9 = _a.sent();
+                        throw new exception_1.Exception("Unable to delete the container for id: ".concat(id), err_9);
                     case 3: return [2 /*return*/];
                 }
             });

package/dist/apiMethods/contentMethods.d.ts

@@ -6,6 +6,7 @@ import { ContentListFilterModel } from "../models/contentListFilterModel";
 import { ContentItemHistory } from "../models/contentItemHistory";
 import { ItemComments } from "../models/itemComments";
 import { ListParams } from "../models/listParams";
+import { WorkflowOperationType } from "../enums/workflowOperationType";
 export declare class ContentMethods {
     _options: Options;
     _clientInstance: ClientInstance;
@@ -14,6 +15,17 @@ export declare class ContentMethods {
     getContentItem(contentID: number, guid: string, locale: string): Promise<ContentItem>;
     publishContent(contentID: number, guid: string, locale: string, comments?: string, returnBatchId?: boolean): Promise<number[]>;
     unPublishContent(contentID: number, guid: string, locale: string, comments?: string, returnBatchId?: boolean): Promise<number[]>;
+    /**
+     * Perform a batch workflow operation on multiple content items.
+     * Supports Publish, Unpublish, Approve, Decline, and RequestApproval operations.
+     * @param contentIDs Array of content IDs to process
+     * @param guid The GUID of the user making the request
+     * @param locale The locale of the content items
+     * @param operation The workflow operation type (Publish, Unpublish, Approve, Decline, RequestApproval)
+     * @param returnBatchId Whether to return the batch ID immediately
+     * @returns The IDs of the processed content items
+     */
+    batchWorkflowContent(contentIDs: number[], guid: string, locale: string, operation: WorkflowOperationType, returnBatchId?: boolean): Promise<number[]>;
     contentRequestApproval(contentID: number, guid: string, locale: string, comments?: string, returnBatchId?: boolean): Promise<number[]>;
     approveContent(contentID: number, guid: string, locale: string, comments?: string, returnBatchId?: boolean): Promise<number[]>;
     declineContent(contentID: number, guid: string, locale: string, comments?: string, returnBatchId?: boolean): Promise<number[]>;

package/dist/apiMethods/contentMethods.js

@@ -41,6 +41,8 @@ var clientInstance_1 = require("./clientInstance");
 var batchMethods_1 = require("./batchMethods");
 var exception_1 = require("../models/exception");
 var queryString_1 = require("../util/queryString");
+var batchState_1 = require("../enums/batchState.");
+var workflowOperationType_1 = require("../enums/workflowOperationType");
 var ContentMethods = /** @class */ (function () {
     function ContentMethods(options) {
         this._options = options;
@@ -143,9 +145,61 @@ var ContentMethods = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Perform a batch workflow operation on multiple content items.
+     * Supports Publish, Unpublish, Approve, Decline, and RequestApproval operations.
+     * @param contentIDs Array of content IDs to process
+     * @param guid The GUID of the user making the request
+     * @param locale The locale of the content items
+     * @param operation The workflow operation type (Publish, Unpublish, Approve, Decline, RequestApproval)
+     * @param returnBatchId Whether to return the batch ID immediately
+     * @returns The IDs of the processed content items
+     */
+    ContentMethods.prototype.batchWorkflowContent = function (contentIDs_3, guid_1, locale_1, operation_1) {
+        return __awaiter(this, arguments, void 0, function (contentIDs, guid, locale, operation, returnBatchId) {
+            var contentIDsParam, operationName, apiPath, resp, batchID_3, batch, processedContentIDs_1, err_4;
+            var _this = this;
+            if (returnBatchId === void 0) { returnBatchId = false; }
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 3, , 4]);
+                        contentIDsParam = contentIDs.join(',');
+                        operationName = workflowOperationType_1.WorkflowOperationType[operation];
+                        apiPath = "".concat(locale, "/item/batch-workflow?contentIDs=").concat(contentIDsParam, "&operation=").concat(operationName);
+                        return [4 /*yield*/, this._clientInstance.executePost(apiPath, guid, this._options.token, null)];
+                    case 1:
+                        resp = _a.sent();
+                        batchID_3 = resp.data;
+                        // If user wants batchID immediately, return it for custom polling
+                        if (returnBatchId) {
+                            return [2 /*return*/, [batchID_3]];
+                        }
+                        return [4 /*yield*/, this._batchMethods.Retry(function () { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
+                                switch (_a.label) {
+                                    case 0: return [4 /*yield*/, this._batchMethods.getBatch(batchID_3, guid)];
+                                    case 1: return [2 /*return*/, _a.sent()];
+                                }
+                            }); }); })];
+                    case 2:
+                        batch = _a.sent();
+                        if (batch.batchState === batchState_1.BatchState.Processed && batch.errorData && batch.errorData.length > 0) {
+                            throw new exception_1.Exception("Unable to batch ".concat(operationName.toLowerCase(), " content items. Batch is not completed. Error: ").concat(batch.errorData), null);
+                        }
+                        processedContentIDs_1 = [];
+                        batch.items.forEach(function (element) { return processedContentIDs_1.push(element.itemID); });
+                        return [2 /*return*/, processedContentIDs_1];
+                    case 3:
+                        err_4 = _a.sent();
+                        throw new exception_1.Exception("Unable to batch ".concat(workflowOperationType_1.WorkflowOperationType[operation].toLowerCase(), " content items."), err_4);
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
     ContentMethods.prototype.contentRequestApproval = function (contentID_1, guid_1, locale_1) {
         return __awaiter(this, arguments, void 0, function (contentID, guid, locale, comments, returnBatchId) {
-            var apiPath, resp, batchID_3, batch, contentIDs_3, err_4;
+            var apiPath, resp, batchID_4, batch, contentIDs_3, err_5;
             var _this = this;
             if (comments === void 0) { comments = null; }
             if (returnBatchId === void 0) { returnBatchId = false; }
@@ -157,14 +211,14 @@ var ContentMethods = /** @class */ (function () {
                         return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
                     case 1:
                         resp = _a.sent();
-                        batchID_3 = resp.data;
+                        batchID_4 = resp.data;
                         // If user wants batchID immediately, return it for custom polling
                         if (returnBatchId) {
-                            return [2 /*return*/, [batchID_3]];
+                            return [2 /*return*/, [batchID_4]];
                         }
                         return [4 /*yield*/, this._batchMethods.Retry(function () { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
                                 switch (_a.label) {
-                                    case 0: return [4 /*yield*/, this._batchMethods.getBatch(batchID_3, guid)];
+                                    case 0: return [4 /*yield*/, this._batchMethods.getBatch(batchID_4, guid)];
                                     case 1: return [2 /*return*/, _a.sent()];
                                 }
                             }); }); })];
@@ -174,8 +228,8 @@ var ContentMethods = /** @class */ (function () {
                         batch.items.forEach(function (element) { return contentIDs_3.push(element.itemID); });
                         return [2 /*return*/, contentIDs_3];
                     case 3:
-                        err_4 = _a.sent();
-                        throw new exception_1.Exception("Unable to request approval the content for id: ".concat(contentID), err_4);
+                        err_5 = _a.sent();
+                        throw new exception_1.Exception("Unable to request approval the content for id: ".concat(contentID), err_5);
                     case 4: return [2 /*return*/];
                 }
             });
@@ -183,7 +237,7 @@ var ContentMethods = /** @class */ (function () {
     };
     ContentMethods.prototype.approveContent = function (contentID_1, guid_1, locale_1) {
         return __awaiter(this, arguments, void 0, function (contentID, guid, locale, comments, returnBatchId) {
-            var apiPath, resp, batchID_4, batch, contentIDs_4, err_5;
+            var apiPath, resp, batchID_5, batch, contentIDs_4, err_6;
             var _this = this;
             if (comments === void 0) { comments = null; }
             if (returnBatchId === void 0) { returnBatchId = false; }
@@ -195,14 +249,14 @@ var ContentMethods = /** @class */ (function () {
                         return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
                     case 1:
                         resp = _a.sent();
-                        batchID_4 = resp.data;
+                        batchID_5 = resp.data;
                         // If user wants batchID immediately, return it for custom polling
                         if (returnBatchId) {
-                            return [2 /*return*/, [batchID_4]];
+                            return [2 /*return*/, [batchID_5]];
                         }
                         return [4 /*yield*/, this._batchMethods.Retry(function () { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
                                 switch (_a.label) {
-                                    case 0: return [4 /*yield*/, this._batchMethods.getBatch(batchID_4, guid)];
+                                    case 0: return [4 /*yield*/, this._batchMethods.getBatch(batchID_5, guid)];
                                     case 1: return [2 /*return*/, _a.sent()];
                                 }
                             }); }); })];
@@ -212,8 +266,8 @@ var ContentMethods = /** @class */ (function () {
                         batch.items.forEach(function (element) { return contentIDs_4.push(element.itemID); });
                         return [2 /*return*/, contentIDs_4];
                     case 3:
-                        err_5 = _a.sent();
-                        throw new exception_1.Exception("Unable to approve the content for id: ".concat(contentID), err_5);
+                        err_6 = _a.sent();
+                        throw new exception_1.Exception("Unable to approve the content for id: ".concat(contentID), err_6);
                     case 4: return [2 /*return*/];
                 }
             });
@@ -221,7 +275,7 @@ var ContentMethods = /** @class */ (function () {
     };
     ContentMethods.prototype.declineContent = function (contentID_1, guid_1, locale_1) {
         return __awaiter(this, arguments, void 0, function (contentID, guid, locale, comments, returnBatchId) {
-            var apiPath, resp, batchID_5, batch, contentIDs_5, err_6;
+            var apiPath, resp, batchID_6, batch, contentIDs_5, err_7;
             var _this = this;
             if (comments === void 0) { comments = null; }
             if (returnBatchId === void 0) { returnBatchId = false; }
@@ -233,14 +287,14 @@ var ContentMethods = /** @class */ (function () {
                         return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
                     case 1:
                         resp = _a.sent();
-                        batchID_5 = resp.data;
+                        batchID_6 = resp.data;
                         // If user wants batchID immediately, return it for custom polling
                         if (returnBatchId) {
-                            return [2 /*return*/, [batchID_5]];
+                            return [2 /*return*/, [batchID_6]];
                         }
                         return [4 /*yield*/, this._batchMethods.Retry(function () { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
                                 switch (_a.label) {
-                                    case 0: return [4 /*yield*/, this._batchMethods.getBatch(batchID_5, guid)];
+                                    case 0: return [4 /*yield*/, this._batchMethods.getBatch(batchID_6, guid)];
                                     case 1: return [2 /*return*/, _a.sent()];
                                 }
                             }); }); })];
@@ -250,8 +304,8 @@ var ContentMethods = /** @class */ (function () {
                         batch.items.forEach(function (element) { return contentIDs_5.push(element.itemID); });
                         return [2 /*return*/, contentIDs_5];
                     case 3:
-                        err_6 = _a.sent();
-                        throw new exception_1.Exception("Unable to decline the content for id: ".concat(contentID), err_6);
+                        err_7 = _a.sent();
+                        throw new exception_1.Exception("Unable to decline the content for id: ".concat(contentID), err_7);
                     case 4: return [2 /*return*/];
                 }
             });
@@ -259,7 +313,7 @@ var ContentMethods = /** @class */ (function () {
     };
     ContentMethods.prototype.deleteContent = function (contentID_1, guid_1, locale_1) {
         return __awaiter(this, arguments, void 0, function (contentID, guid, locale, comments, returnBatchId) {
-            var apiPath, resp, batchID_6, batch, contentIDs_6, err_7;
+            var apiPath, resp, batchID_7, batch, contentIDs_6, err_8;
             var _this = this;
             if (comments === void 0) { comments = null; }
             if (returnBatchId === void 0) { returnBatchId = false; }
@@ -271,14 +325,14 @@ var ContentMethods = /** @class */ (function () {
                         return [4 /*yield*/, this._clientInstance.executeDelete(apiPath, guid, this._options.token)];
                     case 1:
                         resp = _a.sent();
-                        batchID_6 = resp.data;
+                        batchID_7 = resp.data;
                         // If user wants batchID immediately, return it for custom polling
                         if (returnBatchId) {
-                            return [2 /*return*/, [batchID_6]];
+                            return [2 /*return*/, [batchID_7]];
                         }
                         return [4 /*yield*/, this._batchMethods.Retry(function () { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
                                 switch (_a.label) {
-                                    case 0: return [4 /*yield*/, this._batchMethods.getBatch(batchID_6, guid)];
+                                    case 0: return [4 /*yield*/, this._batchMethods.getBatch(batchID_7, guid)];
                                     case 1: return [2 /*return*/, _a.sent()];
                                 }
                             }); }); })];
@@ -288,8 +342,8 @@ var ContentMethods = /** @class */ (function () {
                         batch.items.forEach(function (element) { return contentIDs_6.push(element.itemID); });
                         return [2 /*return*/, contentIDs_6];
                     case 3:
-                        err_7 = _a.sent();
-                        throw new exception_1.Exception("Unable to delete the content for id: ".concat(contentID), err_7);
+                        err_8 = _a.sent();
+                        throw new exception_1.Exception("Unable to delete the content for id: ".concat(contentID), err_8);
                     case 4: return [2 /*return*/];
                 }
             });
@@ -297,7 +351,7 @@ var ContentMethods = /** @class */ (function () {
     };
     ContentMethods.prototype.saveContentItem = function (contentItem_1, guid_1, locale_1) {
         return __awaiter(this, arguments, void 0, function (contentItem, guid, locale, returnBatchId) {
-            var apiPath, resp, batchID_7, batch, contentIDs_7, err_8;
+            var apiPath, resp, batchID_8, batch, contentIDs_7, err_9;
             var _this = this;
             if (returnBatchId === void 0) { returnBatchId = false; }
             return __generator(this, function (_a) {
@@ -308,14 +362,14 @@ var ContentMethods = /** @class */ (function () {
                         return [4 /*yield*/, this._clientInstance.executePost(apiPath, guid, this._options.token, contentItem)];
                     case 1:
                         resp = _a.sent();
-                        batchID_7 = resp.data;
+                        batchID_8 = resp.data;
                         // If user wants batchID immediately, return it for custom polling
                         if (returnBatchId) {
-                            return [2 /*return*/, [batchID_7]];
+                            return [2 /*return*/, [batchID_8]];
                         }
                         return [4 /*yield*/, this._batchMethods.Retry(function () { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
                                 switch (_a.label) {
-                                    case 0: return [4 /*yield*/, this._batchMethods.getBatch(batchID_7, guid)];
+                                    case 0: return [4 /*yield*/, this._batchMethods.getBatch(batchID_8, guid)];
                                     case 1: return [2 /*return*/, _a.sent()];
                                 }
                             }); }); })];
@@ -325,8 +379,8 @@ var ContentMethods = /** @class */ (function () {
                         batch.items.forEach(function (element) { return contentIDs_7.push(element.itemID); });
                         return [2 /*return*/, contentIDs_7];
                     case 3:
-                        err_8 = _a.sent();
-                        throw new exception_1.Exception('Unable to create content.', err_8);
+                        err_9 = _a.sent();
+                        throw new exception_1.Exception('Unable to create content.', err_9);
                     case 4: return [2 /*return*/];
                 }
             });
@@ -334,7 +388,7 @@ var ContentMethods = /** @class */ (function () {
     };
     ContentMethods.prototype.saveContentItems = function (contentItems_1, guid_1, locale_1) {
         return __awaiter(this, arguments, void 0, function (contentItems, guid, locale, returnBatchId) {
-            var apiPath, resp, batchID_8, batch, contentIDs_8, err_9;
+            var apiPath, resp, batchID_9, batch, contentIDs_8, err_10;
             var _this = this;
             if (returnBatchId === void 0) { returnBatchId = false; }
             return __generator(this, function (_a) {
@@ -345,14 +399,14 @@ var ContentMethods = /** @class */ (function () {
                         return [4 /*yield*/, this._clientInstance.executePost(apiPath, guid, this._options.token, contentItems)];
                     case 1:
                         resp = _a.sent();
-                        batchID_8 = resp.data;
+                        batchID_9 = resp.data;
                         // If user wants batchID immediately, return it for custom polling
                         if (returnBatchId) {
-                            return [2 /*return*/, [batchID_8]];
+                            return [2 /*return*/, [batchID_9]];
                         }
                         return [4 /*yield*/, this._batchMethods.Retry(function () { return __awaiter(_this, void 0, void 0, function () { return __generator(this, function (_a) {
                                 switch (_a.label) {
-                                    case 0: return [4 /*yield*/, this._batchMethods.getBatch(batchID_8, guid)];
+                                    case 0: return [4 /*yield*/, this._batchMethods.getBatch(batchID_9, guid)];
                                     case 1: return [2 /*return*/, _a.sent()];
                                 }
                             }); }); })];
@@ -362,8 +416,8 @@ var ContentMethods = /** @class */ (function () {
                         batch.items.forEach(function (element) { return contentIDs_8.push(element.itemID); });
                         return [2 /*return*/, contentIDs_8];
                     case 3:
-                        err_9 = _a.sent();
-                        throw new exception_1.Exception('Unable to create contents.', err_9);
+                        err_10 = _a.sent();
+                        throw new exception_1.Exception('Unable to create contents.', err_10);
                     case 4: return [2 /*return*/];
                 }
             });
@@ -371,7 +425,7 @@ var ContentMethods = /** @class */ (function () {
     };
     ContentMethods.prototype.getContentItems = function (referenceName, guid, locale, listParams) {
         return __awaiter(this, void 0, void 0, function () {
-            var queryParams, apiPath, resp, err_10;
+            var queryParams, apiPath, resp, err_11;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -390,8 +444,8 @@ var ContentMethods = /** @class */ (function () {
                         resp = _a.sent();
                         return [2 /*return*/, resp.data];
                     case 2:
-                        err_10 = _a.sent();
-                        throw new exception_1.Exception("Unable retrieve the content details for reference name: ".concat(referenceName), err_10);
+                        err_11 = _a.sent();
+                        throw new exception_1.Exception("Unable retrieve the content details for reference name: ".concat(referenceName), err_11);
                     case 3: return [2 /*return*/];
                 }
             });
@@ -399,7 +453,7 @@ var ContentMethods = /** @class */ (function () {
     };
     ContentMethods.prototype.getContentList = function (referenceName_1, guid_1, locale_1, listParams_1) {
         return __awaiter(this, arguments, void 0, function (referenceName, guid, locale, listParams, filterObject) {
-            var queryParams, apiPath, resp, err_11;
+            var queryParams, apiPath, resp, err_12;
             if (filterObject === void 0) { filterObject = null; }
             return __generator(this, function (_a) {
                 switch (_a.label) {
@@ -419,8 +473,8 @@ var ContentMethods = /** @class */ (function () {
                         resp = _a.sent();
                         return [2 /*return*/, resp.data];
                     case 2:
-                        err_11 = _a.sent();
-                        throw new exception_1.Exception("Unable retrieve the content details for list with reference name: ".concat(referenceName), err_11);
+                        err_12 = _a.sent();
+                        throw new exception_1.Exception("Unable retrieve the content details for list with reference name: ".concat(referenceName), err_12);
                     case 3: return [2 /*return*/];
                 }
             });
@@ -428,7 +482,7 @@ var ContentMethods = /** @class */ (function () {
     };
     ContentMethods.prototype.getContentHistory = function (locale_1, guid_1, contentID_1) {
         return __awaiter(this, arguments, void 0, function (locale, guid, contentID, take, skip) {
-            var apiPath, resp, err_12;
+            var apiPath, resp, err_13;
             if (take === void 0) { take = 50; }
             if (skip === void 0) { skip = 0; }
             return __generator(this, function (_a) {
@@ -441,7 +495,7 @@ var ContentMethods = /** @class */ (function () {
                         resp = _a.sent();
                         return [2 /*return*/, resp.data];
                     case 2:
-                        err_12 = _a.sent();
+                        err_13 = _a.sent();
                         throw new exception_1.Exception("Unable to retrieve history for contentID: ".concat(contentID));
                     case 3: return [2 /*return*/];
                 }
@@ -450,7 +504,7 @@ var ContentMethods = /** @class */ (function () {
     };
     ContentMethods.prototype.getContentComments = function (locale_1, guid_1, contentID_1) {
         return __awaiter(this, arguments, void 0, function (locale, guid, contentID, take, skip) {
-            var apiPath, resp, err_13;
+            var apiPath, resp, err_14;
             if (take === void 0) { take = 50; }
             if (skip === void 0) { skip = 0; }
             return __generator(this, function (_a) {
@@ -463,7 +517,7 @@ var ContentMethods = /** @class */ (function () {
                         resp = _a.sent();
                         return [2 /*return*/, resp.data];
                     case 2:
-                        err_13 = _a.sent();
+                        err_14 = _a.sent();
                         throw new exception_1.Exception("Unable to retrieve comments for contentID: ".concat(contentID));
                     case 3: return [2 /*return*/];
                 }

package/dist/apiMethods/instanceMethods.d.ts

@@ -1,9 +1,22 @@
 import { Options } from "../models/options";
 import { ClientInstance } from "./clientInstance";
 import { Locales } from "../models/locales";
+import { FetchApiStatus, FetchApiSyncMode } from "../models/fetchApiStatus";
 export declare class InstanceMethods {
     _options: Options;
     _clientInstance: ClientInstance;
     constructor(options: Options);
     getLocales(guid: string): Promise<Locales[]>;
+    /**
+     * Gets the Fetch API sync status for an instance.
+     * Use this to check if changes made via the Management API have propagated to the Fetch API CDNs.
+     * This is particularly useful after large batch operations or batch workflows to verify
+     * that content changes are available on the CDN before proceeding with dependent operations.
+     *
+     * @param guid - The website GUID
+     * @param mode - Sync mode: 'fetch' (live/published content) or 'preview' (preview content). Defaults to 'fetch'.
+     * @param waitForCompletion - If true, polls until sync is complete. Defaults to false.
+     * @returns The sync status including whether a sync is in progress and version information
+     */
+    getFetchApiStatus(guid: string, mode?: FetchApiSyncMode, waitForCompletion?: boolean): Promise<FetchApiStatus>;
 }

package/dist/apiMethods/instanceMethods.js

@@ -64,6 +64,54 @@ var InstanceMethods = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Gets the Fetch API sync status for an instance.
+     * Use this to check if changes made via the Management API have propagated to the Fetch API CDNs.
+     * This is particularly useful after large batch operations or batch workflows to verify
+     * that content changes are available on the CDN before proceeding with dependent operations.
+     *
+     * @param guid - The website GUID
+     * @param mode - Sync mode: 'fetch' (live/published content) or 'preview' (preview content). Defaults to 'fetch'.
+     * @param waitForCompletion - If true, polls until sync is complete. Defaults to false.
+     * @returns The sync status including whether a sync is in progress and version information
+     */
+    InstanceMethods.prototype.getFetchApiStatus = function (guid_1) {
+        return __awaiter(this, arguments, void 0, function (guid, mode, waitForCompletion) {
+            var apiPath, resp, resp, status_1, err_2;
+            if (mode === void 0) { mode = 'fetch'; }
+            if (waitForCompletion === void 0) { waitForCompletion = false; }
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 6, , 7]);
+                        apiPath = "fetch-api-status?mode=".concat(mode);
+                        if (!!waitForCompletion) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
+                    case 1:
+                        resp = _a.sent();
+                        return [2 /*return*/, resp.data];
+                    case 2:
+                        if (!true) return [3 /*break*/, 5];
+                        return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
+                    case 3:
+                        resp = _a.sent();
+                        status_1 = resp.data;
+                        if (!status_1.inProgress) {
+                            return [2 /*return*/, status_1];
+                        }
+                        return [4 /*yield*/, new Promise(function (resolve) { return setTimeout(resolve, 2000); })];
+                    case 4:
+                        _a.sent();
+                        return [3 /*break*/, 2];
+                    case 5: return [3 /*break*/, 7];
+                    case 6:
+                        err_2 = _a.sent();
+                        throw new exception_1.Exception("Unable to retrieve Fetch API status.", err_2);
+                    case 7: return [2 /*return*/];
+                }
+            });
+        });
+    };
     return InstanceMethods;
 }());
 exports.InstanceMethods = InstanceMethods;