@agility/management-sdk 0.1.38 → 0.1.40

package/dist/apiMethods/webhookMethods.d.ts

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

package/dist/apiMethods/webhookMethods.js

@@ -38,23 +38,28 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.WebhookMethods = void 0;
 var exception_1 = require("../models/exception");
+var queryString_1 = require("../util/queryString");
 var clientInstance_1 = require("./clientInstance");
 var WebhookMethods = /** @class */ (function () {
     function WebhookMethods(options) {
         this._options = options;
-        this._cleintInstance = new clientInstance_1.ClientInstance(this._options);
+        this._clientInstance = new clientInstance_1.ClientInstance(this._options);
     }
     WebhookMethods.prototype.webhookList = function (guid_1) {
         return __awaiter(this, arguments, void 0, function (guid, take, token) {
-            var apiPath, resp, err_1;
+            var queryParams, apiPath, resp, err_1;
             if (take === void 0) { take = 20; }
             if (token === void 0) { token = null; }
             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)];
+                        queryParams = (0, queryString_1.buildQueryString)({
+                            take: take,
+                            token: token
+                        });
+                        apiPath = "webhook/list".concat(queryParams);
+                        return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
                     case 1:
                         resp = _a.sent();
                         return [2 /*return*/, resp.data];
@@ -74,7 +79,7 @@ var WebhookMethods = /** @class */ (function () {
                     case 0:
                         _a.trys.push([0, 2, , 3]);
                         apiPath = "webhook";
-                        return [4 /*yield*/, this._cleintInstance.executePost(apiPath, guid, this._options.token, webhook)];
+                        return [4 /*yield*/, this._clientInstance.executePost(apiPath, guid, this._options.token, webhook)];
                     case 1:
                         resp = _a.sent();
                         return [2 /*return*/, resp.data];
@@ -94,7 +99,7 @@ var WebhookMethods = /** @class */ (function () {
                     case 0:
                         _a.trys.push([0, 2, , 3]);
                         apiPath = "webhook/".concat(webhookID);
-                        return [4 /*yield*/, this._cleintInstance.executeGet(apiPath, guid, this._options.token)];
+                        return [4 /*yield*/, this._clientInstance.executeGet(apiPath, guid, this._options.token)];
                     case 1:
                         resp = _a.sent();
                         return [2 /*return*/, resp.data];
@@ -114,7 +119,7 @@ var WebhookMethods = /** @class */ (function () {
                     case 0:
                         _a.trys.push([0, 2, , 3]);
                         apiPath = "webhook/".concat(webhookID);
-                        return [4 /*yield*/, this._cleintInstance.executeDelete(apiPath, guid, this._options.token)];
+                        return [4 /*yield*/, this._clientInstance.executeDelete(apiPath, guid, this._options.token)];
                     case 1:
                         _a.sent();
                         return [3 /*break*/, 3];
@@ -126,6 +131,52 @@ var WebhookMethods = /** @class */ (function () {
             });
         });
     };
+    WebhookMethods.prototype.getWebhookHistory = function (guid, webhookID, options) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParams, apiPath, resp, err_5;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        queryParams = (0, queryString_1.buildQueryString)({
+                            fromDate: options === null || options === void 0 ? void 0 : options.fromDate,
+                            toDate: options === null || options === void 0 ? void 0 : options.toDate,
+                            take: options === null || options === void 0 ? void 0 : options.take,
+                            token: options === null || options === void 0 ? void 0 : options.token
+                        });
+                        apiPath = "webhook/".concat(webhookID, "/history").concat(queryParams);
+                        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 webhook history for webhookID: ".concat(webhookID, "."), err_5);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    WebhookMethods.prototype.rotateWebhookSecret = function (guid, webhookID) {
+        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 = "webhook/".concat(webhookID, "/rotate-secret");
+                        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_6 = _a.sent();
+                        throw new exception_1.Exception("Unable to rotate the signing secret for webhookID: ".concat(webhookID, "."), err_6);
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
     return WebhookMethods;
 }());
 exports.WebhookMethods = WebhookMethods;

package/dist/index.d.ts

@@ -16,6 +16,8 @@ export * from "./models/notification";
 export * from "./models/pageItem";
 export * from "./models/pagedResult";
 export * from "./models/sitemap";
+export * from "./models/webhook";
+export * from "./models/webhookHistory";
 export * from "./models/websiteUser";
 export * from "./models/assetContainer";
 export * from "./models/assetGalleries";

package/dist/index.js

@@ -32,6 +32,8 @@ __exportStar(require("./models/notification"), exports);
 __exportStar(require("./models/pageItem"), exports);
 __exportStar(require("./models/pagedResult"), exports);
 __exportStar(require("./models/sitemap"), exports);
+__exportStar(require("./models/webhook"), exports);
+__exportStar(require("./models/webhookHistory"), exports);
 __exportStar(require("./models/websiteUser"), exports);
 __exportStar(require("./models/assetContainer"), exports);
 __exportStar(require("./models/assetGalleries"), exports);

package/dist/models/exception.d.ts

@@ -1,4 +1,8 @@
 export declare class Exception extends Error {
     constructor(message: string, inner?: Error);
     innerError?: Error;
+    /** HTTP status code from the underlying response, when available. */
+    statusCode?: number;
+    /** Raw response body from the underlying response, when available. */
+    responseData?: unknown;
 }

package/dist/models/exception.js

@@ -19,8 +19,24 @@ exports.Exception = void 0;
 var Exception = /** @class */ (function (_super) {
     __extends(Exception, _super);
     function Exception(message, inner) {
-        var _this = _super.call(this, message) || this;
+        var _this = this;
+        var _a, _b, _c, _d;
+        var anyErr = inner;
+        var status = (_a = anyErr === null || anyErr === void 0 ? void 0 : anyErr.response) === null || _a === void 0 ? void 0 : _a.status;
+        var data = (_b = anyErr === null || anyErr === void 0 ? void 0 : anyErr.response) === null || _b === void 0 ? void 0 : _b.data;
+        var detail = data
+            ? (typeof data === "string"
+                ? data
+                : ((_d = (_c = data.exceptionMessage) !== null && _c !== void 0 ? _c : data.message) !== null && _d !== void 0 ? _d : JSON.stringify(data)))
+            : anyErr === null || anyErr === void 0 ? void 0 : anyErr.message;
+        // Surface the server's status + response body in the message. The Management API
+        // (and other callers) only read Error.message, so folding the response detail in here
+        // turns an opaque "Unable to save the container" into
+        // "Unable to save the container (HTTP 500): <server message>".
+        _this = _super.call(this, detail ? "".concat(message).concat(status ? " (HTTP ".concat(status, ")") : "", ": ").concat(detail) : message) || this;
         _this.innerError = inner;
+        _this.statusCode = status;
+        _this.responseData = data;
         return _this;
     }
     return Exception;

package/dist/models/pagedResult.d.ts

@@ -2,3 +2,7 @@ export interface PagedResult<T> {
     totalCount: number;
     items: T[];
 }
+export interface TokenPagedResult<T> {
+    token: string | null;
+    items: T[];
+}

package/dist/models/webhook.d.ts

@@ -1,4 +1,8 @@
 export declare class Webhook {
+    partitionKey: string | null;
+    rowKey: string | null;
+    timestamp?: string | null;
+    eTag?: string | null;
     name: string | null;
     url: string | null;
     instanceGuid: string | null;
@@ -6,4 +10,17 @@ export declare class Webhook {
     contentWorkflowEvents: boolean;
     contentPublishEvents: boolean;
     contentSaveEvents: boolean;
+    secureDeliveryEnabled: boolean;
+    signingSecret: string | null;
+    previousSigningSecret: string | null;
+    secretRolledUtc: string | null;
+    retriesEnabled: boolean;
+    retryCount: number;
+    retrySpeed: "fast" | "standard" | "slow" | null;
+    /**
+     * Set only on a `saveWebhook` response, and only when that save is what minted `signingSecret`
+     * (the first save with `secureDeliveryEnabled` on). Use it to surface the new secret once — it is
+     * never stored on the webhook, so a `getWebhook` response never has it.
+     */
+    signingSecretJustCreated?: boolean;
 }

package/dist/models/webhookHistory.d.ts

@@ -0,0 +1,32 @@
+export declare class WebhookHistory {
+    partitionKey: string | null;
+    rowKey: string | null;
+    queuedDate: string | null;
+    sendDate: string | null;
+    url: string | null;
+    instanceGuid: string | null;
+    contentWorkflowEvent: boolean;
+    contentPublishEvent: boolean;
+    contentSaveEvent: boolean;
+    payload: string | null;
+    httpResponseCode: number | null;
+    success: boolean;
+    responseText: string | null;
+    webhookRowKey: string | null;
+    eventKey: string | null;
+    attemptCount: number;
+    lastAttemptDate: string | null;
+    nextAttemptUtc: string | null;
+    lastError: string | null;
+    /**
+     * Whether the last attempt was sent with Standard Webhooks signature headers, as recorded at send
+     * time. `null` means no record — the delivery has not been attempted yet, or the row predates the
+     * field. This is the fact at delivery time, not the webhook's current `secureDeliveryEnabled`.
+     */
+    signed: boolean | null;
+    /**
+     * Signatures sent in the `webhook-signature` header on the last attempt: 0 unsigned, 1 normally,
+     * 2 during the 24-hour grace window after a secret roll.
+     */
+    signatureKeyCount: number;
+}

package/dist/models/webhookHistory.js

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