@nutanix-scratch/licensing-js-client 4.0.1-alpha.1 → 4.1.1

package/dist/es/models/licensing/v4/config/CapacityViolation.d.ts

@@ -1,7 +1,7 @@
 /**
  * The CapacityViolation model module.
  * @module Ntnx/CapacityViolation
- * @version 4.0.1-alpha-1
+ * @version 4.1.1
  * @class CapacityViolation
  */
 export default class CapacityViolation {
@@ -13,68 +13,73 @@ export default class CapacityViolation {
      * @param callFromChild {Boolean} Flag to recognise calling instance
      * @return {module:Ntnx/CapacityViolation} The populated <code>CapacityViolation</code> instance.
      */
-    static constructFromObject(data: any, obj: any, callFromChild?: boolean): any;
+    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;
-    $reserved: {
-        $fv: string;
-    };
-    $unknownFields: {};
+    /** @type {object<string, any>} */
+    $reserved: object;
+    /** @type {object<string, any>} */
+    $unknownFields: object;
     /**
-     * @return {}
+     * @return {LicenseType}
      */
-    getType(): any;
+    getType(): LicenseType;
     /**
-     * @param {} type
+     * @param {LicenseType} type
      */
-    setType(type: any): void;
-    type: any;
+    setType(type: LicenseType): void;
+    type: string;
     /**
-     * @return {}
+     * @return {LicenseCategory}
      */
-    getCategory(): any;
+    getCategory(): LicenseCategory;
     /**
-     * @param {} category
+     * @param {LicenseCategory} category
      */
-    setCategory(category: any): void;
-    category: any;
+    setCategory(category: LicenseCategory): void;
+    category: string;
     /**
-     * @return {}
+     * @return {Meter}
      */
-    getMeter(): any;
+    getMeter(): Meter;
     /**
-     * @param {} meter
+     * @param {Meter} meter
      */
-    setMeter(meter: any): void;
-    meter: any;
+    setMeter(meter: Meter): void;
+    meter: string;
     /**
-     * Returns Indicates the insufficient quantity of a license.License of given quantity should be applied for a cluster to function properly
-     * @return {}
+     * Returns Indicates the insufficient quantity of a license. License of given quantity should be applied for a cluster to function properly
+     * @return {Number}
      */
-    getInsufficientQuantity(): any;
+    getShortfall(): number;
     /**
-     * Sets Indicates the insufficient quantity of a license.License of given quantity should be applied for a cluster to function properly
-     * @param {} insufficientQuantity Indicates the insufficient quantity of a license.License of given quantity should be applied for a cluster to function properly
+     * Sets Indicates the insufficient quantity of a license. License of given quantity should be applied for a cluster to function properly
+     * @param {Number} shortfall Indicates the insufficient quantity of a license. License of given quantity should be applied for a cluster to function properly
      */
-    setInsufficientQuantity(insufficientQuantity: any): void;
-    insufficientQuantity: any;
-    get$Reserved(): {
-        $fv: string;
-    };
+    setShortfall(shortfall: number): void;
+    shortfall: number;
+    get$Reserved(): any;
     get$ObjectType(): string;
-    get$UnknownFields(): {};
+    get$UnknownFields(): any;
     toJson(forMutation: any): {
-        $reserved: {
-            $fv: string;
-        };
+        $reserved: any;
         $objectType: string;
-        $unknownFields: {};
-        insufficientQuantity?: any;
-        meter?: any;
-        category?: any;
-        type?: any;
+        $unknownFields: any;
+        shortfall?: number;
+        meter?: string;
+        category?: string;
+        type?: string;
     };
     validate(scope: any, properties: any, ...args: any[]): Promise<any>;
     validateProperty(scope: any, property: any): ValidationError;
     #private;
 }
+import LicenseType from "./LicenseType";
+import LicenseCategory from "./LicenseCategory";
+import Meter from "./Meter";
 import ValidationError from "../../../validation/ValidationError";

package/dist/es/models/licensing/v4/config/CapacityViolation.js

@@ -4,37 +4,37 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports["default"] = void 0;
-var _LicenseCategoryEnum = _interopRequireDefault(require("./LicenseCategoryEnum"));
-var _LicenseTypeEnum = _interopRequireDefault(require("./LicenseTypeEnum"));
-var _MeterEnum = _interopRequireDefault(require("./MeterEnum"));
+var _LicenseCategory = _interopRequireDefault(require("./LicenseCategory"));
+var _LicenseType = _interopRequireDefault(require("./LicenseType"));
+var _Meter = _interopRequireDefault(require("./Meter"));
 var _ValidationScopes = _interopRequireDefault(require("../../../validation/ValidationScopes"));
 var _ValidationUtils = _interopRequireDefault(require("../../../../utils/ValidationUtils"));
 var _ValidationError = _interopRequireDefault(require("../../../validation/ValidationError"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
+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(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+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(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
-function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+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(arr) { if (Array.isArray(arr)) return arr; }
+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(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
-function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
-function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+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 _classPrivateMethodInitSpec(obj, privateSet) { _checkPrivateRedeclaration(obj, privateSet); privateSet.add(obj); }
-function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollection.has(obj)) { throw new TypeError("Cannot initialize the same private elements twice on an object"); } } /*
- * Nutanix Licensing Versioned APIs
+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: 4.0.1-alpha-1
+ * OpenAPI spec version: 4.1.1
  *
  * NOTE: This class is auto generated by the Open API Dev Platform.
  *
- * Open API Dev Platform Codegen version: 16.8.0.7344-RELEASE
+ * Open API Dev Platform Codegen version: 17.4.0.8851-RELEASE
  *
  * Do not edit the class manually.
  *
@@ -42,14 +42,14 @@ function _checkPrivateRedeclaration(obj, privateCollection) { if (privateCollect
 /**
  * The CapacityViolation model module.
  * @module Ntnx/CapacityViolation
- * @version 4.0.1-alpha-1
+ * @version 4.1.1
  * @class CapacityViolation
  */
 var _CapacityViolation_brand = /*#__PURE__*/new WeakSet();
 var CapacityViolation = exports["default"] = /*#__PURE__*/function () {
   /**
    * Constructs a new <code>CapacityViolation</code>.
-   * Model for capturing capacity violation. Capacity violations are thrown when user has not applied licenses to extended capacity.
+   * Model for capturing capacity violation. Capacity violations are thrown when a user has not applied licenses to extended capacity.
    * @alias module:Ntnx/CapacityViolation
   */
   function CapacityViolation() {
@@ -62,9 +62,11 @@ var CapacityViolation = exports["default"] = /*#__PURE__*/function () {
     */
     _classPrivateMethodInitSpec(this, _CapacityViolation_brand);
     this.$objectType = "licensing.v4.config.CapacityViolation";
+    /** @type {object<string, any>} */
     this.$reserved = {
-      '$fv': "v4.r0.a1"
+      '$fv': "v4.r1"
     };
+    /** @type {object<string, any>} */
     this.$unknownFields = {};
   }
 
@@ -80,14 +82,14 @@ var CapacityViolation = exports["default"] = /*#__PURE__*/function () {
     key: "getType",
     value:
     /**
-     * @return {}
+     * @return {LicenseType}
      */
     function getType() {
       return this.type;
     }
 
     /**
-     * @param {} type
+     * @param {LicenseType} type
      */
   }, {
     key: "setType",
@@ -96,7 +98,7 @@ var CapacityViolation = exports["default"] = /*#__PURE__*/function () {
     }
 
     /**
-     * @return {}
+     * @return {LicenseCategory}
      */
   }, {
     key: "getCategory",
@@ -105,7 +107,7 @@ var CapacityViolation = exports["default"] = /*#__PURE__*/function () {
     }
 
     /**
-     * @param {} category
+     * @param {LicenseCategory} category
      */
   }, {
     key: "setCategory",
@@ -114,7 +116,7 @@ var CapacityViolation = exports["default"] = /*#__PURE__*/function () {
     }
 
     /**
-     * @return {}
+     * @return {Meter}
      */
   }, {
     key: "getMeter",
@@ -123,7 +125,7 @@ var CapacityViolation = exports["default"] = /*#__PURE__*/function () {
     }
 
     /**
-     * @param {} meter
+     * @param {Meter} meter
      */
   }, {
     key: "setMeter",
@@ -132,23 +134,23 @@ var CapacityViolation = exports["default"] = /*#__PURE__*/function () {
     }
 
     /**
-     * Returns Indicates the insufficient quantity of a license.License of given quantity should be applied for a cluster to function properly
-     * @return {}
+     * Returns Indicates the insufficient quantity of a license. License of given quantity should be applied for a cluster to function properly
+     * @return {Number}
      */
   }, {
-    key: "getInsufficientQuantity",
-    value: function getInsufficientQuantity() {
-      return this.insufficientQuantity;
+    key: "getShortfall",
+    value: function getShortfall() {
+      return this.shortfall;
     }
 
     /**
-     * Sets Indicates the insufficient quantity of a license.License of given quantity should be applied for a cluster to function properly
-     * @param {} insufficientQuantity Indicates the insufficient quantity of a license.License of given quantity should be applied for a cluster to function properly
+     * Sets Indicates the insufficient quantity of a license. License of given quantity should be applied for a cluster to function properly
+     * @param {Number} shortfall Indicates the insufficient quantity of a license. License of given quantity should be applied for a cluster to function properly
      */
   }, {
-    key: "setInsufficientQuantity",
-    value: function setInsufficientQuantity(insufficientQuantity) {
-      this.insufficientQuantity = insufficientQuantity;
+    key: "setShortfall",
+    value: function setShortfall(shortfall) {
+      this.shortfall = shortfall;
     }
   }, {
     key: "get$Reserved",
@@ -175,8 +177,8 @@ var CapacityViolation = exports["default"] = /*#__PURE__*/function () {
           'category': this.getCategory()
         } : {}), typeof this.getMeter() !== 'undefined' && this.getMeter() !== null ? {
           'meter': this.getMeter()
-        } : {}), typeof this.getInsufficientQuantity() !== 'undefined' && this.getInsufficientQuantity() !== null ? {
-          'insufficientQuantity': this.getInsufficientQuantity()
+        } : {}), typeof this.getShortfall() !== 'undefined' && this.getShortfall() !== null ? {
+          'shortfall': this.getShortfall()
         } : {}), {}, {
           '$reserved': this.get$Reserved(),
           '$objectType': this.get$ObjectType(),
@@ -189,8 +191,8 @@ var CapacityViolation = exports["default"] = /*#__PURE__*/function () {
         'category': this.getCategory()
       } : {}), typeof this.getMeter() !== 'undefined' && this.getMeter() !== null ? {
         'meter': this.getMeter()
-      } : {}), typeof this.getInsufficientQuantity() !== 'undefined' && this.getInsufficientQuantity() !== null ? {
-        'insufficientQuantity': this.getInsufficientQuantity()
+      } : {}), typeof this.getShortfall() !== 'undefined' && this.getShortfall() !== null ? {
+        'shortfall': this.getShortfall()
       } : {}), {}, {
         '$reserved': this.get$Reserved(),
         '$objectType': this.get$ObjectType(),
@@ -247,9 +249,9 @@ var CapacityViolation = exports["default"] = /*#__PURE__*/function () {
           return new _ValidationError["default"]("meter", "undefined or null");
         }
       }
-      if (property === "insufficientQuantity") {
-        if (typeof this.insufficientQuantity === 'undefined' || this.insufficientQuantity === null) {
-          return new _ValidationError["default"]("insufficientQuantity", "undefined or null");
+      if (property === "shortfall") {
+        if (typeof this.shortfall === 'undefined' || this.shortfall === null) {
+          return new _ValidationError["default"]("shortfall", "undefined or null");
         }
       }
       if (property === "$reserved") {
@@ -271,22 +273,23 @@ var CapacityViolation = exports["default"] = /*#__PURE__*/function () {
     }
   }], [{
     key: "constructFromObject",
-    value: function constructFromObject(data, obj) {
+    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 CapacityViolation();
         if (data.hasOwnProperty('type') && data.type !== null && data.type !== undefined) {
-          obj.setType(_LicenseTypeEnum["default"].constructFromObject(data['type']));
+          obj.setType(_LicenseType["default"].constructFromObject(data['type']));
         }
         if (data.hasOwnProperty('category') && data.category !== null && data.category !== undefined) {
-          obj.setCategory(_LicenseCategoryEnum["default"].constructFromObject(data['category']));
+          obj.setCategory(_LicenseCategory["default"].constructFromObject(data['category']));
         }
         if (data.hasOwnProperty('meter') && data.meter !== null && data.meter !== undefined) {
-          obj.setMeter(_MeterEnum["default"].constructFromObject(data['meter']));
+          obj.setMeter(_Meter["default"].constructFromObject(data['meter']));
         }
-        if (data.hasOwnProperty('insufficientQuantity') && data.insufficientQuantity !== null && data.insufficientQuantity !== undefined) {
-          obj.setInsufficientQuantity(data['insufficientQuantity']);
+        if (data.hasOwnProperty('shortfall') && data.shortfall !== null && data.shortfall !== undefined) {
+          obj.setShortfall(data['shortfall']);
         }
         if (data.hasOwnProperty('$reserved')) {
           obj.$reserved = data['$reserved'];
@@ -300,7 +303,11 @@ var CapacityViolation = exports["default"] = /*#__PURE__*/function () {
         if (!callFromChild) {
           obj.$unknownFields = _objectSpread({}, data.$unknownFields);
           for (var property in data) {
-            if (!Object.keys(obj).includes(property) && !(property[0] === "$" && property.endsWith("ItemDiscriminator"))) {
+            // 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];
             }
           }
@@ -308,6 +315,19 @@ var CapacityViolation = exports["default"] = /*#__PURE__*/function () {
       }
       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();
+      });
+    }
   }]);
 }();
 /**
@@ -328,6 +348,18 @@ function _toJsonMapType(obj, forMutation) {
   }
   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;
+}
 CapacityViolation.prototype.type = undefined;
 
 /**
@@ -341,10 +373,10 @@ CapacityViolation.prototype.category = undefined;
 CapacityViolation.prototype.meter = undefined;
 
 /**
- * Indicates the insufficient quantity of a license.License of given quantity should be applied for a cluster to function properly
+ * Indicates the insufficient quantity of a license. License of given quantity should be applied for a cluster to function properly
  * @memberof CapacityViolation
  */
-CapacityViolation.prototype.insufficientQuantity = undefined;
+CapacityViolation.prototype.shortfall = undefined;
 CapacityViolation.prototype.$reserved = undefined;
 CapacityViolation.prototype.$objectType = undefined;
 CapacityViolation.prototype.$unknownFields = undefined;

package/dist/es/models/licensing/v4/config/ClusterLicenseKeyMapping.d.ts

@@ -0,0 +1,30 @@
+/**
+ * The ClusterLicenseKeyMapping model module.
+ * @module Ntnx/ClusterLicenseKeyMapping
+ * @version 4.1.1
+ * @class ClusterLicenseKeyMapping
+ * @extends LicenseKeyMapping
+ */
+export default class ClusterLicenseKeyMapping extends LicenseKeyMapping {
+    /**
+     * Returns Attribute for cluster UUID.
+     * @return {string}
+     */
+    getClusterExtId(): string;
+    /**
+     * Sets Attribute for cluster UUID.
+     * @param {string} clusterExtId Attribute for cluster UUID.
+     */
+    setClusterExtId(clusterExtId: string): void;
+    clusterExtId: string;
+    toJson(forMutation: any): {
+        $reserved: any;
+        $objectType: string;
+        $unknownFields: any;
+        quantityUsed?: number;
+        key?: string;
+        clusterExtId?: string;
+    };
+    #private;
+}
+import LicenseKeyMapping from "./LicenseKeyMapping";