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

package/dist/es/models/security/v4/report/SecuritySummary.js

@@ -0,0 +1,438 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _TenantAwareModel = _interopRequireDefault(require("../../../common/v1/config/TenantAwareModel"));
+var _ApiLink = _interopRequireDefault(require("../../../common/v1/response/ApiLink"));
+var _ExternalizableAbstractModel = _interopRequireDefault(require("../../../common/v1/response/ExternalizableAbstractModel"));
+var _Timescale = _interopRequireDefault(require("../common/Timescale"));
+var _IssueSummary = _interopRequireDefault(require("./IssueSummary"));
+var _SecurityConfigSummary = _interopRequireDefault(require("./SecurityConfigSummary"));
+var _StigSecuritySummary = _interopRequireDefault(require("./StigSecuritySummary"));
+var _VulnerabilitySummary = _interopRequireDefault(require("./VulnerabilitySummary"));
+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"); }
+function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this 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 SecuritySummary model module.
+ * @module Ntnx/SecuritySummary
+ * @version 4.1.2
+ * @class SecuritySummary
+ * @extends ExternalizableAbstractModel
+ */
+var _SecuritySummary_brand = /*#__PURE__*/new WeakSet();
+class SecuritySummary extends _ExternalizableAbstractModel.default {
+  /**
+   * Constructs a new <code>SecuritySummary</code>.
+   * Summary of security related issues on each cluster.
+   * @alias module:Ntnx/SecuritySummary
+   * @extends module:Ntnx/ExternalizableAbstractModel
+  */
+  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, _SecuritySummary_brand);
+    this.$objectType = "security.v4.report.SecuritySummary";
+    /** @type {object<string, any>} */
+    this.$reserved = {
+      '$fv': "v4.r1"
+    };
+    /** @type {object<string, any>} */
+    this.$unknownFields = {};
+  }
+
+  /**
+   * Constructs a <code>SecuritySummary</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/SecuritySummary} obj Optional instance to populate.
+   * @param callFromChild {Boolean} Flag to recognise calling instance
+   * @return {module:Ntnx/SecuritySummary} The populated <code>SecuritySummary</code> instance.
+   */
+  static constructFromObject(data, obj = null, callFromChild = false) {
+    let items, item, i, itemArr, discriminator;
+    if (data) {
+      obj = obj || new SecuritySummary();
+      _ExternalizableAbstractModel.default.constructFromObject(data, obj, true);
+      if (data.hasOwnProperty('clusterExtId') && data.clusterExtId !== null && data.clusterExtId !== undefined) {
+        obj.setClusterExtId(data['clusterExtId']);
+      }
+      if (data.hasOwnProperty('securityConfigSummary') && data.securityConfigSummary !== null && data.securityConfigSummary !== undefined) {
+        obj.setSecurityConfigSummary(_SecurityConfigSummary.default.constructFromObject(data['securityConfigSummary']));
+      }
+      if (data.hasOwnProperty('stigSummary') && data.stigSummary !== null && data.stigSummary !== undefined) {
+        obj.setStigSummary(_StigSecuritySummary.default.constructFromObject(data['stigSummary']));
+      }
+      if (data.hasOwnProperty('vulnerabilitiesSummary') && data.vulnerabilitiesSummary !== null && data.vulnerabilitiesSummary !== undefined) {
+        obj.setVulnerabilitiesSummary(_VulnerabilitySummary.default.constructFromObject(data['vulnerabilitiesSummary']));
+      }
+      if (data.hasOwnProperty('passwordSummary') && data.passwordSummary !== null && data.passwordSummary !== undefined) {
+        obj.setPasswordSummary(_IssueSummary.default.constructFromObject(data['passwordSummary']));
+      }
+      if (data.hasOwnProperty('trendType') && data.trendType !== null && data.trendType !== undefined) {
+        obj.setTrendType(_Timescale.default.constructFromObject(data['trendType']));
+      }
+      if (data.hasOwnProperty('lastRefreshTime') && data.lastRefreshTime !== null && data.lastRefreshTime !== undefined) {
+        obj.setLastRefreshTime(data['lastRefreshTime']);
+      }
+      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 UUID of the cluster.
+   * @return {string}
+   */
+  getClusterExtId() {
+    return this.clusterExtId;
+  }
+
+  /**
+   * Sets UUID of the cluster.
+   * @param {string} clusterExtId UUID of the cluster.
+   */
+  setClusterExtId(clusterExtId) {
+    this.clusterExtId = clusterExtId;
+  }
+
+  /**
+   * @return {SecurityConfigSummary}
+   */
+  getSecurityConfigSummary() {
+    return this.securityConfigSummary;
+  }
+
+  /**
+   * @param {SecurityConfigSummary} securityConfigSummary
+   */
+  setSecurityConfigSummary(securityConfigSummary) {
+    this.securityConfigSummary = securityConfigSummary;
+  }
+
+  /**
+   * @return {StigSecuritySummary}
+   */
+  getStigSummary() {
+    return this.stigSummary;
+  }
+
+  /**
+   * @param {StigSecuritySummary} stigSummary
+   */
+  setStigSummary(stigSummary) {
+    this.stigSummary = stigSummary;
+  }
+
+  /**
+   * @return {VulnerabilitySummary}
+   */
+  getVulnerabilitiesSummary() {
+    return this.vulnerabilitiesSummary;
+  }
+
+  /**
+   * @param {VulnerabilitySummary} vulnerabilitiesSummary
+   */
+  setVulnerabilitiesSummary(vulnerabilitiesSummary) {
+    this.vulnerabilitiesSummary = vulnerabilitiesSummary;
+  }
+
+  /**
+   * @return {IssueSummary}
+   */
+  getPasswordSummary() {
+    return this.passwordSummary;
+  }
+
+  /**
+   * @param {IssueSummary} passwordSummary
+   */
+  setPasswordSummary(passwordSummary) {
+    this.passwordSummary = passwordSummary;
+  }
+
+  /**
+   * @return {Timescale}
+   */
+  getTrendType() {
+    return this.trendType;
+  }
+
+  /**
+   * @param {Timescale} trendType
+   */
+  setTrendType(trendType) {
+    this.trendType = trendType;
+  }
+
+  /**
+   * Returns The date the dashboard information was last refreshed.
+   * @return {Date}
+   */
+  getLastRefreshTime() {
+    return this.lastRefreshTime;
+  }
+
+  /**
+   * Sets The date the dashboard information was last refreshed.
+   * @param {Date} lastRefreshTime The date the dashboard information was last refreshed.
+   */
+  setLastRefreshTime(lastRefreshTime) {
+    this.lastRefreshTime = lastRefreshTime;
+  }
+  toJson(forMutation) {
+    if (forMutation === false) {
+      return {
+        ...(typeof this.getClusterExtId() !== 'undefined' && this.getClusterExtId() !== null ? {
+          'clusterExtId': this.getClusterExtId()
+        } : {}),
+        ...(typeof this.getSecurityConfigSummary() !== 'undefined' && this.getSecurityConfigSummary() !== null ? {
+          'securityConfigSummary': this.getSecurityConfigSummary().toJson(false)
+        } : {}),
+        ...(typeof this.getStigSummary() !== 'undefined' && this.getStigSummary() !== null ? {
+          'stigSummary': this.getStigSummary().toJson(false)
+        } : {}),
+        ...(typeof this.getVulnerabilitiesSummary() !== 'undefined' && this.getVulnerabilitiesSummary() !== null ? {
+          'vulnerabilitiesSummary': this.getVulnerabilitiesSummary().toJson(false)
+        } : {}),
+        ...(typeof this.getPasswordSummary() !== 'undefined' && this.getPasswordSummary() !== null ? {
+          'passwordSummary': this.getPasswordSummary().toJson(false)
+        } : {}),
+        ...(typeof this.getTrendType() !== 'undefined' && this.getTrendType() !== null ? {
+          'trendType': this.getTrendType()
+        } : {}),
+        ...(typeof this.getLastRefreshTime() !== 'undefined' && this.getLastRefreshTime() !== null ? {
+          'lastRefreshTime': _assertClassBrand(_SecuritySummary_brand, this, _handleDateType).call(this, this.getLastRefreshTime(), false)
+        } : {}),
+        ...(typeof this.getExtId() !== 'undefined' && this.getExtId() !== null ? {
+          'extId': this.getExtId()
+        } : {}),
+        ...(typeof this.getLinks() !== 'undefined' && this.getLinks() !== null ? {
+          'links': this.getLinks().map(item => item.toJson(false))
+        } : {}),
+        ...(typeof this.getTenantId() !== 'undefined' && this.getTenantId() !== null ? {
+          'tenantId': this.getTenantId()
+        } : {}),
+        '$reserved': this.get$Reserved(),
+        '$objectType': this.get$ObjectType(),
+        ...(typeof this.get$UnknownFields() !== 'undefined' && this.get$UnknownFields() !== null ? this.get$UnknownFields() : {}),
+        '$unknownFields': {}
+      };
+    }
+    return {
+      ...(typeof this.getSecurityConfigSummary() !== 'undefined' && this.getSecurityConfigSummary() !== null ? {
+        'securityConfigSummary': this.getSecurityConfigSummary().toJson(false)
+      } : {}),
+      ...(typeof this.getStigSummary() !== 'undefined' && this.getStigSummary() !== null ? {
+        'stigSummary': this.getStigSummary().toJson(false)
+      } : {}),
+      ...(typeof this.getVulnerabilitiesSummary() !== 'undefined' && this.getVulnerabilitiesSummary() !== null ? {
+        'vulnerabilitiesSummary': this.getVulnerabilitiesSummary().toJson(false)
+      } : {}),
+      ...(typeof this.getPasswordSummary() !== 'undefined' && this.getPasswordSummary() !== null ? {
+        'passwordSummary': this.getPasswordSummary().toJson(false)
+      } : {}),
+      ...(typeof this.getTrendType() !== 'undefined' && this.getTrendType() !== null ? {
+        'trendType': this.getTrendType()
+      } : {}),
+      ...(typeof this.getLastRefreshTime() !== 'undefined' && this.getLastRefreshTime() !== null ? {
+        'lastRefreshTime': _assertClassBrand(_SecuritySummary_brand, this, _handleDateType).call(this, this.getLastRefreshTime(), 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 === "clusterExtId") {
+      if (typeof this.clusterExtId === 'undefined' || this.clusterExtId === null) {
+        return new _ValidationError.default("clusterExtId", "undefined or null");
+      }
+      if (!_ValidationUtils.default.validatePattern(this.clusterExtId, /^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/)) {
+        return new _ValidationError.default("clusterExtId", "does not satisfy required pattern: /^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}$/");
+      }
+    }
+    if (property === "securityConfigSummary") {
+      if (typeof this.securityConfigSummary === 'undefined' || this.securityConfigSummary === null) {
+        return new _ValidationError.default("securityConfigSummary", "undefined or null");
+      }
+    }
+    if (property === "stigSummary") {
+      if (typeof this.stigSummary === 'undefined' || this.stigSummary === null) {
+        return new _ValidationError.default("stigSummary", "undefined or null");
+      }
+    }
+    if (property === "vulnerabilitiesSummary") {
+      if (typeof this.vulnerabilitiesSummary === 'undefined' || this.vulnerabilitiesSummary === null) {
+        return new _ValidationError.default("vulnerabilitiesSummary", "undefined or null");
+      }
+    }
+    if (property === "passwordSummary") {
+      if (typeof this.passwordSummary === 'undefined' || this.passwordSummary === null) {
+        return new _ValidationError.default("passwordSummary", "undefined or null");
+      }
+    }
+    if (property === "trendType") {
+      if (typeof this.trendType === 'undefined' || this.trendType === null) {
+        return new _ValidationError.default("trendType", "undefined or null");
+      }
+    }
+    if (property === "lastRefreshTime") {
+      if (typeof this.lastRefreshTime === 'undefined' || this.lastRefreshTime === null) {
+        return new _ValidationError.default("lastRefreshTime", "undefined or null");
+      }
+    }
+    return new _ValidationError.default(property, "no such property exists");
+  }
+}
+
+/**
+ * UUID of the cluster.
+ * @memberof SecuritySummary
+ */
+exports.default = SecuritySummary;
+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;
+}
+SecuritySummary.prototype.clusterExtId = undefined;
+
+/**
+ * @memberof SecuritySummary
+ */
+SecuritySummary.prototype.securityConfigSummary = undefined;
+
+/**
+ * @memberof SecuritySummary
+ */
+SecuritySummary.prototype.stigSummary = undefined;
+
+/**
+ * @memberof SecuritySummary
+ */
+SecuritySummary.prototype.vulnerabilitiesSummary = undefined;
+
+/**
+ * @memberof SecuritySummary
+ */
+SecuritySummary.prototype.passwordSummary = undefined;
+
+/**
+ * @memberof SecuritySummary
+ */
+SecuritySummary.prototype.trendType = undefined;
+
+/**
+ * The date the dashboard information was last refreshed.
+ * @memberof SecuritySummary
+ */
+SecuritySummary.prototype.lastRefreshTime = undefined;
+
+/**
+  * A globally unique identifier of an instance that is suitable for external consumption. 
+  * @memberof SecuritySummary
+  */
+_ExternalizableAbstractModel.default.prototype.extId = undefined;
+/**
+  * A HATEOAS style link for the response.  Each link contains a user-friendly name identifying the link and an address for retrieving the particular resource. 
+  * @memberof SecuritySummary
+  */
+_ExternalizableAbstractModel.default.prototype.links = undefined;
+/**
+  * A globally unique identifier that represents the tenant that owns this entity. The system automatically assigns it, and it and is immutable from an API consumer perspective (some use cases may cause this ID to change - For instance, a use case may require the transfer of ownership of the entity, but these cases are handled automatically on the server). 
+  * @memberof SecuritySummary
+  */
+_TenantAwareModel.default.prototype.tenantId = undefined;

package/dist/es/models/security/v4/report/SecuritySummaryProjection.d.ts

@@ -0,0 +1,21 @@
+/**
+ * The SecuritySummaryProjection model module.
+ * @module Ntnx/SecuritySummaryProjection
+ * @version 4.1.2
+ * @class SecuritySummaryProjection
+ * @extends SecuritySummary
+ */
+export default class SecuritySummaryProjection extends SecuritySummary {
+    /**
+     * @return {ClusterProjection}
+     */
+    getClusterProjection(): ClusterProjection;
+    /**
+     * @param {ClusterProjection} clusterProjection
+     */
+    setClusterProjection(clusterProjection: ClusterProjection): void;
+    clusterProjection: ClusterProjection;
+    #private;
+}
+import SecuritySummary from "./SecuritySummary";
+import ClusterProjection from "../common/ClusterProjection";