@agility/management-sdk 0.1.3 → 0.1.4-beta.1

package/dist/apiMethods/containerMethods.js

@@ -9,12 +9,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
     function verb(n) { return function (v) { return step([n, v]); }; }
     function step(op) {
         if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
             if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
             if (y = 0, t) op = [op[0] & 2, t.value];
             switch (op[0]) {
@@ -42,143 +42,175 @@ var exception_1 = require("../models/exception");
 var ContainerMethods = /** @class */ (function () {
     function ContainerMethods(options) {
         this._options = options;
-        this._clientInstance = new clientInstance_1.ClientInstance();
+        this._clientInstance = new clientInstance_1.ClientInstance(this._options);
     }
-    ContainerMethods.prototype.getContainerByID = function (id) {
+    ContainerMethods.prototype.getContainerByID = function (id, guid) {
         return __awaiter(this, void 0, void 0, function () {
             var apiPath, resp, err_1;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         _a.trys.push([0, 2, , 3]);
-                        apiPath = "container/" + id;
-                        return [4 /*yield*/, this._clientInstance.executeGet(apiPath, this._options)];
+                        apiPath = "container/".concat(id);
+                        return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
                     case 1:
                         resp = _a.sent();
                         return [2 /*return*/, resp.data];
                     case 2:
                         err_1 = _a.sent();
-                        throw new exception_1.Exception("Unable to retreive the contianer for id: " + id, err_1);
+                        throw new exception_1.Exception("Unable to retrieve the container for id: ".concat(id), err_1);
                     case 3: return [2 /*return*/];
                 }
             });
         });
     };
-    ContainerMethods.prototype.getContainerByReferenceName = function (referenceName) {
+    ContainerMethods.prototype.getContainersByModel = function (modelId, guid) {
         return __awaiter(this, void 0, void 0, function () {
             var apiPath, resp, err_2;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         _a.trys.push([0, 2, , 3]);
-                        apiPath = "container/" + referenceName;
-                        return [4 /*yield*/, this._clientInstance.executeGet(apiPath, this._options)];
+                        apiPath = "container/model/".concat(modelId);
+                        return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
                     case 1:
                         resp = _a.sent();
                         return [2 /*return*/, resp.data];
                     case 2:
                         err_2 = _a.sent();
-                        throw new exception_1.Exception("Unable to retreive the contianer for referenceName: " + referenceName, err_2);
+                        throw new exception_1.Exception("Unable to retrieve the containers for id: ".concat(modelId), err_2);
                     case 3: return [2 /*return*/];
                 }
             });
         });
     };
-    ContainerMethods.prototype.getContainerSecurity = function (id) {
+    /**
+     * Retrieves a container by its reference name.
+     * Returns the container if found, or null if the container does not exist (404 error).
+     * @param referenceName - The reference name of the container.
+     * @param guid - The GUID for authentication.
+     * @returns The container or null if not found.
+     */
+    ContainerMethods.prototype.getContainerByReferenceName = function (referenceName, guid) {
         return __awaiter(this, void 0, void 0, function () {
             var apiPath, resp, err_3;
-            return __generator(this, function (_a) {
-                switch (_a.label) {
+            var _a;
+            return __generator(this, function (_b) {
+                switch (_b.label) {
                     case 0:
-                        _a.trys.push([0, 2, , 3]);
-                        apiPath = "container/" + id + "/security";
-                        return [4 /*yield*/, this._clientInstance.executeGet(apiPath, this._options)];
+                        _b.trys.push([0, 2, , 3]);
+                        apiPath = "container/".concat(referenceName);
+                        return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
                     case 1:
-                        resp = _a.sent();
+                        resp = _b.sent();
                         return [2 /*return*/, resp.data];
                     case 2:
-                        err_3 = _a.sent();
-                        throw new exception_1.Exception("Unable to retreive the contianer for id: " + id, err_3);
+                        err_3 = _b.sent();
+                        if (((_a = err_3.response) === null || _a === void 0 ? void 0 : _a.status) === 404) {
+                            return [2 /*return*/, null]; // If the container is not found, return null
+                        }
+                        throw new exception_1.Exception("Unable to retrieve the container for referenceName: ".concat(referenceName), err_3);
                     case 3: return [2 /*return*/];
                 }
             });
         });
     };
-    ContainerMethods.prototype.getContainerList = function () {
+    ContainerMethods.prototype.getContainerSecurity = function (id, guid) {
         return __awaiter(this, void 0, void 0, function () {
             var apiPath, resp, err_4;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         _a.trys.push([0, 2, , 3]);
-                        apiPath = "container/list";
-                        return [4 /*yield*/, this._clientInstance.executeGet(apiPath, this._options)];
+                        apiPath = "container/".concat(id, "/security");
+                        return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
                     case 1:
                         resp = _a.sent();
                         return [2 /*return*/, resp.data];
                     case 2:
                         err_4 = _a.sent();
-                        throw new exception_1.Exception("Unable to retreive the contianer list", err_4);
+                        throw new exception_1.Exception("Unable to retrieve the container for id: ".concat(id), err_4);
                     case 3: return [2 /*return*/];
                 }
             });
         });
     };
-    ContainerMethods.prototype.getNotificationList = function (id) {
+    ContainerMethods.prototype.getContainerList = function (guid) {
         return __awaiter(this, void 0, void 0, function () {
             var apiPath, resp, err_5;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         _a.trys.push([0, 2, , 3]);
-                        apiPath = "container/" + id + "/notifications";
-                        return [4 /*yield*/, this._clientInstance.executeGet(apiPath, this._options)];
+                        apiPath = "container/list";
+                        return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
                     case 1:
                         resp = _a.sent();
                         return [2 /*return*/, resp.data];
                     case 2:
                         err_5 = _a.sent();
-                        throw new exception_1.Exception("Unable to retreive the notifications for contianer id: " + id, err_5);
+                        throw new exception_1.Exception("Unable to retrieve the container list", err_5);
                     case 3: return [2 /*return*/];
                 }
             });
         });
     };
-    ContainerMethods.prototype.saveContainer = function (container) {
+    ContainerMethods.prototype.getNotificationList = function (id, guid) {
         return __awaiter(this, void 0, void 0, function () {
             var apiPath, resp, err_6;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         _a.trys.push([0, 2, , 3]);
-                        apiPath = "container";
-                        return [4 /*yield*/, this._clientInstance.executePost(apiPath, this._options, container)];
+                        apiPath = "container/".concat(id, "/notifications");
+                        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 save the contianer", err_6);
+                        throw new exception_1.Exception("Unable to retrieve the notifications for container id: ".concat(id), err_6);
                     case 3: return [2 /*return*/];
                 }
             });
         });
     };
-    ContainerMethods.prototype.deleteContainer = function (id) {
-        return __awaiter(this, void 0, void 0, function () {
+    ContainerMethods.prototype.saveContainer = function (container_1, guid_1) {
+        return __awaiter(this, arguments, void 0, function (container, guid, forceReferenceName) {
             var apiPath, resp, err_7;
+            if (forceReferenceName === void 0) { forceReferenceName = false; }
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
                         _a.trys.push([0, 2, , 3]);
-                        apiPath = "container/" + id;
-                        return [4 /*yield*/, this._clientInstance.executeDelete(apiPath, this._options)];
+                        apiPath = "container".concat(forceReferenceName ? '?forceReferenceName=true' : '');
+                        return [4 /*yield*/, this._clientInstance.executePost(apiPath, guid, this._options.token, container)];
                     case 1:
                         resp = _a.sent();
                         return [2 /*return*/, resp.data];
                     case 2:
                         err_7 = _a.sent();
-                        throw new exception_1.Exception("Unable to delete the contianer for id: " + id, err_7);
+                        throw new exception_1.Exception("Unable to save the container", err_7);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    ContainerMethods.prototype.deleteContainer = function (id, guid) {
+        return __awaiter(this, void 0, void 0, function () {
+            var apiPath, resp, err_8;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        apiPath = "container/".concat(id);
+                        return [4 /*yield*/, this._clientInstance.executeDelete(apiPath, guid, this._options.token)];
+                    case 1:
+                        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);
                     case 3: return [2 /*return*/];
                 }
             });

package/dist/apiMethods/containerMethods.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"containerMethods.js","sourceRoot":"","sources":["../../src/apiMethods/containerMethods.ts"],"names":[],"mappings":";;;AACA,qDAAkD;AAGlD,mDAAgD;AAEhD,MAAa,gBAAgB;IAIzB,YAAY,OAAgB;QACxB,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QACxB,IAAI,CAAC,eAAe,GAAG,IAAI,+BAAc,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC7D,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,EAAU,EAAE,IAAY;QAC3C,IAAG,CAAC;YACA,IAAI,OAAO,GAAG,aAAa,EAAE,EAAE,CAAC;YAChC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAEvF,OAAO,IAAiB,CAAC;QAC7B,CAAC;QAAC,OAAM,GAAQ,EAAC,CAAC;YACd,MAAM,IAAI,qBAAS,CAAC,4CAA4C,EAAE,EAAE,EAAE,GAAY,CAAC,CAAC;QACxF,CAAC;IACL,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,OAAe,EAAE,IAAY;QACpD,IAAG,CAAC;YACA,IAAI,OAAO,GAAG,mBAAmB,OAAO,EAAE,CAAC;YAC3C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAEvF,OAAO,IAAmB,CAAC;QAC/B,CAAC;QAAC,OAAM,GAAQ,EAAC,CAAC;YACd,MAAM,IAAI,qBAAS,CAAC,6CAA6C,OAAO,EAAE,EAAE,GAAY,CAAC,CAAC;QAC9F,CAAC;IACL,CAAC;IAED,KAAK,CAAC,2BAA2B,CAAC,aAAqB,EAAE,IAAY;QACjE,IAAG,CAAC;YACA,IAAI,OAAO,GAAG,aAAa,aAAa,EAAE,CAAC;YAC3C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAEvF,OAAO,IAAiB,CAAC;QAC7B,CAAC;QAAC,OAAM,GAAQ,EAAC,CAAC;YACd,MAAM,IAAI,qBAAS,CAAC,uDAAuD,aAAa,EAAE,EAAE,GAAY,CAAC,CAAC;QAC9G,CAAC;IACL,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAC,EAAU,EAAE,IAAY;QAC/C,IAAG,CAAC;YACA,IAAI,OAAO,GAAG,aAAa,EAAE,WAAW,CAAC;YACzC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAEvF,OAAO,IAAiB,CAAC;QAC7B,CAAC;QAAC,OAAM,GAAQ,EAAC,CAAC;YACd,MAAM,IAAI,qBAAS,CAAC,4CAA4C,EAAE,EAAE,EAAE,GAAY,CAAC,CAAC;QACxF,CAAC;IACL,CAAC;IAED,KAAK,CAAC,gBAAgB,CAAC,IAAY;QAC/B,IAAG,CAAC;YACA,IAAI,OAAO,GAAG,gBAAgB,CAAC;YAC/B,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAEvF,OAAO,IAAmB,CAAC;QAC/B,CAAC;QAAC,OAAM,GAAQ,EAAC,CAAC;YACd,MAAM,IAAI,qBAAS,CAAC,uCAAuC,EAAE,GAAY,CAAC,CAAC;QAC/E,CAAC;IACL,CAAC;IAED,KAAK,CAAC,mBAAmB,CAAC,EAAU,EAAE,IAAY;QAC9C,IAAG,CAAC;YACA,IAAI,OAAO,GAAG,aAAa,EAAE,gBAAgB,CAAC;YAC9C,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAEvF,OAAO,IAAsB,CAAC;QAClC,CAAC;QAAC,OAAM,GAAQ,EAAC,CAAC;YACd,MAAM,IAAI,qBAAS,CAAC,0DAA0D,EAAE,EAAE,EAAE,GAAY,CAAC,CAAC;QACtG,CAAC;IACL,CAAC;IAED,KAAK,CAAC,aAAa,CAAC,SAAoB,EAAE,IAAY,EAAE,qBAA8B,KAAK;QACvF,IAAG,CAAC;YACA,IAAI,OAAO,GAAG,YAAY,kBAAkB,CAAC,CAAC,CAAC,0BAA0B,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC;YACjF,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;YAEnG,OAAO,IAAiB,CAAC;QAC7B,CAAC;QAAC,OAAM,GAAQ,EAAC,CAAC;YACd,MAAM,IAAI,qBAAS,CAAC,8BAA8B,EAAE,GAAY,CAAC,CAAC;QACtE,CAAC;IACL,CAAC;IAED,KAAK,CAAC,eAAe,CAAC,EAAU,EAAE,IAAY;QAC1C,IAAG,CAAC;YACA,IAAI,OAAO,GAAG,aAAa,EAAE,EAAE,CAAC;YAChC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAE1F,OAAO,MAAM,IAAI,CAAC,IAAI,EAAY,CAAC;QACvC,CAAC;QAAC,OAAM,GAAQ,EAAC,CAAC;YACd,MAAM,IAAI,qBAAS,CAAC,0CAA0C,EAAE,EAAE,EAAE,GAAY,CAAC,CAAC;QACtF,CAAC;IACL,CAAC;CACJ;AAhGD,4CAgGC"}

package/dist/apiMethods/contentMethods.d.ts

@@ -2,19 +2,26 @@ import { Options } from "../models/options";
 import { ClientInstance } from "./clientInstance";
 import { ContentItem, ContentList } from "../models/contentItem";
 import { BatchMethods } from "./batchMethods";
+import { ContentListFilterModel } from "../models/contentListFilterModel";
+import { ContentItemHistory } from "../models/contentItemHistory";
+import { ItemComments } from "../models/itemComments";
+import { ListParams } from "../models/listParams";
 export declare class ContentMethods {
     _options: Options;
     _clientInstance: ClientInstance;
     _batchMethods: BatchMethods;
     constructor(options: Options);
-    getContentItem(contentID: number): Promise<ContentItem>;
-    publishContent(contentID: number, comments?: string): Promise<number[]>;
-    unPublishContent(contentID: number, comments?: string): Promise<number[]>;
-    contentRequestApproval(contentID: number, comments?: string): Promise<number[]>;
-    approveContent(contentID: number, comments?: string): Promise<number[]>;
-    declineContent(contentID: number, comments?: string): Promise<number[]>;
-    deleteContent(contentID: number, comments?: string): Promise<number[]>;
-    saveContentItem(contentItem: ContentItem): Promise<number[]>;
-    saveContentItems(contentItems: ContentItem[]): Promise<number[]>;
-    getContentItems(referenceName: string, filter?: string, fields?: string, sortDirection?: string, sortField?: string, take?: number, skip?: number): Promise<ContentList>;
+    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[]>;
+    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[]>;
+    deleteContent(contentID: number, guid: string, locale: string, comments?: string, returnBatchId?: boolean): Promise<number[]>;
+    saveContentItem(contentItem: ContentItem, guid: string, locale: string, returnBatchId?: boolean): Promise<number[]>;
+    saveContentItems(contentItems: ContentItem[], guid: string, locale: string, returnBatchId?: boolean): Promise<number[]>;
+    getContentItems(referenceName: string, guid: string, locale: string, listParams: ListParams): Promise<ContentList>;
+    getContentList(referenceName: string, guid: string, locale: string, listParams: ListParams, filterObject?: ContentListFilterModel): Promise<ContentList>;
+    getContentHistory(locale: string, guid: string, contentID: number, take?: number, skip?: number): Promise<ContentItemHistory>;
+    getContentComments(locale: string, guid: string, contentID: number, take?: number, skip?: number): Promise<ItemComments>;
 }