@agility/management-sdk 0.1.16 → 0.1.17

package/dist/src/apiMethods/assetMethods.js

@@ -0,0 +1,172 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+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;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) 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]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AssetMethods = void 0;
+var clientInstance_1 = require("./clientInstance");
+var exception_1 = require("../models/exception");
+var AssetMethods = /** @class */ (function () {
+    function AssetMethods(options) {
+        this._options = options;
+        this._clientInstance = new clientInstance_1.ClientInstance();
+    }
+    AssetMethods.prototype.deleteFile = function (mediaID, 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 = "asset/delete/".concat(mediaID);
+                        return [4 /*yield*/, this._clientInstance.executeDelete(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 delete the media for mediaID: ".concat(mediaID), err_1);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AssetMethods.prototype.moveFile = function (mediaID, newFolder, guid) {
+        return __awaiter(this, void 0, void 0, function () {
+            var folder, apiPath, resp, err_2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        folder = encodeURIComponent(newFolder);
+                        apiPath = "asset/move/".concat(mediaID, "?newFolder=").concat(folder);
+                        return [4 /*yield*/, this._clientInstance.executePost(apiPath, guid, this._options.token, null)];
+                    case 1:
+                        resp = _a.sent();
+                        return [2 /*return*/, resp.data];
+                    case 2:
+                        err_2 = _a.sent();
+                        throw new exception_1.Exception("Unable to move the media for mediaID: ".concat(mediaID), err_2);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AssetMethods.prototype.getMediaList = function (pageSize, recordOffset, guid) {
+        return __awaiter(this, void 0, void 0, function () {
+            var apiPath, resp, err_3;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        apiPath = "asset/list?pageSize=".concat(pageSize, "&recordOffset=").concat(recordOffset);
+                        return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
+                    case 1:
+                        resp = _a.sent();
+                        return [2 /*return*/, resp.data];
+                    case 2:
+                        err_3 = _a.sent();
+                        throw new exception_1.Exception("Unable to retrieve assets for the website.", err_3);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AssetMethods.prototype.getAssetByID = function (mediaID, 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 = "asset/".concat(mediaID);
+                        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 retrieve asset for mediaID ".concat(mediaID), err_4);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AssetMethods.prototype.getAssetByUrl = function (url, 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 = "asset?url=".concat(url);
+                        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 retrieve asset for url ".concat(url), err_5);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AssetMethods.prototype.upload = function (formData, agilityFolderPath, guid, groupingID) {
+        if (groupingID === void 0) { groupingID = -1; }
+        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 = "asset/upload?folderPath=".concat(agilityFolderPath, "&groupingID=").concat(groupingID);
+                        return [4 /*yield*/, this._clientInstance.executePost(apiPath, guid, this._options.token, formData)];
+                    case 1:
+                        resp = _a.sent();
+                        return [2 /*return*/, resp.data];
+                    case 2:
+                        err_6 = _a.sent();
+                        throw new exception_1.Exception("Unable to upload media.", err_6);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    return AssetMethods;
+}());
+exports.AssetMethods = AssetMethods;

package/dist/src/apiMethods/batchMethods.d.ts

@@ -0,0 +1,11 @@
+import { Options } from "../models/options";
+import { ClientInstance } from "./clientInstance";
+import { Batch } from "../models/batch";
+export declare class BatchMethods {
+    _options: Options;
+    _clientInstance: ClientInstance;
+    constructor(options: Options);
+    getBatch(batchID: number, guid: string): Promise<Batch>;
+    Retry(method: Function): Promise<Batch>;
+    delay(ms: number): Promise<unknown>;
+}

package/dist/src/apiMethods/batchMethods.js

@@ -0,0 +1,117 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+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;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) 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]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BatchMethods = void 0;
+var clientInstance_1 = require("./clientInstance");
+var batchState_1 = require("../enums/batchState.");
+var exception_1 = require("../models/exception");
+var BatchMethods = /** @class */ (function () {
+    function BatchMethods(options) {
+        this._options = options;
+        this._clientInstance = new clientInstance_1.ClientInstance();
+    }
+    BatchMethods.prototype.getBatch = function (batchID, 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 = "batch/".concat(batchID);
+                        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 batch for id: ".concat(batchID), err_1);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    BatchMethods.prototype.Retry = function (method) {
+        return __awaiter(this, void 0, void 0, function () {
+            var retryCount, duration, batch, err_2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        retryCount = this._options.retryCount;
+                        duration = this._options.duration;
+                        if (retryCount <= 0)
+                            throw new Error('Number of retries has been exhausted.');
+                        _a.label = 1;
+                    case 1:
+                        if (!true) return [3 /*break*/, 9];
+                        _a.label = 2;
+                    case 2:
+                        _a.trys.push([2, 7, , 8]);
+                        return [4 /*yield*/, method()];
+                    case 3:
+                        batch = _a.sent();
+                        if (!(batch.batchState === batchState_1.BatchState.Processed)) return [3 /*break*/, 4];
+                        return [2 /*return*/, batch];
+                    case 4:
+                        --retryCount;
+                        if (--retryCount <= 0) {
+                            throw new Error('Timeout exceeded but operation still in progress. Please check the Batches page in the Agility Content Manager app.');
+                        }
+                        return [4 /*yield*/, this.delay(duration)];
+                    case 5:
+                        _a.sent();
+                        _a.label = 6;
+                    case 6: return [3 /*break*/, 8];
+                    case 7:
+                        err_2 = _a.sent();
+                        throw new Error('Timeout exceeded but operation still in progress. Please check the Batches page in the Agility Content Manager app.');
+                    case 8: return [3 /*break*/, 1];
+                    case 9: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    BatchMethods.prototype.delay = function (ms) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2 /*return*/, new Promise(function (resolve) { return setTimeout(resolve, ms); })];
+            });
+        });
+    };
+    return BatchMethods;
+}());
+exports.BatchMethods = BatchMethods;

package/dist/src/apiMethods/clientInstance.d.ts

@@ -0,0 +1,8 @@
+import { AxiosInstance } from 'axios';
+export declare class ClientInstance {
+    determineBaseUrl(guid: string): string;
+    getInstance(guid: string): AxiosInstance;
+    executeGet(apiPath: string, guid: string, token: string): Promise<import("axios").AxiosResponse<any, any>>;
+    executeDelete(apiPath: string, guid: string, token: string): Promise<import("axios").AxiosResponse<any, any>>;
+    executePost(apiPath: string, guid: string, token: string, data: any): Promise<import("axios").AxiosResponse<any, any>>;
+}

package/dist/src/apiMethods/clientInstance.js

@@ -0,0 +1,156 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+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;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) 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]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientInstance = void 0;
+var axios_1 = __importDefault(require("axios"));
+var ClientInstance = /** @class */ (function () {
+    function ClientInstance() {
+    }
+    ClientInstance.prototype.determineBaseUrl = function (guid) {
+        var seperator = guid.split('-');
+        if (seperator[1] === 'd') {
+            return "https://mgmt-dev.aglty.io";
+        }
+        else if (seperator[1] === 'u') {
+            return "https://mgmt.aglty.io";
+        }
+        else if (seperator[1] === 'ca') {
+            return "https://mgmt-ca.aglty.io";
+        }
+        else if (seperator[1] === 'eu') {
+            return "https://mgmt-aus.aglty.io";
+        }
+        else if (seperator[1] === 'aus') {
+            return "https://mgmt-aus.aglty.io";
+        }
+        return "https://mgmt.aglty.io";
+    };
+    ClientInstance.prototype.getInstance = function (guid) {
+        var baseUrl = this.determineBaseUrl(guid);
+        var instance = axios_1.default.create({
+            baseURL: "".concat(baseUrl, "/api/v1/instance/").concat(guid)
+        });
+        return instance;
+    };
+    ClientInstance.prototype.executeGet = function (apiPath, guid, token) {
+        return __awaiter(this, void 0, void 0, function () {
+            var instance, resp, err_1;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        instance = this.getInstance(guid);
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, instance.get(apiPath, {
+                                headers: {
+                                    'Authorization': "Bearer ".concat(token),
+                                    'Cache-Control': 'no-cache'
+                                }
+                            })];
+                    case 2:
+                        resp = _a.sent();
+                        return [2 /*return*/, resp];
+                    case 3:
+                        err_1 = _a.sent();
+                        throw err_1;
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    ClientInstance.prototype.executeDelete = function (apiPath, guid, token) {
+        return __awaiter(this, void 0, void 0, function () {
+            var instance, resp, err_2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        instance = this.getInstance(guid);
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, instance.delete(apiPath, {
+                                headers: {
+                                    'Authorization': "Bearer ".concat(token),
+                                    'Cache-Control': 'no-cache'
+                                }
+                            })];
+                    case 2:
+                        resp = _a.sent();
+                        return [2 /*return*/, resp];
+                    case 3:
+                        err_2 = _a.sent();
+                        throw err_2;
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    ClientInstance.prototype.executePost = function (apiPath, guid, token, data) {
+        return __awaiter(this, void 0, void 0, function () {
+            var instance, resp, err_3;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        instance = this.getInstance(guid);
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, instance.post(apiPath, data, {
+                                headers: {
+                                    'Authorization': "Bearer ".concat(token),
+                                    'Cache-Control': 'no-cache'
+                                }
+                            })];
+                    case 2:
+                        resp = _a.sent();
+                        return [2 /*return*/, resp];
+                    case 3:
+                        err_3 = _a.sent();
+                        throw err_3;
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    return ClientInstance;
+}());
+exports.ClientInstance = ClientInstance;

package/dist/src/apiMethods/containerMethods.d.ts

@@ -0,0 +1,16 @@
+import { Options } from "../models/options";
+import { ClientInstance } from "./clientInstance";
+import { Container } from "../models/container";
+import { Notification } from "../models/notification";
+export declare class ContainerMethods {
+    _options: Options;
+    _clientInstance: ClientInstance;
+    constructor(options: Options);
+    getContainerByID(id: number, guid: string): Promise<Container>;
+    getContainerByReferenceName(referenceName: string, guid: string): Promise<Container>;
+    getContainerSecurity(id: number, guid: string): Promise<Container>;
+    getContainerList(guid: string): Promise<Container[]>;
+    getNotificationList(id: number, guid: string): Promise<Notification[]>;
+    saveContainer(container: Container, guid: string): Promise<Container>;
+    deleteContainer(id: number, guid: string): Promise<string>;
+}