@nutanix-scratch/security-js-client 4.0.1 → 4.1.2

package/dist/lib/models/security/v4/report/SecurityConfigSummary.d.ts

@@ -0,0 +1,55 @@
+/**
+ * The SecurityConfigSummary model module.
+ * @module Ntnx/SecurityConfigSummary
+ * @version 4.1.2
+ * @class SecurityConfigSummary
+ * @extends IssueSummary
+ */
+export default class SecurityConfigSummary extends IssueSummary {
+    /**
+     * Returns Indicates whether the host secure start is enabled on a cluster.
+     * @return {boolean}
+     */
+    getIsSecureBootEnabled(): boolean;
+    /**
+     * Sets Indicates whether the host secure start is enabled on a cluster.
+     * @param {boolean} isSecureBootEnabled Indicates whether the host secure start is enabled on a cluster.
+     */
+    setIsSecureBootEnabled(isSecureBootEnabled: boolean): void;
+    isSecureBootEnabled: boolean;
+    /**
+     * Returns Indicates whether the cluster lockdown mode is enabled on a cluster.
+     * @return {boolean}
+     */
+    getIsClusterLockdownEnabled(): boolean;
+    /**
+     * Sets Indicates whether the cluster lockdown mode is enabled on a cluster.
+     * @param {boolean} isClusterLockdownEnabled Indicates whether the cluster lockdown mode is enabled on a cluster.
+     */
+    setIsClusterLockdownEnabled(isClusterLockdownEnabled: boolean): void;
+    isClusterLockdownEnabled: boolean;
+    /**
+     * Returns Indicates whether the log forwarding is enabled on a cluster.
+     * @return {boolean}
+     */
+    getIsLogForwardingEnabled(): boolean;
+    /**
+     * Sets Indicates whether the log forwarding is enabled on a cluster.
+     * @param {boolean} isLogForwardingEnabled Indicates whether the log forwarding is enabled on a cluster.
+     */
+    setIsLogForwardingEnabled(isLogForwardingEnabled: boolean): void;
+    isLogForwardingEnabled: boolean;
+    /**
+     * Returns Indicates whether the Nutanix defence knowledge consent banner is enabled.
+     * @return {boolean}
+     */
+    getIsConsentBannerEnabled(): boolean;
+    /**
+     * Sets Indicates whether the Nutanix defence knowledge consent banner is enabled.
+     * @param {boolean} isConsentBannerEnabled Indicates whether the Nutanix defence knowledge consent banner is enabled.
+     */
+    setIsConsentBannerEnabled(isConsentBannerEnabled: boolean): void;
+    isConsentBannerEnabled: boolean;
+    #private;
+}
+import IssueSummary from "./IssueSummary";

package/dist/lib/models/security/v4/report/SecurityConfigSummary.js

@@ -0,0 +1,324 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _IssueSummary = _interopRequireDefault(require("./IssueSummary"));
+var _TrendValue = _interopRequireDefault(require("./TrendValue"));
+var _ValidationScopes = _interopRequireDefault(require("../../../validation/ValidationScopes"));
+var _ValidationUtils = _interopRequireDefault(require("../../../../utils/ValidationUtils"));
+var _ValidationError = _interopRequireDefault(require("../../../validation/ValidationError"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+function _classPrivateMethodInitSpec(e, a) { _checkPrivateRedeclaration(e, a), a.add(e); }
+function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object"); } /*
+ * Nutanix Security APIs
+ *
+ * OpenAPI spec version: 4.1.2
+ *
+ * NOTE: This class is auto generated by the Open API Dev Platform.
+ *
+ * Open API Dev Platform Codegen version: 17.5.1.10573-RELEASE
+ *
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * The SecurityConfigSummary model module.
+ * @module Ntnx/SecurityConfigSummary
+ * @version 4.1.2
+ * @class SecurityConfigSummary
+ * @extends IssueSummary
+ */
+var _SecurityConfigSummary_brand = /*#__PURE__*/new WeakSet();
+class SecurityConfigSummary extends _IssueSummary.default {
+  /**
+   * Constructs a new <code>SecurityConfigSummary</code>.
+   * Contains the status of all the security configurations settings for a cluster.
+   * @alias module:Ntnx/SecurityConfigSummary
+   * @extends module:Ntnx/IssueSummary
+  */
+  constructor() {
+    super();
+    /*
+    * toJson method for a map type which supports map with primitive keys and values of object types
+    * @param {Object} obj
+    * @returns {Object|Map} Returns a new transofrmed Map by calling toJson on the values if applicable.
+    * Otherwise, just returns the input object.
+    */
+    _classPrivateMethodInitSpec(this, _SecurityConfigSummary_brand);
+    this.$objectType = "security.v4.report.SecurityConfigSummary";
+    /** @type {object<string, any>} */
+    this.$reserved = {
+      '$fv': "v4.r1"
+    };
+    /** @type {object<string, any>} */
+    this.$unknownFields = {};
+  }
+
+  /**
+   * Constructs a <code>SecurityConfigSummary</code> from a plain JavaScript object, optionally creating a new instance.
+   * Copies all relevant properties from <code>data</code> to <code>obj</code> if supplied or a new instance if not.
+   * @param {Object} data The plain JavaScript object bearing properties of interest.
+   * @param {module:Ntnx/SecurityConfigSummary} obj Optional instance to populate.
+   * @param callFromChild {Boolean} Flag to recognise calling instance
+   * @return {module:Ntnx/SecurityConfigSummary} The populated <code>SecurityConfigSummary</code> instance.
+   */
+  static constructFromObject(data, obj = null, callFromChild = false) {
+    let items, item, i, itemArr, discriminator;
+    if (data) {
+      obj = obj || new SecurityConfigSummary();
+      _IssueSummary.default.constructFromObject(data, obj, true);
+      if (data.hasOwnProperty('isSecureBootEnabled') && data.isSecureBootEnabled !== null && data.isSecureBootEnabled !== undefined) {
+        obj.setIsSecureBootEnabled(data['isSecureBootEnabled']);
+      }
+      if (data.hasOwnProperty('isClusterLockdownEnabled') && data.isClusterLockdownEnabled !== null && data.isClusterLockdownEnabled !== undefined) {
+        obj.setIsClusterLockdownEnabled(data['isClusterLockdownEnabled']);
+      }
+      if (data.hasOwnProperty('isLogForwardingEnabled') && data.isLogForwardingEnabled !== null && data.isLogForwardingEnabled !== undefined) {
+        obj.setIsLogForwardingEnabled(data['isLogForwardingEnabled']);
+      }
+      if (data.hasOwnProperty('isConsentBannerEnabled') && data.isConsentBannerEnabled !== null && data.isConsentBannerEnabled !== undefined) {
+        obj.setIsConsentBannerEnabled(data['isConsentBannerEnabled']);
+      }
+      if (!callFromChild) {
+        obj.$unknownFields = {
+          ...data.$unknownFields
+        };
+        for (const property in data) {
+          // Check if the `property` is not already present in `obj` keys, either in snake_case or camelCase,
+          // as the model's fields are generated in camelCase, but the server might return snake_case (e.g., due to standards like OIDC).
+          // Also, ensure the `property` does not start with '$' and end with 'ItemDiscriminator'.
+          // If all conditions are true, add the `property` from `data` to `obj.$unknownFields` as an unknown field.
+          if (!Object.keys(obj).includes(property) && !Object.keys(obj).includes(this.snakeToCamel(property)) && !(property[0] === "$" && property.endsWith("ItemDiscriminator"))) {
+            obj.$unknownFields[property] = data[property];
+          }
+        }
+      }
+    }
+    return obj;
+  }
+
+  /**
+  * Converts a given snake_case string to camelCase.
+  * @param {string} snakeStr - The input string in snake_case format.
+  * @returns {string} - The converted string in camelCase format.
+  */
+  static snakeToCamel(snakeStr) {
+    return snakeStr.replace(/(_\w)/g, match => match[1].toUpperCase());
+  }
+
+  /**
+   * Returns Indicates whether the host secure start is enabled on a cluster.
+   * @return {boolean}
+   */
+  getIsSecureBootEnabled() {
+    return this.isSecureBootEnabled;
+  }
+
+  /**
+   * Sets Indicates whether the host secure start is enabled on a cluster.
+   * @param {boolean} isSecureBootEnabled Indicates whether the host secure start is enabled on a cluster.
+   */
+  setIsSecureBootEnabled(isSecureBootEnabled) {
+    this.isSecureBootEnabled = isSecureBootEnabled;
+  }
+
+  /**
+   * Returns Indicates whether the cluster lockdown mode is enabled on a cluster.
+   * @return {boolean}
+   */
+  getIsClusterLockdownEnabled() {
+    return this.isClusterLockdownEnabled;
+  }
+
+  /**
+   * Sets Indicates whether the cluster lockdown mode is enabled on a cluster.
+   * @param {boolean} isClusterLockdownEnabled Indicates whether the cluster lockdown mode is enabled on a cluster.
+   */
+  setIsClusterLockdownEnabled(isClusterLockdownEnabled) {
+    this.isClusterLockdownEnabled = isClusterLockdownEnabled;
+  }
+
+  /**
+   * Returns Indicates whether the log forwarding is enabled on a cluster.
+   * @return {boolean}
+   */
+  getIsLogForwardingEnabled() {
+    return this.isLogForwardingEnabled;
+  }
+
+  /**
+   * Sets Indicates whether the log forwarding is enabled on a cluster.
+   * @param {boolean} isLogForwardingEnabled Indicates whether the log forwarding is enabled on a cluster.
+   */
+  setIsLogForwardingEnabled(isLogForwardingEnabled) {
+    this.isLogForwardingEnabled = isLogForwardingEnabled;
+  }
+
+  /**
+   * Returns Indicates whether the Nutanix defence knowledge consent banner is enabled.
+   * @return {boolean}
+   */
+  getIsConsentBannerEnabled() {
+    return this.isConsentBannerEnabled;
+  }
+
+  /**
+   * Sets Indicates whether the Nutanix defence knowledge consent banner is enabled.
+   * @param {boolean} isConsentBannerEnabled Indicates whether the Nutanix defence knowledge consent banner is enabled.
+   */
+  setIsConsentBannerEnabled(isConsentBannerEnabled) {
+    this.isConsentBannerEnabled = isConsentBannerEnabled;
+  }
+  toJson(forMutation) {
+    if (forMutation === false) {
+      return {
+        ...(typeof this.getIsSecureBootEnabled() !== 'undefined' && this.getIsSecureBootEnabled() !== null ? {
+          'isSecureBootEnabled': this.getIsSecureBootEnabled()
+        } : {}),
+        ...(typeof this.getIsClusterLockdownEnabled() !== 'undefined' && this.getIsClusterLockdownEnabled() !== null ? {
+          'isClusterLockdownEnabled': this.getIsClusterLockdownEnabled()
+        } : {}),
+        ...(typeof this.getIsLogForwardingEnabled() !== 'undefined' && this.getIsLogForwardingEnabled() !== null ? {
+          'isLogForwardingEnabled': this.getIsLogForwardingEnabled()
+        } : {}),
+        ...(typeof this.getIsConsentBannerEnabled() !== 'undefined' && this.getIsConsentBannerEnabled() !== null ? {
+          'isConsentBannerEnabled': this.getIsConsentBannerEnabled()
+        } : {}),
+        ...(typeof this.getCurrentIssueCount() !== 'undefined' && this.getCurrentIssueCount() !== null ? {
+          'currentIssueCount': this.getCurrentIssueCount()
+        } : {}),
+        ...(typeof this.getTrends() !== 'undefined' && this.getTrends() !== null ? {
+          'trends': this.getTrends().map(item => item.toJson(false))
+        } : {}),
+        '$reserved': this.get$Reserved(),
+        '$objectType': this.get$ObjectType(),
+        ...(typeof this.get$UnknownFields() !== 'undefined' && this.get$UnknownFields() !== null ? this.get$UnknownFields() : {}),
+        '$unknownFields': {}
+      };
+    }
+    return {
+      ...(typeof this.getCurrentIssueCount() !== 'undefined' && this.getCurrentIssueCount() !== null ? {
+        'currentIssueCount': this.getCurrentIssueCount()
+      } : {}),
+      ...(typeof this.getTrends() !== 'undefined' && this.getTrends() !== null ? {
+        'trends': this.getTrends().map(item => item.toJson(false))
+      } : {}),
+      '$reserved': this.get$Reserved(),
+      '$objectType': this.get$ObjectType(),
+      ...(typeof this.get$UnknownFields() !== 'undefined' && this.get$UnknownFields() !== null ? this.get$UnknownFields() : {}),
+      '$unknownFields': {}
+    };
+  }
+  validate(scope, properties) {
+    let propList = [];
+    if (arguments.length === 0 || arguments.length === 1 && arguments[0] instanceof _ValidationScopes.default) {
+      //cases validate() and validate(scope)
+      propList = [];
+    } else if (arguments.length === 1) {
+      //case validate(properties)
+      propList = arguments[0];
+      scope = null;
+    } else {
+      //case validate(scope, properties)
+      propList = arguments[1];
+    }
+    let res = [];
+    let err = null;
+    propList.forEach(property => {
+      err = this.validateProperty(property, scope);
+      if (err) {
+        res.push(err);
+      }
+    });
+    return new Promise(function (resolve, reject) {
+      if (res.length !== 0) {
+        reject(err);
+      } else {
+        resolve();
+      }
+    });
+  }
+  validateProperty(scope, property) {
+    if (property === "isSecureBootEnabled") {
+      if (typeof this.isSecureBootEnabled === 'undefined' || this.isSecureBootEnabled === null) {
+        return new _ValidationError.default("isSecureBootEnabled", "undefined or null");
+      }
+    }
+    if (property === "isClusterLockdownEnabled") {
+      if (typeof this.isClusterLockdownEnabled === 'undefined' || this.isClusterLockdownEnabled === null) {
+        return new _ValidationError.default("isClusterLockdownEnabled", "undefined or null");
+      }
+    }
+    if (property === "isLogForwardingEnabled") {
+      if (typeof this.isLogForwardingEnabled === 'undefined' || this.isLogForwardingEnabled === null) {
+        return new _ValidationError.default("isLogForwardingEnabled", "undefined or null");
+      }
+    }
+    if (property === "isConsentBannerEnabled") {
+      if (typeof this.isConsentBannerEnabled === 'undefined' || this.isConsentBannerEnabled === null) {
+        return new _ValidationError.default("isConsentBannerEnabled", "undefined or null");
+      }
+    }
+    return new _ValidationError.default(property, "no such property exists");
+  }
+}
+
+/**
+ * Indicates whether the host secure start is enabled on a cluster.
+ * @memberof SecurityConfigSummary
+ */
+exports.default = SecurityConfigSummary;
+function _toJsonMapType(obj, forMutation) {
+  if (obj instanceof Map) {
+    return Object.fromEntries(Array.from(obj, ([k, v]) => [k, typeof v.toJson !== "undefined" ? v.toJson(forMutation) : v]));
+  } else if (typeof obj === 'object' && obj != null && obj.constructor === Object) {
+    return Object.fromEntries(Array.from(Object.entries(obj), entry => {
+      return [entry[0], typeof entry[1].toJson !== "undefined" ? entry[1].toJson(forMutation) : entry[1]];
+    }));
+  }
+  return obj;
+}
+/*
+* toJson method for a date type which serializes a Date object to proper Date or DateTime formatting
+* @param {Object} obj Object to serialize
+* @param {boolean} isDateOnly Boolean variable to identify Date or DateTime format for serialization
+* @returns {Object|string} Returns serialized date object or original input object
+*/
+function _handleDateType(obj, isDateOnly) {
+  if (obj instanceof Date && isDateOnly !== undefined) {
+    return isDateOnly ? obj.toISOString().slice(0, 10) : obj.toISOString();
+  }
+  return obj;
+}
+SecurityConfigSummary.prototype.isSecureBootEnabled = undefined;
+
+/**
+ * Indicates whether the cluster lockdown mode is enabled on a cluster.
+ * @memberof SecurityConfigSummary
+ */
+SecurityConfigSummary.prototype.isClusterLockdownEnabled = undefined;
+
+/**
+ * Indicates whether the log forwarding is enabled on a cluster.
+ * @memberof SecurityConfigSummary
+ */
+SecurityConfigSummary.prototype.isLogForwardingEnabled = undefined;
+
+/**
+ * Indicates whether the Nutanix defence knowledge consent banner is enabled.
+ * @memberof SecurityConfigSummary
+ */
+SecurityConfigSummary.prototype.isConsentBannerEnabled = undefined;
+
+/**
+  * The number of current issues of similar type.
+  * @memberof SecurityConfigSummary
+  */
+_IssueSummary.default.prototype.currentIssueCount = undefined;
+/**
+  * Historical data containing how many issues were present and when
+  * @memberof SecurityConfigSummary
+  */
+_IssueSummary.default.prototype.trends = undefined;

package/dist/lib/models/security/v4/report/SecuritySummary.d.ts

@@ -0,0 +1,83 @@
+/**
+ * The SecuritySummary model module.
+ * @module Ntnx/SecuritySummary
+ * @version 4.1.2
+ * @class SecuritySummary
+ * @extends ExternalizableAbstractModel
+ */
+export default class SecuritySummary extends ExternalizableAbstractModel {
+    /**
+     * Returns UUID of the cluster.
+     * @return {string}
+     */
+    getClusterExtId(): string;
+    /**
+     * Sets UUID of the cluster.
+     * @param {string} clusterExtId UUID of the cluster.
+     */
+    setClusterExtId(clusterExtId: string): void;
+    clusterExtId: string;
+    /**
+     * @return {SecurityConfigSummary}
+     */
+    getSecurityConfigSummary(): SecurityConfigSummary;
+    /**
+     * @param {SecurityConfigSummary} securityConfigSummary
+     */
+    setSecurityConfigSummary(securityConfigSummary: SecurityConfigSummary): void;
+    securityConfigSummary: SecurityConfigSummary;
+    /**
+     * @return {StigSecuritySummary}
+     */
+    getStigSummary(): StigSecuritySummary;
+    /**
+     * @param {StigSecuritySummary} stigSummary
+     */
+    setStigSummary(stigSummary: StigSecuritySummary): void;
+    stigSummary: StigSecuritySummary;
+    /**
+     * @return {VulnerabilitySummary}
+     */
+    getVulnerabilitiesSummary(): VulnerabilitySummary;
+    /**
+     * @param {VulnerabilitySummary} vulnerabilitiesSummary
+     */
+    setVulnerabilitiesSummary(vulnerabilitiesSummary: VulnerabilitySummary): void;
+    vulnerabilitiesSummary: VulnerabilitySummary;
+    /**
+     * @return {IssueSummary}
+     */
+    getPasswordSummary(): IssueSummary;
+    /**
+     * @param {IssueSummary} passwordSummary
+     */
+    setPasswordSummary(passwordSummary: IssueSummary): void;
+    passwordSummary: IssueSummary;
+    /**
+     * @return {Timescale}
+     */
+    getTrendType(): Timescale;
+    /**
+     * @param {Timescale} trendType
+     */
+    setTrendType(trendType: Timescale): void;
+    trendType: string;
+    /**
+     * Returns The date the dashboard information was last refreshed.
+     * @return {Date}
+     */
+    getLastRefreshTime(): Date;
+    /**
+     * Sets The date the dashboard information was last refreshed.
+     * @param {Date} lastRefreshTime The date the dashboard information was last refreshed.
+     */
+    setLastRefreshTime(lastRefreshTime: Date): void;
+    lastRefreshTime: Date;
+    #private;
+}
+import ExternalizableAbstractModel from "../../../common/v1/response/ExternalizableAbstractModel";
+import SecurityConfigSummary from "./SecurityConfigSummary";
+import StigSecuritySummary from "./StigSecuritySummary";
+import VulnerabilitySummary from "./VulnerabilitySummary";
+import IssueSummary from "./IssueSummary";
+import Timescale from "../common/Timescale";