@agility/management-sdk 0.1.8 → 0.1.10

package/README.md

@@ -23,10 +23,10 @@ import * as index from "./index";
 //initialize the Options Class
 let options = new index.Options();
 
+options.token = "<<Provide Auth Token>>"
 //Initialize the APIClient Class
 let apiClient = new index.ApiClient(options);
 
-let token = "<<Provide Auth Token>>";
 let guid = "<<Provide the Guid of the Website>>";
 let locale = "<<Provide the locale of the Website>>"; //Example: en-us
 
@@ -51,6 +51,14 @@ This class is used to perform operations related to Assets. The following are th
 
 Returns: A collection of ```Media``` class Object.
 
+### createFolder
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `originKey` | `string` | The origin key of the requested folder.  |
+| `guid` | `string` | Current website guid.|
+
+Returns: A collection of ```Media``` class Object.
+
 ### deleteFile
 | Parameter | Type     | Description                |
 | :-------- | :------- | :------------------------- |
@@ -77,6 +85,55 @@ Returns: An object of ```Media``` class with the new location of the file.
 
 Returns: An object of ```AssetMediaList``` class.
 
+### getGalleryById
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `guid` | `string` | Current website guid.|
+| `id` | `number` | The ID of the requested gallery.|
+
+Returns: An object of ```assetMediaGrouping``` class.
+
+### getGalleryByName
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `guid` | `string` | Current website guid.|
+| `galleryName` | `string` | The name of the requested gallery.|
+
+Returns: An object of ```assetMediaGrouping``` class.
+
+### getDefaultContainer
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `guid` | `string` | Current website guid.|
+
+Returns: An object of ```assetContainer``` class.
+
+### getGalleries
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `guid` | `string` | Current website guid.|
+| `search` | `string` | String to search a specific gallery item.|
+| `pageSize` | `number` | The pageSize on which the galleries needs to be selected.|
+| `rowIndex` | `number` | The rowIndex value for the resultant record set.|
+
+Returns: An object of ```assetGalleries``` class.
+
+### saveGallery
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `guid` | `string` | Current website guid.|
+| `gallery` | `assetMediaGrouping` | Object of AssetMediaGrouping class.|
+
+Returns: An object of ```assetMediaGrouping``` class.
+
+### deleteGallery
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `guid` | `string` | Current website guid.|
+| `id` | `number` | The id of the gallery to be deleted.|
+
+A ```string``` response if the gallery has been deleted.
+
 ### getAssetByID
 | Parameter | Type     | Description                |
 | :-------- | :------- | :------------------------- |

package/dist/apiMethods/assetMethods.d.ts

@@ -1,6 +1,9 @@
 import { Options } from "../models/options";
 import { ClientInstance } from "./clientInstance";
 import { AssetMediaList, Media } from "../models/media";
+import { assetGalleries } from "../models/assetGalleries";
+import { assetMediaGrouping } from "../models/assetMediaGrouping";
+import { assetContainer } from "../models/assetContainer";
 export declare class AssetMethods {
     _options: Options;
     _clientInstance: ClientInstance;
@@ -8,7 +11,14 @@ export declare class AssetMethods {
     deleteFile(mediaID: number, guid: string): Promise<string>;
     moveFile(mediaID: number, newFolder: string, guid: string): Promise<Media>;
     getMediaList(pageSize: number, recordOffset: number, guid: string): Promise<AssetMediaList>;
+    getGalleries(guid: string, search?: string, pageSize?: number, rowIndex?: number): Promise<assetGalleries>;
+    getGalleryById(guid: string, id: number): Promise<assetMediaGrouping>;
+    getGalleryByName(guid: string, galleryName: string): Promise<assetMediaGrouping>;
+    getDefaultContainer(guid: string): Promise<assetContainer>;
+    saveGallery(guid: string, gallery: assetMediaGrouping): Promise<assetMediaGrouping>;
+    deleteGallery(guid: string, id: number): Promise<string>;
     getAssetByID(mediaID: number, guid: string): Promise<Media>;
     getAssetByUrl(url: string, guid: string): Promise<Media>;
     upload(formData: FormData, agilityFolderPath: string, guid: string, groupingID?: number): Promise<Media[]>;
+    createFolder(originKey: string, guid: string): Promise<Media>;
 }

package/dist/apiMethods/assetMethods.js

@@ -106,41 +106,164 @@ var AssetMethods = /** @class */ (function () {
             });
         });
     };
-    AssetMethods.prototype.getAssetByID = function (mediaID, guid) {
+    AssetMethods.prototype.getGalleries = function (guid, search, pageSize, rowIndex) {
+        if (search === void 0) { search = null; }
+        if (pageSize === void 0) { pageSize = null; }
+        if (rowIndex === void 0) { rowIndex = null; }
         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);
+                        apiPath = "asset/galleries?search=".concat(search, "&pageSize=").concat(pageSize, "&rowIndex=").concat(rowIndex);
                         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);
+                        throw new exception_1.Exception("Unable to retrieve galleries for the website.", err_4);
                     case 3: return [2 /*return*/];
                 }
             });
         });
     };
-    AssetMethods.prototype.getAssetByUrl = function (url, guid) {
+    AssetMethods.prototype.getGalleryById = function (guid, id) {
         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);
+                        apiPath = "/asset/gallery/".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_5 = _a.sent();
-                        throw new exception_1.Exception("Unable to retrieve asset for url ".concat(url), err_5);
+                        throw new exception_1.Exception("Unable to retrieve gallery for id ".concat(id), err_5);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AssetMethods.prototype.getGalleryByName = function (guid, galleryName) {
+        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/gallery?galleryName=".concat(galleryName);
+                        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 gallery for name ".concat(galleryName), err_6);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AssetMethods.prototype.getDefaultContainer = function (guid) {
+        return __awaiter(this, void 0, void 0, function () {
+            var apiPath, resp, err_7;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        apiPath = "/asset/container";
+                        return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
+                    case 1:
+                        resp = _a.sent();
+                        return [2 /*return*/, resp.data];
+                    case 2:
+                        err_7 = _a.sent();
+                        throw new exception_1.Exception("Unable to retrieve container for guid ".concat(guid), err_7);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AssetMethods.prototype.saveGallery = function (guid, gallery) {
+        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 = "/asset/gallery";
+                        return [4 /*yield*/, this._clientInstance.executePost(apiPath, guid, this._options.token, gallery)];
+                    case 1:
+                        resp = _a.sent();
+                        return [2 /*return*/, resp.data];
+                    case 2:
+                        err_8 = _a.sent();
+                        throw new exception_1.Exception("Unable to save gallery", err_8);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AssetMethods.prototype.deleteGallery = function (guid, id) {
+        return __awaiter(this, void 0, void 0, function () {
+            var apiPath, resp, err_9;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        apiPath = "/asset/gallery/".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_9 = _a.sent();
+                        throw new exception_1.Exception("Unable to delete gallery for id ".concat(id), err_9);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AssetMethods.prototype.getAssetByID = function (mediaID, guid) {
+        return __awaiter(this, void 0, void 0, function () {
+            var apiPath, resp, err_10;
+            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_10 = _a.sent();
+                        throw new exception_1.Exception("Unable to retrieve asset for mediaID ".concat(mediaID), err_10);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AssetMethods.prototype.getAssetByUrl = function (url, guid) {
+        return __awaiter(this, void 0, void 0, function () {
+            var apiPath, resp, err_11;
+            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_11 = _a.sent();
+                        throw new exception_1.Exception("Unable to retrieve asset for url ".concat(url), err_11);
                     case 3: return [2 /*return*/];
                 }
             });
@@ -149,7 +272,7 @@ var AssetMethods = /** @class */ (function () {
     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;
+            var apiPath, resp, err_12;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -160,8 +283,28 @@ var AssetMethods = /** @class */ (function () {
                         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);
+                        err_12 = _a.sent();
+                        throw new exception_1.Exception("Unable to upload media.", err_12);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    AssetMethods.prototype.createFolder = function (originKey, guid) {
+        return __awaiter(this, void 0, void 0, function () {
+            var apiPath, resp, err_13;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        apiPath = "asset/folder?originKey=".concat(originKey);
+                        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_13 = _a.sent();
+                        throw new exception_1.Exception('Unable to create folder.', err_13);
                     case 3: return [2 /*return*/];
                 }
             });

package/dist/enums/assetGroupingType.d.ts

@@ -0,0 +1,3 @@
+export declare enum AssetGroupingType {
+    Gallery = 1
+}

package/dist/enums/assetGroupingType.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AssetGroupingType = void 0;
+var AssetGroupingType;
+(function (AssetGroupingType) {
+    AssetGroupingType[AssetGroupingType["Gallery"] = 1] = "Gallery";
+})(AssetGroupingType = exports.AssetGroupingType || (exports.AssetGroupingType = {}));

package/dist/index.d.ts

@@ -11,4 +11,9 @@ export * from "./models/model";
 export * from "./models/notification";
 export * from "./models/pageItem";
 export * from "./models/sitemap";
+export * from "./models/websiteUser";
+export * from "./models/assetContainer";
+export * from "./models/assetGalleries";
+export * from "./models/assetMediaGrouping";
+export * from "./models/assetMediaGroupingMetaData";
 export * from "./apiClient";

package/dist/index.js

@@ -27,4 +27,9 @@ __exportStar(require("./models/model"), exports);
 __exportStar(require("./models/notification"), exports);
 __exportStar(require("./models/pageItem"), exports);
 __exportStar(require("./models/sitemap"), exports);
+__exportStar(require("./models/websiteUser"), exports);
+__exportStar(require("./models/assetContainer"), exports);
+__exportStar(require("./models/assetGalleries"), exports);
+__exportStar(require("./models/assetMediaGrouping"), exports);
+__exportStar(require("./models/assetMediaGroupingMetaData"), exports);
 __exportStar(require("./apiClient"), exports);

package/dist/models/assetContainer.d.ts

@@ -0,0 +1,7 @@
+export declare class assetContainer {
+    containerID: number | null;
+    isDefault: boolean;
+    containerName: string | null;
+    originUrl: string | null;
+    edgeUrl: string | null;
+}

package/dist/models/assetContainer.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assetContainer = void 0;
+var assetContainer = /** @class */ (function () {
+    function assetContainer() {
+    }
+    return assetContainer;
+}());
+exports.assetContainer = assetContainer;

package/dist/models/assetGalleries.d.ts

@@ -0,0 +1,5 @@
+import { assetMediaGrouping } from "./assetMediaGrouping";
+export declare class assetGalleries {
+    totalCount: number | null;
+    assetMediaGroupings: (assetMediaGrouping | null)[];
+}

package/dist/models/assetGalleries.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assetGalleries = void 0;
+var assetGalleries = /** @class */ (function () {
+    function assetGalleries() {
+    }
+    return assetGalleries;
+}());
+exports.assetGalleries = assetGalleries;

package/dist/models/assetMediaGrouping.d.ts

@@ -0,0 +1,17 @@
+import { AssetGroupingType } from "../enums/assetGroupingType";
+import { assetMediaGroupingMetaData } from "./assetMediaGroupingMetaData";
+export declare class assetMediaGrouping {
+    mediaGroupingID: number | null;
+    groupingType: AssetGroupingType | null;
+    groupingTypeID: number | null;
+    name: string | null;
+    description: string | null;
+    modifiedBy: number | null;
+    modifiedByName: string | null;
+    modifiedOn: string | null;
+    isDeleted: boolean;
+    isFolder: boolean;
+    metaData: {
+        [key: string]: assetMediaGroupingMetaData;
+    };
+}

package/dist/models/assetMediaGrouping.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assetMediaGrouping = void 0;
+var assetMediaGrouping = /** @class */ (function () {
+    function assetMediaGrouping() {
+    }
+    return assetMediaGrouping;
+}());
+exports.assetMediaGrouping = assetMediaGrouping;

package/dist/models/assetMediaGroupingMetaData.d.ts

@@ -0,0 +1,4 @@
+export declare class assetMediaGroupingMetaData {
+    key: string;
+    value: string;
+}

package/dist/models/assetMediaGroupingMetaData.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assetMediaGroupingMetaData = void 0;
+var assetMediaGroupingMetaData = /** @class */ (function () {
+    function assetMediaGroupingMetaData() {
+    }
+    return assetMediaGroupingMetaData;
+}());
+exports.assetMediaGroupingMetaData = assetMediaGroupingMetaData;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agility/management-sdk",
-  "version": "0.1.8",
+  "version": "0.1.10",
   "description": "Agility CMS Tyescript SDK for Management API.",
   "repository": {
     "type": "git",