@agility/management-sdk 0.1.15 → 0.1.17

package/dist/apiMethods/serverUserMethods.js

@@ -0,0 +1,89 @@
+"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 (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]) {
+                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.ServerUserMethods = void 0;
+var exception_1 = require("../models/exception");
+var clientInstance_1 = require("./clientInstance");
+var ServerUserMethods = /** @class */ (function () {
+    function ServerUserMethods(options) {
+        this._options = options;
+        this._clientInstance = new clientInstance_1.ClientInstance(this._options);
+    }
+    ServerUserMethods.prototype.me = function (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 = "users/me";
+                        return [4 /*yield*/, this._clientInstance.executeServerGet(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 retrieve user information.');
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    ServerUserMethods.prototype.you = function (guid, serverUserID) {
+        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 = "users/you?srvUserID=".concat(serverUserID);
+                        return [4 /*yield*/, this._clientInstance.executeServerGet(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 retrieve user information.');
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    return ServerUserMethods;
+}());
+exports.ServerUserMethods = ServerUserMethods;

package/dist/apiMethods/webhookMethods.d.ts

@@ -0,0 +1,12 @@
+import { Options } from "../models/options";
+import { Webhook } from "../models/webhook";
+import { ClientInstance } from "./clientInstance";
+export declare class WebhookMethods {
+    _options: Options;
+    _cleintInstance: ClientInstance;
+    constructor(options: Options);
+    webhookList(guid: string, take?: number, token?: string): Promise<any>;
+    saveWebhook(guid: string, webhook: Webhook): Promise<any>;
+    getWebhook(guid: string, webhookID: string): Promise<any>;
+    deleteWebhook(guid: string, webhookID: string): Promise<void>;
+}

package/dist/apiMethods/webhookMethods.js

@@ -0,0 +1,131 @@
+"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 (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]) {
+                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.WebhookMethods = void 0;
+var exception_1 = require("../models/exception");
+var clientInstance_1 = require("./clientInstance");
+var WebhookMethods = /** @class */ (function () {
+    function WebhookMethods(options) {
+        this._options = options;
+        this._cleintInstance = new clientInstance_1.ClientInstance(this._options);
+    }
+    WebhookMethods.prototype.webhookList = function (guid, take, token) {
+        if (take === void 0) { take = 20; }
+        if (token === void 0) { token = null; }
+        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 = "webhook/list";
+                        return [4 /*yield*/, this._cleintInstance.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 get the webhook list", err_1);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    WebhookMethods.prototype.saveWebhook = function (guid, webhook) {
+        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 = "webhook";
+                        return [4 /*yield*/, this._cleintInstance.executePost(apiPath, guid, this._options.token, webhook)];
+                    case 1:
+                        resp = _a.sent();
+                        return [2 /*return*/, resp.data];
+                    case 2:
+                        err_2 = _a.sent();
+                        throw new exception_1.Exception('Unable to save webhook.', err_2);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    WebhookMethods.prototype.getWebhook = function (guid, webhookID) {
+        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 = "webhook/".concat(webhookID);
+                        return [4 /*yield*/, this._cleintInstance.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 webhook for webhookID: ".concat(webhookID, ","), err_3);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    WebhookMethods.prototype.deleteWebhook = function (guid, webhookID) {
+        return __awaiter(this, void 0, void 0, function () {
+            var apiPath, err_4;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        apiPath = "webhook/".concat(webhookID);
+                        return [4 /*yield*/, this._cleintInstance.executeDelete(apiPath, guid, this._options.token)];
+                    case 1:
+                        _a.sent();
+                        return [3 /*break*/, 3];
+                    case 2:
+                        err_4 = _a.sent();
+                        throw new exception_1.Exception("Unable to delete webhook for webhookID: ".concat(webhookID, "."), err_4);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    return WebhookMethods;
+}());
+exports.WebhookMethods = WebhookMethods;

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];

package/dist/models/contentItemHistory.d.ts

@@ -0,0 +1,20 @@
+export declare class ContentItemHistoryResponse {
+    items: ContentItemHistory[];
+    totalCount: number;
+}
+export declare class ContentItemHistory {
+    contentItemID: number;
+    stateID: number;
+    state: string | null;
+    createdDate: string;
+    createdBy: string | null;
+    createdByUserID: number;
+    createdByServerUserID: number;
+    createdByUserEmail: string | null;
+    releaseDate: string;
+    pullDate: string;
+    commentID: number;
+    comment: string | null;
+    pinned: boolean;
+    versionNumber: number;
+}

package/dist/models/contentItemHistory.js

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

package/dist/models/contentListFilterModel.d.ts

@@ -0,0 +1,26 @@
+export declare class ContentListFilterModel {
+    sortIDs: number[];
+    modifiedByIds: number[];
+    dateRange: DateRangeFilter | null;
+    stateIds: number[];
+    fieldFilters: FieldFilter[];
+    genericSearch: string;
+}
+export declare class DateRangeFilter {
+    startDate: string | null;
+    endDate: string | null;
+}
+export declare class NumRangeFilter {
+    fromNum: number;
+    toNum: number;
+}
+export declare class FieldFilterValue {
+    stringValue: string | null;
+    dateRangeValue: DateRangeFilter | null;
+    numRangeValue: NumRangeFilter | null;
+    boolValue: boolean | null;
+}
+export declare class FieldFilter {
+    field: string | null;
+    value: FieldFilterValue | null;
+}

package/dist/models/contentListFilterModel.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FieldFilter = exports.FieldFilterValue = exports.NumRangeFilter = exports.DateRangeFilter = exports.ContentListFilterModel = void 0;
+var ContentListFilterModel = /** @class */ (function () {
+    function ContentListFilterModel() {
+    }
+    return ContentListFilterModel;
+}());
+exports.ContentListFilterModel = ContentListFilterModel;
+var DateRangeFilter = /** @class */ (function () {
+    function DateRangeFilter() {
+    }
+    return DateRangeFilter;
+}());
+exports.DateRangeFilter = DateRangeFilter;
+var NumRangeFilter = /** @class */ (function () {
+    function NumRangeFilter() {
+    }
+    return NumRangeFilter;
+}());
+exports.NumRangeFilter = NumRangeFilter;
+var FieldFilterValue = /** @class */ (function () {
+    function FieldFilterValue() {
+    }
+    return FieldFilterValue;
+}());
+exports.FieldFilterValue = FieldFilterValue;
+var FieldFilter = /** @class */ (function () {
+    function FieldFilter() {
+    }
+    return FieldFilter;
+}());
+exports.FieldFilter = FieldFilter;

package/dist/models/exception.js

@@ -7,6 +7,8 @@ var __extends = (this && this.__extends) || (function () {
         return extendStatics(d, b);
     };
     return function (d, b) {
+        if (typeof b !== "function" && b !== null)
+            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
         extendStatics(d, b);
         function __() { this.constructor = d; }
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());

package/dist/models/itemComments.d.ts

@@ -0,0 +1,14 @@
+export declare class ItemComment {
+    createdOn: string;
+    createdBy: string;
+    createdByUserID: number;
+    createdByServerUserID: number;
+    commentID: number;
+    commentText: string;
+    pinned: boolean;
+    emailAddress: string;
+}
+export declare class ItemComments {
+    items: ItemComment[];
+    totalCount: number;
+}

package/dist/models/itemComments.js

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

package/dist/models/listParams.d.ts

@@ -0,0 +1,9 @@
+export declare class ListParams {
+    filter: string;
+    fields: string;
+    sortDirection: string;
+    sortField: string;
+    showDeleted: boolean;
+    take: number;
+    skip: number;
+}

package/dist/models/listParams.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListParams = void 0;
+var ListParams = /** @class */ (function () {
+    function ListParams() {
+        this.filter = '';
+        this.fields = '';
+        this.sortDirection = '';
+        this.sortField = '';
+        this.showDeleted = false;
+        this.take = 50;
+        this.skip = 0;
+    }
+    return ListParams;
+}());
+exports.ListParams = ListParams;

package/dist/models/pageHistory.d.ts

@@ -0,0 +1,21 @@
+export declare class PageHistory {
+    PageItemID: number;
+    ContentItemID: number;
+    StateID: number;
+    State: string;
+    CreatedDate: string;
+    CreatedBy: string;
+    CreatedByUserID: number;
+    CreatedByUserEmail: string;
+    CreatedByServerUserID: number;
+    ReleaseDate: string;
+    PullDate: string;
+    CommentID: number;
+    Comment: string;
+    Pinned: boolean;
+    VersionNumber: number;
+}
+export declare class PageHistoryResponse {
+    items: PageHistory[];
+    totalCount: number;
+}

package/dist/models/pageHistory.js

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

package/dist/models/serverUser.d.ts

@@ -0,0 +1,21 @@
+import { WebsiteListing } from "./websiteListing";
+export declare class ServerUser {
+    userID: number;
+    userName: string | null;
+    emailAddress: string | null;
+    firstName: string | null;
+    lastName: string | null;
+    isInternalUser: boolean;
+    isSuspended: boolean;
+    isProfileComplete: boolean;
+    adminAccess: boolean;
+    currentWebsite: string | null;
+    userTypeID: number;
+    timeZoneRegion: string | null;
+    password: string | null;
+    passwordQuestion: string | null;
+    passwordAnswer: string | null;
+    websiteAccess: WebsiteListing[];
+    jobRole: string | null;
+    createdDate: string | null;
+}

package/dist/models/serverUser.js

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

package/dist/models/webhook.d.ts

@@ -0,0 +1,9 @@
+export declare class Webhook {
+    name: string | null;
+    url: string | null;
+    instanceGuid: string | null;
+    enabled: boolean;
+    contentWorkflowEvents: boolean;
+    contentPublishEvents: boolean;
+    contentSaveEvents: boolean;
+}

package/dist/models/webhook.js

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

package/dist/models/websiteListing.d.ts

@@ -0,0 +1,16 @@
+export declare class WebsiteListing {
+    orgCode: string | null;
+    orgName: string | null;
+    websiteName: string | null;
+    websiteNameStripped: string | null;
+    displayName: string | null;
+    guid: string | null;
+    websiteID: number;
+    isCurrent: boolean;
+    managerUrl: string | null;
+    version: string | null;
+    isOwner: boolean;
+    isDormant: boolean;
+    isRestoring: boolean;
+    teamID: number | null;
+}

package/dist/models/websiteListing.js

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

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

@@ -0,0 +1,14 @@
+import { Options } from "../models/options";
+import { ClientInstance } from "./clientInstance";
+import { AssetMediaList, Media } from "../models/media";
+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>;
+    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[]>;
+}