@agility/management-sdk 0.1.16 → 0.1.17

package/README.md

@@ -18,14 +18,14 @@
 
 ### Making a Request
 ```Javascript
-import * as index from "./index";
+import * as mgmtApi from "./index";
 
 //initialize the Options Class
-let options = new index.Options();
+let options = new mgmtApi.Options();
 
 options.token = "<<Provide Auth Token>>"
 //Initialize the APIClient Class
-let apiClient = new index.ApiClient(options);
+let apiClient = new mgmtApi.ApiClient(options);
 
 let guid = "<<Provide the Guid of the Website>>";
 let locale = "<<Provide the locale of the Website>>"; //Example: en-us
@@ -172,6 +172,14 @@ This class is used to perform operations related to Containers. The following ar
 
 Returns: A object of ```Container``` class.
 
+### getContainersByModel
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `modelId` | `number` | The model id of the requested container.|
+| `guid` | `string` | Current website guid.|
+
+Returns: A object of ```Container``` class.
+
 ### getContainerByReferenceName
 | Parameter | Type     | Description                |
 | :-------- | :------- | :------------------------- |
@@ -312,15 +320,43 @@ Returns: An array of ```contentID``` of the requested content.
 | `referenceName` | `string` | The reference name of the container for the requested content.|
 | `guid` | `string` | Current website guid.|
 | `locale` | `string` | Current website locale.|
-| `filter` | `string` | The filter condition for the requested content.|
-| `fields` | `string` | The fields mapped to the container.|
-| `sortDirection` | `string` | The direction to sort the result.|
-| `sortField` | `string` | The field on which the sort needs to be performed.|
-| `take` | `number` | The page size for the result.|
-| `skip` | `number` | The record offset for the result.|
+| `listParams` | `ListParams` | The parameters list to apply filter on the content list.|
+
+Returns: An object of ```ContentList``` class of the requested content.
+
+### getContentList
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `referenceName` | `string` | The reference name of the container for the requested content.|
+| `guid` | `string` | Current website guid.|
+| `locale` | `string` | Current website locale.|
+| `listParams` | `ListParams` | The parameters list to apply filter on the content list.|
+| `filterObject` | `ContentListFilterModel` | To apply filter at the field level.|
 
 Returns: An object of ```ContentList``` class of the requested content.
 
+### getContentHistory
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `locale` | `string` | Current website locale.|
+| `guid` | `string` | Current website guid.|
+| `contentID` | `number` | The contentID of the requested content.|
+| `take` | `number` | The number of items per record set default value 50.|
+| `skip` | `number` | The skip level on the record set default value 0.|
+
+Returns: An object of ```ContentItemHistory``` class of the requested content history.
+
+### getContentComments
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `locale` | `string` | Current website locale.|
+| `guid` | `string` | Current website guid.|
+| `contentID` | `number` | The contentID of the requested content.|
+| `take` | `number` | The number of items per record set default value 50.|
+| `skip` | `number` | The skip level on the record set default value 0.|
+
+Returns: An object of ```ItemComments``` class of the requested content comments.
+
 ## Class InstanceUserMethods
 This class is used to perform operations related to User. The following are the methods: -
 
@@ -409,6 +445,54 @@ This class is used to perform operations related to Pages. The following are the
 | `locale` | `string` | Current website locale.|
 Returns: A collection object of ```Sitemap``` class.
 
+### getPageTemplates
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `guid` | `string` | Current website guid.|
+| `locale` | `string` | Current website locale.|
+| `includeModuleZones` | `boolean` | To include zones in the result set.|
+| `searchFilter` | `string` | To apply search criteria on the requested page template.|
+Returns: A collection object of ```PageModel``` class.
+
+### getPageTemplate
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `guid` | `string` | Current website guid.|
+| `locale` | `string` | Current website locale.|
+| `pageTemplateId` | `number` | The pageTemplateId of the requested page template.|
+Returns: An object of ```PageModel``` class.
+
+### getPageTemplateName
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `guid` | `string` | Current website guid.|
+| `locale` | `string` | Current website locale.|
+| `templateName` | `string` | The templateName of the requested page template.|
+Returns: An object of ```PageModel``` class.
+
+### deletePageTemplate
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `guid` | `string` | Current website guid.|
+| `locale` | `string` | Current website locale.|
+| `pageTemplateId` | `string` | The pageTemplateId of the requested page template.|
+
+### getPageItemTemplates
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `guid` | `string` | Current website guid.|
+| `locale` | `string` | Current website locale.|
+| `id` | `number` | The id of the requested page template.|
+Returns: A collection of ```ContentSectionDefinition``` class.
+
+### savePageTemplate
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `guid` | `string` | Current website guid.|
+| `locale` | `string` | Current website locale.|
+| `pageModel` | `PageModel` | The pageModel object of the requested page template.|
+Returns: An object of ```PageModel``` class.
+
 ### getPage
 | Parameter | Type     | Description                |
 | :-------- | :------- | :------------------------- |
@@ -489,6 +573,80 @@ Returns: An array of ```pageID``` of the requested page.
 
 Returns: An array of ```pageID``` of the requested page.
 
+### getPageHistory
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `locale` | `string` | Current website locale.|
+| `guid` | `string` | Current website guid.|
+| `pageID` | `number` | The pageID of the requested page.|
+| `take` | `number` | The number of items per record set default value 50.|
+| `skip` | `number` | The skip level on the record set default value 0.|
+
+Returns: An object of ```PageHistory``` class of the requested page history.
+
+### getPageComments
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `locale` | `string` | Current website locale.|
+| `guid` | `string` | Current website guid.|
+| `pageID` | `number` | The pageID of the requested page.|
+| `take` | `number` | The number of items per record set default value 50.|
+| `skip` | `number` | The skip level on the record set default value 0.|
+
+Returns: An object of ```ItemComments``` class of the requested page comments.
+
+## Class ServerUserMethods
+This class is used to perform operations related to Server User. The following are the methods: -
+
+### me
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `guid` | `string` | Current website guid.|
+
+Returns: An object of ```ServerUser``` class of the requested user.
+
+### you
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `guid` | `string` | Current website guid.|
+| `serverUserID` | `number` | Current website guid.|
+
+Returns: An object of ```ServerUser``` class of the requested user.
+
+## Class WebhookMethods
+This class is used to perform operations related to Webhooks in the agility instance. The following are the methods: -
+
+### webhookList
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `guid` | `string` | Current website guid.|
+| `take` | `number` | The number of items per record set default value 20.|
+| `skip` | `number` | The skip level on the record set default value 0.|
+
+Returns: A list of webhooks configured in the instance.
+
+### saveWebhook
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `guid` | `string` | Current website guid.|
+| `webhook` | `Webhook` | An object of Webhook type with the webhook data.|
+
+Returns: An object with the created Webhook.
+
+### getWebhook
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `guid` | `string` | Current website guid.|
+| `webhookID` | `string` | The webhookID of the requested webhook.|
+
+Returns: An object with the requested Webhook.
+
+### deleteWebhook
+| Parameter | Type     | Description                |
+| :-------- | :------- | :------------------------- |
+| `guid` | `string` | Current website guid.|
+| `webhookID` | `string` | The webhookID of the requested webhook.|
+
 
 ## Running the SDK Locally
 

package/dist/apiClient.d.ts

@@ -1,19 +1,23 @@
-import { ContentMethods } from "./apiMethods/contentMethods";
-import { AssetMethods } from "./apiMethods/assetMethods";
-import { BatchMethods } from "./apiMethods/batchMethods";
-import { ContainerMethods } from "./apiMethods/containerMethods";
-import { InstanceUserMethods } from "./apiMethods/instanceUserMethods";
-import { ModelMethods } from "./apiMethods/modelMethods";
-import { PageMethods } from "./apiMethods/pageMethods";
-import { Options } from "./models/options";
-export declare class ApiClient {
-    _options: Options;
-    contentMethods: ContentMethods;
-    assetMethods: AssetMethods;
-    batchMethods: BatchMethods;
-    containerMethods: ContainerMethods;
-    instanceUserMethods: InstanceUserMethods;
-    modelMethods: ModelMethods;
-    pageMethods: PageMethods;
-    constructor(options: Options);
-}
+import { ContentMethods } from "./apiMethods/contentMethods";
+import { AssetMethods } from "./apiMethods/assetMethods";
+import { BatchMethods } from "./apiMethods/batchMethods";
+import { ContainerMethods } from "./apiMethods/containerMethods";
+import { InstanceUserMethods } from "./apiMethods/instanceUserMethods";
+import { ModelMethods } from "./apiMethods/modelMethods";
+import { PageMethods } from "./apiMethods/pageMethods";
+import { Options } from "./models/options";
+import { ServerUserMethods } from "./apiMethods/serverUserMethods";
+import { WebhookMethods } from "./apiMethods/webhookMethods";
+export declare class ApiClient {
+    _options: Options;
+    contentMethods: ContentMethods;
+    assetMethods: AssetMethods;
+    batchMethods: BatchMethods;
+    containerMethods: ContainerMethods;
+    instanceUserMethods: InstanceUserMethods;
+    modelMethods: ModelMethods;
+    pageMethods: PageMethods;
+    serverUserMethods: ServerUserMethods;
+    webhookMethods: WebhookMethods;
+    constructor(options: Options);
+}

package/dist/apiClient.js

@@ -1,24 +1,28 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiClient = void 0;
-var contentMethods_1 = require("./apiMethods/contentMethods");
-var assetMethods_1 = require("./apiMethods/assetMethods");
-var batchMethods_1 = require("./apiMethods/batchMethods");
-var containerMethods_1 = require("./apiMethods/containerMethods");
-var instanceUserMethods_1 = require("./apiMethods/instanceUserMethods");
-var modelMethods_1 = require("./apiMethods/modelMethods");
-var pageMethods_1 = require("./apiMethods/pageMethods");
-var ApiClient = /** @class */ (function () {
-    function ApiClient(options) {
-        this._options = options;
-        this.contentMethods = new contentMethods_1.ContentMethods(this._options);
-        this.assetMethods = new assetMethods_1.AssetMethods(this._options);
-        this.batchMethods = new batchMethods_1.BatchMethods(this._options);
-        this.containerMethods = new containerMethods_1.ContainerMethods(this._options);
-        this.instanceUserMethods = new instanceUserMethods_1.InstanceUserMethods(this._options);
-        this.modelMethods = new modelMethods_1.ModelMethods(this._options);
-        this.pageMethods = new pageMethods_1.PageMethods(this._options);
-    }
-    return ApiClient;
-}());
-exports.ApiClient = ApiClient;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiClient = void 0;
+var contentMethods_1 = require("./apiMethods/contentMethods");
+var assetMethods_1 = require("./apiMethods/assetMethods");
+var batchMethods_1 = require("./apiMethods/batchMethods");
+var containerMethods_1 = require("./apiMethods/containerMethods");
+var instanceUserMethods_1 = require("./apiMethods/instanceUserMethods");
+var modelMethods_1 = require("./apiMethods/modelMethods");
+var pageMethods_1 = require("./apiMethods/pageMethods");
+var serverUserMethods_1 = require("./apiMethods/serverUserMethods");
+var webhookMethods_1 = require("./apiMethods/webhookMethods");
+var ApiClient = /** @class */ (function () {
+    function ApiClient(options) {
+        this._options = options;
+        this.contentMethods = new contentMethods_1.ContentMethods(this._options);
+        this.assetMethods = new assetMethods_1.AssetMethods(this._options);
+        this.batchMethods = new batchMethods_1.BatchMethods(this._options);
+        this.containerMethods = new containerMethods_1.ContainerMethods(this._options);
+        this.instanceUserMethods = new instanceUserMethods_1.InstanceUserMethods(this._options);
+        this.modelMethods = new modelMethods_1.ModelMethods(this._options);
+        this.pageMethods = new pageMethods_1.PageMethods(this._options);
+        this.serverUserMethods = new serverUserMethods_1.ServerUserMethods(this._options);
+        this.webhookMethods = new webhookMethods_1.WebhookMethods(this._options);
+    }
+    return ApiClient;
+}());
+exports.ApiClient = ApiClient;

package/dist/apiMethods/apiClient.d.ts

@@ -0,0 +1,19 @@
+import { ContentMethods } from "./contentMethods";
+import { AssetMethods } from "./assetMethods";
+import { BatchMethods } from "./batchMethods";
+import { ContainerMethods } from "./containerMethods";
+import { InstanceUserMethods } from "./instanceUserMethods";
+import { ModelMethods } from "./modelMethods";
+import { PageMethods } from "./pageMethods";
+import { Options } from "../models/options";
+export declare class ApiClient {
+    _options: Options;
+    contentMethods: ContentMethods;
+    assetMethods: AssetMethods;
+    batchMethods: BatchMethods;
+    containerMethods: ContainerMethods;
+    instanceUserMethods: InstanceUserMethods;
+    modelMethods: ModelMethods;
+    pageMethods: PageMethods;
+    constructor(options: Options);
+}

package/dist/apiMethods/apiClient.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiClient = void 0;
+var contentMethods_1 = require("./contentMethods");
+var assetMethods_1 = require("./assetMethods");
+var batchMethods_1 = require("./batchMethods");
+var containerMethods_1 = require("./containerMethods");
+var instanceUserMethods_1 = require("./instanceUserMethods");
+var modelMethods_1 = require("./modelMethods");
+var pageMethods_1 = require("./pageMethods");
+var ApiClient = /** @class */ (function () {
+    function ApiClient(options) {
+        this._options = options;
+        this.contentMethods = new contentMethods_1.ContentMethods(this._options);
+        this.assetMethods = new assetMethods_1.AssetMethods(this._options);
+        this.batchMethods = new batchMethods_1.BatchMethods(this._options);
+        this.containerMethods = new containerMethods_1.ContainerMethods(this._options);
+        this.instanceUserMethods = new instanceUserMethods_1.InstanceUserMethods(this._options);
+        this.modelMethods = new modelMethods_1.ModelMethods(this._options);
+        this.pageMethods = new pageMethods_1.PageMethods(this._options);
+    }
+    return ApiClient;
+}());
+exports.ApiClient = ApiClient;

package/dist/apiMethods/assetMethods.d.ts

@@ -1,34 +1,34 @@
-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;
-    constructor(options: Options);
-    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>;
-    /**
- * Uploads a file to the specified folder path.
- *
- * @param {*} formData - FormData object that axios is expecting for the Upload.
- * @param {string} agilityFolderPath
- * @param {string} guid
- * @param {number} [groupingID=-1]
- * @returns
- * @memberof AssetMethods
- */
-    upload(formData: any, agilityFolderPath: string, guid: string, groupingID?: number): Promise<Media[]>;
-    createFolder(originKey: string, guid: string): Promise<Media>;
-}
+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;
+    constructor(options: Options);
+    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>;
+    /**
+ * Uploads a file to the specified folder path.
+ *
+ * @param {*} formData - FormData object that axios is expecting for the Upload.
+ * @param {string} agilityFolderPath
+ * @param {string} guid
+ * @param {number} [groupingID=-1]
+ * @returns
+ * @memberof AssetMethods
+ */
+    upload(formData: any, agilityFolderPath: string, guid: string, groupingID?: number): Promise<Media[]>;
+    createFolder(originKey: string, guid: string): Promise<Media>;
+}