@agility/management-sdk 0.1.35 → 0.1.37

package/dist/apiMethods/pageMethods.js

@@ -40,6 +40,8 @@ exports.PageMethods = void 0;
 var clientInstance_1 = require("./clientInstance");
 var batchMethods_1 = require("./batchMethods");
 var exception_1 = require("../models/exception");
+var batchState_1 = require("../enums/batchState.");
+var workflowOperationType_1 = require("../enums/workflowOperationType");
 var PageMethods = /** @class */ (function () {
     function PageMethods(options) {
         this._options = options;
@@ -285,9 +287,61 @@ var PageMethods = /** @class */ (function () {
             });
         });
     };
+    /**
+     * Perform a batch workflow operation on multiple pages.
+     * Supports Publish, Unpublish, Approve, Decline, and RequestApproval operations.
+     * @param pageIDs Array of page IDs to process
+     * @param guid The GUID of the user making the request
+     * @param locale The locale of the pages
+     * @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 pages
+     */
+    PageMethods.prototype.batchWorkflowPages = function (pageIDs_3, guid_1, locale_1, operation_1) {
+        return __awaiter(this, arguments, void 0, function (pageIDs, guid, locale, operation, returnBatchId) {
+            var pageIDsParam, operationName, apiPath, resp, batchID_3, batch, processedPageIDs_1, err_11;
+            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]);
+                        pageIDsParam = pageIDs.join(',');
+                        operationName = workflowOperationType_1.WorkflowOperationType[operation];
+                        apiPath = "".concat(locale, "/page/batch-workflow?pageIDs=").concat(pageIDsParam, "&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(), " pages. Batch is not completed. Error: ").concat(batch.errorData), null);
+                        }
+                        processedPageIDs_1 = [];
+                        batch.items.forEach(function (element) { return processedPageIDs_1.push(element.itemID); });
+                        return [2 /*return*/, processedPageIDs_1];
+                    case 3:
+                        err_11 = _a.sent();
+                        throw new exception_1.Exception("Unable to batch ".concat(workflowOperationType_1.WorkflowOperationType[operation].toLowerCase(), " pages."), err_11);
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
     PageMethods.prototype.pageRequestApproval = function (pageID_1, guid_1, locale_1) {
         return __awaiter(this, arguments, void 0, function (pageID, guid, locale, comments, returnBatchId) {
-            var apiPath, resp, batchID_3, batch, pageIDs_3, err_11;
+            var apiPath, resp, batchID_4, batch, pageIDs_3, err_12;
             var _this = this;
             if (comments === void 0) { comments = null; }
             if (returnBatchId === void 0) { returnBatchId = false; }
@@ -299,14 +353,14 @@ var PageMethods = /** @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()];
                                 }
                             }); }); })];
@@ -316,8 +370,8 @@ var PageMethods = /** @class */ (function () {
                         batch.items.forEach(function (element) { return pageIDs_3.push(element.itemID); });
                         return [2 /*return*/, pageIDs_3];
                     case 3:
-                        err_11 = _a.sent();
-                        throw new exception_1.Exception("Unable to request approval the page for id: ".concat(pageID), err_11);
+                        err_12 = _a.sent();
+                        throw new exception_1.Exception("Unable to request approval the page for id: ".concat(pageID), err_12);
                     case 4: return [2 /*return*/];
                 }
             });
@@ -325,7 +379,7 @@ var PageMethods = /** @class */ (function () {
     };
     PageMethods.prototype.approvePage = function (pageID_1, guid_1, locale_1) {
         return __awaiter(this, arguments, void 0, function (pageID, guid, locale, comments, returnBatchId) {
-            var apiPath, resp, batchID_4, batch, pageIDs_4, err_12;
+            var apiPath, resp, batchID_5, batch, pageIDs_4, err_13;
             var _this = this;
             if (comments === void 0) { comments = null; }
             if (returnBatchId === void 0) { returnBatchId = false; }
@@ -337,14 +391,14 @@ var PageMethods = /** @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()];
                                 }
                             }); }); })];
@@ -354,8 +408,8 @@ var PageMethods = /** @class */ (function () {
                         batch.items.forEach(function (element) { return pageIDs_4.push(element.itemID); });
                         return [2 /*return*/, pageIDs_4];
                     case 3:
-                        err_12 = _a.sent();
-                        throw new exception_1.Exception("Unable to approve the page for id: ".concat(pageID), err_12);
+                        err_13 = _a.sent();
+                        throw new exception_1.Exception("Unable to approve the page for id: ".concat(pageID), err_13);
                     case 4: return [2 /*return*/];
                 }
             });
@@ -363,7 +417,7 @@ var PageMethods = /** @class */ (function () {
     };
     PageMethods.prototype.declinePage = function (pageID_1, guid_1, locale_1) {
         return __awaiter(this, arguments, void 0, function (pageID, guid, locale, comments, returnBatchId) {
-            var apiPath, resp, batchID_5, batch, pageIDs_5, err_13;
+            var apiPath, resp, batchID_6, batch, pageIDs_5, err_14;
             var _this = this;
             if (comments === void 0) { comments = null; }
             if (returnBatchId === void 0) { returnBatchId = false; }
@@ -375,14 +429,14 @@ var PageMethods = /** @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()];
                                 }
                             }); }); })];
@@ -392,8 +446,8 @@ var PageMethods = /** @class */ (function () {
                         batch.items.forEach(function (element) { return pageIDs_5.push(element.itemID); });
                         return [2 /*return*/, pageIDs_5];
                     case 3:
-                        err_13 = _a.sent();
-                        throw new exception_1.Exception("Unable to decline the page for id: ".concat(pageID), err_13);
+                        err_14 = _a.sent();
+                        throw new exception_1.Exception("Unable to decline the page for id: ".concat(pageID), err_14);
                     case 4: return [2 /*return*/];
                 }
             });
@@ -401,7 +455,7 @@ var PageMethods = /** @class */ (function () {
     };
     PageMethods.prototype.deletePage = function (pageID_1, guid_1, locale_1) {
         return __awaiter(this, arguments, void 0, function (pageID, guid, locale, comments, returnBatchId) {
-            var apiPath, resp, batchID_6, batch, pageIDs_6, err_14;
+            var apiPath, resp, batchID_7, batch, pageIDs_6, err_15;
             var _this = this;
             if (comments === void 0) { comments = null; }
             if (returnBatchId === void 0) { returnBatchId = false; }
@@ -413,14 +467,14 @@ var PageMethods = /** @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()];
                                 }
                             }); }); })];
@@ -430,8 +484,8 @@ var PageMethods = /** @class */ (function () {
                         batch.items.forEach(function (element) { return pageIDs_6.push(element.itemID); });
                         return [2 /*return*/, pageIDs_6];
                     case 3:
-                        err_14 = _a.sent();
-                        throw new exception_1.Exception("Unable to delete the page for id: ".concat(pageID), err_14);
+                        err_15 = _a.sent();
+                        throw new exception_1.Exception("Unable to delete the page for id: ".concat(pageID), err_15);
                     case 4: return [2 /*return*/];
                 }
             });
@@ -452,7 +506,7 @@ var PageMethods = /** @class */ (function () {
      */
     PageMethods.prototype.savePage = function (pageItem_1, guid_1, locale_1) {
         return __awaiter(this, arguments, void 0, function (pageItem, guid, locale, parentPageID, placeBeforePageItemID, returnBatchId, pageIDInOtherLocale, otherLocale, linkExistingComponents) {
-            var apiPath, resp, batchID_7, batch, pageIDs_7, err_15;
+            var apiPath, resp, batchID_8, batch, pageIDs_7, err_16;
             var _this = this;
             if (parentPageID === void 0) { parentPageID = -1; }
             if (placeBeforePageItemID === void 0) { placeBeforePageItemID = -1; }
@@ -476,14 +530,14 @@ var PageMethods = /** @class */ (function () {
                         return [4 /*yield*/, this._clientInstance.executePost(apiPath, guid, this._options.token, pageItem)];
                     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()];
                                 }
                             }); }); })];
@@ -493,8 +547,8 @@ var PageMethods = /** @class */ (function () {
                         batch.items.forEach(function (element) { return pageIDs_7.push(element.itemID); });
                         return [2 /*return*/, pageIDs_7];
                     case 3:
-                        err_15 = _a.sent();
-                        throw new exception_1.Exception("Unable to create page. ".concat(err_15), err_15);
+                        err_16 = _a.sent();
+                        throw new exception_1.Exception("Unable to create page. ".concat(err_16), err_16);
                     case 4: return [2 /*return*/];
                 }
             });
@@ -502,7 +556,7 @@ var PageMethods = /** @class */ (function () {
     };
     PageMethods.prototype.getPageHistory = function (locale_1, guid_1, pageID_1) {
         return __awaiter(this, arguments, void 0, function (locale, guid, pageID, take, skip) {
-            var apiPath, resp, err_16;
+            var apiPath, resp, err_17;
             if (take === void 0) { take = 50; }
             if (skip === void 0) { skip = 0; }
             return __generator(this, function (_a) {
@@ -515,7 +569,7 @@ var PageMethods = /** @class */ (function () {
                         resp = _a.sent();
                         return [2 /*return*/, resp.data];
                     case 2:
-                        err_16 = _a.sent();
+                        err_17 = _a.sent();
                         throw new exception_1.Exception("Unable to retrieve history for pageID: ".concat(pageID));
                     case 3: return [2 /*return*/];
                 }
@@ -524,7 +578,7 @@ var PageMethods = /** @class */ (function () {
     };
     PageMethods.prototype.getPageComments = function (locale_1, guid_1, pageID_1) {
         return __awaiter(this, arguments, void 0, function (locale, guid, pageID, take, skip) {
-            var apiPath, resp, err_17;
+            var apiPath, resp, err_18;
             if (take === void 0) { take = 50; }
             if (skip === void 0) { skip = 0; }
             return __generator(this, function (_a) {
@@ -537,7 +591,7 @@ var PageMethods = /** @class */ (function () {
                         resp = _a.sent();
                         return [2 /*return*/, resp.data];
                     case 2:
-                        err_17 = _a.sent();
+                        err_18 = _a.sent();
                         throw new exception_1.Exception("Unable to retrieve history for pageID: ".concat(pageID));
                     case 3: return [2 /*return*/];
                 }

package/dist/enums/contentViewType.d.ts

@@ -0,0 +1,6 @@
+export declare enum ContentViewType {
+    All = 0,
+    Shared = 1,
+    Linked = 2,
+    DynamicPageList = 3
+}

package/dist/enums/contentViewType.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContentViewType = void 0;
+var ContentViewType;
+(function (ContentViewType) {
+    ContentViewType[ContentViewType["All"] = 0] = "All";
+    ContentViewType[ContentViewType["Shared"] = 1] = "Shared";
+    ContentViewType[ContentViewType["Linked"] = 2] = "Linked";
+    ContentViewType[ContentViewType["DynamicPageList"] = 3] = "DynamicPageList";
+})(ContentViewType || (exports.ContentViewType = ContentViewType = {}));

package/dist/index.d.ts

@@ -13,6 +13,7 @@ export * from "./models/media";
 export * from "./models/model";
 export * from "./models/notification";
 export * from "./models/pageItem";
+export * from "./models/pagedResult";
 export * from "./models/sitemap";
 export * from "./models/websiteUser";
 export * from "./models/assetContainer";
@@ -27,4 +28,5 @@ export * from "./enums/batchOperationType";
 export * from "./enums/workflowOperationType";
 export * from "./enums/batchState.";
 export * from "./enums/batchItemType";
+export * from "./enums/contentViewType";
 export * from "./apiClient";

package/dist/index.js

@@ -29,6 +29,7 @@ __exportStar(require("./models/media"), exports);
 __exportStar(require("./models/model"), exports);
 __exportStar(require("./models/notification"), exports);
 __exportStar(require("./models/pageItem"), exports);
+__exportStar(require("./models/pagedResult"), exports);
 __exportStar(require("./models/sitemap"), exports);
 __exportStar(require("./models/websiteUser"), exports);
 __exportStar(require("./models/assetContainer"), exports);
@@ -43,4 +44,5 @@ __exportStar(require("./enums/batchOperationType"), exports);
 __exportStar(require("./enums/workflowOperationType"), exports);
 __exportStar(require("./enums/batchState."), exports);
 __exportStar(require("./enums/batchItemType"), exports);
+__exportStar(require("./enums/contentViewType"), exports);
 __exportStar(require("./apiClient"), exports);

package/dist/models/pagedResult.d.ts

@@ -0,0 +1,4 @@
+export interface PagedResult<T> {
+    totalCount: number;
+    items: T[];
+}

package/dist/models/pagedResult.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/util/queryString.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Builds a query string from an object of parameters.
+ * Only includes parameters that have actual values (skips undefined, null, and empty strings).
+ *
+ * @param params - Object containing key-value pairs for query parameters
+ * @returns Query string starting with '?' if parameters exist, empty string otherwise
+ */
+export declare function buildQueryString(params: Record<string, any>): string;

package/dist/util/queryString.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildQueryString = buildQueryString;
+/**
+ * Builds a query string from an object of parameters.
+ * Only includes parameters that have actual values (skips undefined, null, and empty strings).
+ *
+ * @param params - Object containing key-value pairs for query parameters
+ * @returns Query string starting with '?' if parameters exist, empty string otherwise
+ */
+function buildQueryString(params) {
+    var queryParams = [];
+    for (var _i = 0, _a = Object.entries(params); _i < _a.length; _i++) {
+        var _b = _a[_i], key = _b[0], value = _b[1];
+        // Skip undefined and null values
+        if (value === undefined || value === null) {
+            continue;
+        }
+        // Skip empty strings
+        if (typeof value === 'string' && value === '') {
+            continue;
+        }
+        // Include all other values (numbers including 0, booleans including false, non-empty strings)
+        queryParams.push("".concat(encodeURIComponent(key), "=").concat(encodeURIComponent(value)));
+    }
+    return queryParams.length > 0 ? "?".concat(queryParams.join('&')) : '';
+}