@nutanix-scratch/licensing-js-client 1.421.1

package/dist/lib/models/licensing/v4/config/Recommendation.d.ts

@@ -0,0 +1,47 @@
+/**
+ * The Recommendation model module.
+ * @module Ntnx/Recommendation
+ * @version 1.421.1
+ * @class Recommendation
+ * @extends ExternalizableAbstractModel
+ */
+export default class Recommendation extends ExternalizableAbstractModel {
+    /**
+     * Returns Array containing recommendations for the cluster and its associated licenses.
+     * @return {RecommendationDetail[]}
+     */
+    getDetails(): RecommendationDetail[];
+    /**
+     * Sets Array containing recommendations for the cluster and its associated licenses.
+     * @param {RecommendationDetail[]} details Array containing recommendations for the cluster and its associated licenses.
+     */
+    setDetails(details: RecommendationDetail[]): void;
+    details: RecommendationDetail[];
+    toJson(forMutation: any): {
+        $reserved: any;
+        $objectType: string;
+        $unknownFields: any;
+        tenantId?: string;
+        links?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            rel?: string;
+            href?: string;
+        }[];
+        extId?: string;
+        details?: {
+            $reserved: any;
+            $objectType: string;
+            $unknownFields: any;
+            comment?: string;
+            licenseExpiryDate?: any;
+            licenseId?: string;
+            operation?: string;
+            scope?: string;
+        }[];
+    };
+    #private;
+}
+import ExternalizableAbstractModel from "../../../common/v1/response/ExternalizableAbstractModel";
+import RecommendationDetail from "./RecommendationDetail";

package/dist/lib/models/licensing/v4/config/Recommendation.js

@@ -0,0 +1,287 @@
+"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 _RecommendationDetail = _interopRequireDefault(require("./RecommendationDetail"));
+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 _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
+function _slicedToArray(r, e) { return _arrayWithHoles(r) || _iterableToArrayLimit(r, e) || _unsupportedIterableToArray(r, e) || _nonIterableRest(); }
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
+function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
+function _iterableToArrayLimit(r, l) { var t = null == r ? null : "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (null != t) { var e, n, i, u, a = [], f = !0, o = !1; try { if (i = (t = t.call(r)).next, 0 === l) { if (Object(t) !== t) return; f = !1; } else for (; !(f = (e = i.call(t)).done) && (a.push(e.value), a.length !== l); f = !0); } catch (r) { o = !0, n = r; } finally { try { if (!f && null != t["return"] && (u = t["return"](), Object(u) !== u)) return; } finally { if (o) throw n; } } return a; } }
+function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
+function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
+function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
+function _possibleConstructorReturn(t, e) { if (e && ("object" == _typeof(e) || "function" == typeof e)) return e; if (void 0 !== e) throw new TypeError("Derived constructors may only return object or undefined"); return _assertThisInitialized(t); }
+function _assertThisInitialized(e) { if (void 0 === e) throw new ReferenceError("this hasn't been initialised - super() hasn't been called"); return e; }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+function _getPrototypeOf(t) { return _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf.bind() : function (t) { return t.__proto__ || Object.getPrototypeOf(t); }, _getPrototypeOf(t); }
+function _inherits(t, e) { if ("function" != typeof e && null !== e) throw new TypeError("Super expression must either be null or a function"); t.prototype = Object.create(e && e.prototype, { constructor: { value: t, writable: !0, configurable: !0 } }), Object.defineProperty(t, "prototype", { writable: !1 }), e && _setPrototypeOf(t, e); }
+function _setPrototypeOf(t, e) { return _setPrototypeOf = Object.setPrototypeOf ? Object.setPrototypeOf.bind() : function (t, e) { return t.__proto__ = e, t; }, _setPrototypeOf(t, 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 Licensing APIs
+ *
+ * OpenAPI spec version: 1.421.1
+ *
+ * NOTE: This class is auto generated by the Open API Dev Platform.
+ *
+ * Open API Dev Platform Codegen version: 17.3.1.9079-RELEASE
+ *
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * The Recommendation model module.
+ * @module Ntnx/Recommendation
+ * @version 1.421.1
+ * @class Recommendation
+ * @extends ExternalizableAbstractModel
+ */
+var _Recommendation_brand = /*#__PURE__*/new WeakSet();
+var Recommendation = exports["default"] = /*#__PURE__*/function (_ExternalizableAbstra) {
+  /**
+   * Constructs a new <code>Recommendation</code>.
+   * Model for capturing recommendation response.
+   * @alias module:Ntnx/Recommendation
+   * @extends module:Ntnx/ExternalizableAbstractModel
+  */
+  function Recommendation() {
+    var _this;
+    _classCallCheck(this, Recommendation);
+    _this = _callSuper(this, Recommendation);
+    /*
+    * 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, _Recommendation_brand);
+    _this.$objectType = "licensing.v4.config.Recommendation";
+    /** @type {object<string, any>} */
+    _this.$reserved = {
+      '$fv': "v4.r2"
+    };
+    /** @type {object<string, any>} */
+    _this.$unknownFields = {};
+    return _this;
+  }
+
+  /**
+   * Constructs a <code>Recommendation</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/Recommendation} obj Optional instance to populate.
+   * @param callFromChild {Boolean} Flag to recognise calling instance
+   * @return {module:Ntnx/Recommendation} The populated <code>Recommendation</code> instance.
+   */
+  _inherits(Recommendation, _ExternalizableAbstra);
+  return _createClass(Recommendation, [{
+    key: "getDetails",
+    value:
+    /**
+     * Returns Array containing recommendations for the cluster and its associated licenses.
+     * @return {RecommendationDetail[]}
+     */
+    function getDetails() {
+      return this.details;
+    }
+
+    /**
+     * Sets Array containing recommendations for the cluster and its associated licenses.
+     * @param {RecommendationDetail[]} details Array containing recommendations for the cluster and its associated licenses.
+     */
+  }, {
+    key: "setDetails",
+    value: function setDetails(details) {
+      this.details = details;
+    }
+  }, {
+    key: "toJson",
+    value: function toJson(forMutation) {
+      if (forMutation === false) {
+        return _objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread({}, typeof this.getDetails() !== 'undefined' && this.getDetails() !== null ? {
+          'details': this.getDetails().map(function (item) {
+            return item.toJson(false);
+          })
+        } : {}), typeof this.getExtId() !== 'undefined' && this.getExtId() !== null ? {
+          'extId': this.getExtId()
+        } : {}), typeof this.getLinks() !== 'undefined' && this.getLinks() !== null ? {
+          'links': this.getLinks().map(function (item) {
+            return item.toJson(false);
+          })
+        } : {}), typeof this.getTenantId() !== 'undefined' && this.getTenantId() !== null ? {
+          'tenantId': this.getTenantId()
+        } : {}), {}, {
+          '$reserved': this.get$Reserved(),
+          '$objectType': this.get$ObjectType(),
+          '$unknownFields': this.get$UnknownFields()
+        });
+      }
+      return _objectSpread(_objectSpread({}, typeof this.getDetails() !== 'undefined' && this.getDetails() !== null ? {
+        'details': this.getDetails().map(function (item) {
+          return item.toJson(false);
+        })
+      } : {}), {}, {
+        '$reserved': this.get$Reserved(),
+        '$objectType': this.get$ObjectType(),
+        '$unknownFields': this.get$UnknownFields()
+      });
+    }
+  }, {
+    key: "validate",
+    value: function validate(scope, properties) {
+      var _this2 = this;
+      var 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];
+      }
+      var res = [];
+      var err = null;
+      propList.forEach(function (property) {
+        err = _this2.validateProperty(property, scope);
+        if (err) {
+          res.push(err);
+        }
+      });
+      return new Promise(function (resolve, reject) {
+        if (res.length !== 0) {
+          reject(err);
+        } else {
+          resolve();
+        }
+      });
+    }
+  }, {
+    key: "validateProperty",
+    value: function validateProperty(scope, property) {
+      if (property === "details") {
+        if (typeof this.details === 'undefined' || this.details === null) {
+          return new _ValidationError["default"]("details", "undefined or null");
+        }
+        if (!_ValidationUtils["default"].validateMaxItems(this.details, 50)) {
+          return new _ValidationError["default"]("details", "does not satisfy required maxItems constraint: 50");
+        }
+      }
+      return new _ValidationError["default"](property, "no such property exists");
+    }
+  }], [{
+    key: "constructFromObject",
+    value: function constructFromObject(data) {
+      var obj = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : null;
+      var callFromChild = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
+      var items, item, i, itemArr, discriminator;
+      if (data) {
+        obj = obj || new Recommendation();
+        _ExternalizableAbstractModel["default"].constructFromObject(data, obj, true);
+        if (data.hasOwnProperty('details') && data.details !== null && data.details !== undefined) {
+          itemArr = [];
+          items = data.details;
+          for (i = 0; i < items.length; i++) {
+            item = _RecommendationDetail["default"].constructFromObject(items[i], undefined);
+            itemArr.push(item);
+          }
+          obj.setDetails(itemArr);
+        }
+        if (!callFromChild) {
+          obj.$unknownFields = _objectSpread({}, data.$unknownFields);
+          for (var 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.
+    */
+  }, {
+    key: "snakeToCamel",
+    value: function snakeToCamel(snakeStr) {
+      return snakeStr.replace(/(_\w)/g, function (match) {
+        return match[1].toUpperCase();
+      });
+    }
+  }]);
+}(_ExternalizableAbstractModel["default"]);
+/**
+ * Array containing recommendations for the cluster and its associated licenses.
+ * @memberof Recommendation
+ */
+function _toJsonMapType(obj, forMutation) {
+  if (obj instanceof Map) {
+    return Object.fromEntries(Array.from(obj, function (_ref) {
+      var _ref2 = _slicedToArray(_ref, 2),
+        k = _ref2[0],
+        v = _ref2[1];
+      return [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), function (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;
+}
+Recommendation.prototype.details = undefined;
+
+/**
+  * A globally unique identifier of an instance that is suitable for external consumption. 
+  * @memberof Recommendation
+  */
+_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 Recommendation
+  */
+_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 Recommendation
+  */
+_TenantAwareModel["default"].prototype.tenantId = undefined;

package/dist/lib/models/licensing/v4/config/RecommendationDetail.d.ts

@@ -0,0 +1,98 @@
+/**
+ * The RecommendationDetail model module.
+ * @module Ntnx/RecommendationDetail
+ * @version 1.421.1
+ * @class RecommendationDetail
+ */
+export default class RecommendationDetail {
+    /**
+     * Constructs a <code>RecommendationDetail</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/RecommendationDetail} obj Optional instance to populate.
+     * @param callFromChild {Boolean} Flag to recognise calling instance
+     * @return {module:Ntnx/RecommendationDetail} The populated <code>RecommendationDetail</code> instance.
+     */
+    static constructFromObject(data: any, obj?: any, callFromChild?: boolean): any;
+    /**
+    * 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: string): string;
+    $objectType: string;
+    /** @type {object<string, any>} */
+    $reserved: object;
+    /** @type {object<string, any>} */
+    $unknownFields: object;
+    /**
+     * @return {RecommendationScope}
+     */
+    getScope(): RecommendationScope;
+    /**
+     * @param {RecommendationScope} scope
+     */
+    setScope(scope: RecommendationScope): void;
+    scope: string;
+    /**
+     * @return {OperationType}
+     */
+    getOperation(): OperationType;
+    /**
+     * @param {OperationType} operation
+     */
+    setOperation(operation: OperationType): void;
+    operation: string;
+    /**
+     * Returns Attribute for capturing the license ID.
+     * @return {string}
+     */
+    getLicenseId(): string;
+    /**
+     * Sets Attribute for capturing the license ID.
+     * @param {string} licenseId Attribute for capturing the license ID.
+     */
+    setLicenseId(licenseId: string): void;
+    licenseId: string;
+    /**
+     * Returns Attribute for capturing the license expiration date.
+     * @return {Date}
+     */
+    getLicenseExpiryDate(): Date;
+    /**
+     * Sets Attribute for capturing the license expiration date.
+     * @param {Date} licenseExpiryDate Attribute for capturing the license expiration date.
+     */
+    setLicenseExpiryDate(licenseExpiryDate: Date): void;
+    licenseExpiryDate: Date;
+    /**
+     * Returns Attribute for capturing comments regarding the recommendation like cluster over licensed and others.
+     * @return {string}
+     */
+    getComment(): string;
+    /**
+     * Sets Attribute for capturing comments regarding the recommendation like cluster over licensed and others.
+     * @param {string} comment Attribute for capturing comments regarding the recommendation like cluster over licensed and others.
+     */
+    setComment(comment: string): void;
+    comment: string;
+    get$Reserved(): any;
+    get$ObjectType(): string;
+    get$UnknownFields(): any;
+    toJson(forMutation: any): {
+        $reserved: any;
+        $objectType: string;
+        $unknownFields: any;
+        comment?: string;
+        licenseExpiryDate?: any;
+        licenseId?: string;
+        operation?: string;
+        scope?: string;
+    };
+    validate(scope: any, properties: any, ...args: any[]): Promise<any>;
+    validateProperty(scope: any, property: any): ValidationError;
+    #private;
+}
+import RecommendationScope from "./RecommendationScope";
+import OperationType from "./OperationType";
+import ValidationError from "../../../validation/ValidationError";