@nutanix-scratch/multidomain-js-client 4.2.1

package/dist/es/models/common/v1/response/ApiResponseMetadata.js

@@ -0,0 +1,419 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _Flag = _interopRequireDefault(require("../config/Flag"));
+var _KVPair = _interopRequireDefault(require("../config/KVPair"));
+var _Message = _interopRequireDefault(require("../config/Message"));
+var _ApiLink = _interopRequireDefault(require("./ApiLink"));
+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 Multidomain Versioned APIs
+ *
+ * OpenAPI spec version: 4.2.1
+ *
+ * NOTE: This class is auto generated by the Open API Dev Platform.
+ *
+ * Open API Dev Platform Codegen version: 17.5.0.10128-RELEASE
+ *
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * The ApiResponseMetadata model module.
+ * @module Ntnx/ApiResponseMetadata
+ * @version 4.2.1
+ * @class ApiResponseMetadata
+ */
+var _ApiResponseMetadata_brand = /*#__PURE__*/new WeakSet();
+class ApiResponseMetadata {
+  /**
+   * Constructs a new <code>ApiResponseMetadata</code>.
+   * The metadata associated with an API response. This value is always present and minimally contains the self-link for the API request that produced this response. It also contains pagination data for the paginated requests. 
+   * @alias module:Ntnx/ApiResponseMetadata
+  */
+  constructor() {
+    /*
+    * 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, _ApiResponseMetadata_brand);
+    this.$objectType = "common.v1.response.ApiResponseMetadata";
+    /** @type {object<string, any>} */
+    this.$reserved = {
+      '$fv': "v1.r0"
+    };
+    /** @type {object<string, any>} */
+    this.$unknownFields = {};
+  }
+
+  /**
+   * Constructs a <code>ApiResponseMetadata</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/ApiResponseMetadata} obj Optional instance to populate.
+   * @param callFromChild {Boolean} Flag to recognise calling instance
+   * @return {module:Ntnx/ApiResponseMetadata} The populated <code>ApiResponseMetadata</code> instance.
+   */
+  static constructFromObject(data, obj = null, callFromChild = false) {
+    let items, item, i, itemArr, discriminator;
+    if (data) {
+      obj = obj || new ApiResponseMetadata();
+      if (data.hasOwnProperty('flags') && data.flags !== null && data.flags !== undefined) {
+        itemArr = [];
+        items = data.flags;
+        for (i = 0; i < items.length; i++) {
+          item = _Flag.default.constructFromObject(items[i], undefined);
+          itemArr.push(item);
+        }
+        obj.setFlags(itemArr);
+      }
+      if (data.hasOwnProperty('links') && data.links !== null && data.links !== undefined) {
+        itemArr = [];
+        items = data.links;
+        for (i = 0; i < items.length; i++) {
+          item = _ApiLink.default.constructFromObject(items[i], undefined);
+          itemArr.push(item);
+        }
+        obj.setLinks(itemArr);
+      }
+      if (data.hasOwnProperty('totalAvailableResults') && data.totalAvailableResults !== null && data.totalAvailableResults !== undefined) {
+        obj.setTotalAvailableResults(data['totalAvailableResults']);
+      }
+      if (data.hasOwnProperty('messages') && data.messages !== null && data.messages !== undefined) {
+        itemArr = [];
+        items = data.messages;
+        for (i = 0; i < items.length; i++) {
+          item = _Message.default.constructFromObject(items[i], undefined);
+          itemArr.push(item);
+        }
+        obj.setMessages(itemArr);
+      }
+      if (data.hasOwnProperty('extraInfo') && data.extraInfo !== null && data.extraInfo !== undefined) {
+        itemArr = [];
+        items = data.extraInfo;
+        for (i = 0; i < items.length; i++) {
+          item = _KVPair.default.constructFromObject(items[i], undefined);
+          itemArr.push(item);
+        }
+        obj.setExtraInfo(itemArr);
+      }
+      if (data.hasOwnProperty('$reserved')) {
+        obj.$reserved = data['$reserved'];
+      }
+      if (data.hasOwnProperty('$objectType')) {
+        obj.$objectType = data['$objectType'];
+      }
+      if (data.hasOwnProperty('$unknownFields')) {
+        obj.$unknownFields = data['$unknownFields'];
+      }
+      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 An array of flags that may indicate the status of the response. For example, a flag with the name 'isPaginated' and value 'false', indicates that the response is not paginated. 
+   * @return {Flag[]}
+   */
+  getFlags() {
+    return this.flags;
+  }
+
+  /**
+   * Sets An array of flags that may indicate the status of the response. For example, a flag with the name 'isPaginated' and value 'false', indicates that the response is not paginated. 
+   * @param {Flag[]} flags An array of flags that may indicate the status of the response. For example, a flag with the name 'isPaginated' and value 'false', indicates that the response is not paginated. 
+   */
+  setFlags(flags) {
+    this.flags = flags;
+  }
+
+  /**
+   * Returns An array of HATEOAS style links for the response that may also include pagination links for list operations. 
+   * @return {ApiLink[]}
+   */
+  getLinks() {
+    return this.links;
+  }
+
+  /**
+   * Sets An array of HATEOAS style links for the response that may also include pagination links for list operations. 
+   * @param {ApiLink[]} links An array of HATEOAS style links for the response that may also include pagination links for list operations. 
+   */
+  setLinks(links) {
+    this.links = links;
+  }
+
+  /**
+   * Returns The total number of entities that are available on the server for this type. 
+   * @return {Number}
+   */
+  getTotalAvailableResults() {
+    return this.totalAvailableResults;
+  }
+
+  /**
+   * Sets The total number of entities that are available on the server for this type. 
+   * @param {Number} totalAvailableResults The total number of entities that are available on the server for this type. 
+   */
+  setTotalAvailableResults(totalAvailableResults) {
+    this.totalAvailableResults = totalAvailableResults;
+  }
+
+  /**
+   * Returns Information, Warning or Error messages that might provide additional contextual information related to the operation. 
+   * @return {Message[]}
+   */
+  getMessages() {
+    return this.messages;
+  }
+
+  /**
+   * Sets Information, Warning or Error messages that might provide additional contextual information related to the operation. 
+   * @param {Message[]} messages Information, Warning or Error messages that might provide additional contextual information related to the operation. 
+   */
+  setMessages(messages) {
+    this.messages = messages;
+  }
+
+  /**
+   * Returns An array of entity-specific metadata 
+   * @return {KVPair[]}
+   */
+  getExtraInfo() {
+    return this.extraInfo;
+  }
+
+  /**
+   * Sets An array of entity-specific metadata 
+   * @param {KVPair[]} extraInfo An array of entity-specific metadata 
+   */
+  setExtraInfo(extraInfo) {
+    this.extraInfo = extraInfo;
+  }
+  get$Reserved() {
+    return this.$reserved;
+  }
+  get$ObjectType() {
+    return this.$objectType;
+  }
+  get$UnknownFields() {
+    return this.$unknownFields;
+  }
+  toJson(forMutation) {
+    if (forMutation === false) {
+      return {
+        ...(typeof this.getFlags() !== 'undefined' && this.getFlags() !== null ? {
+          'flags': this.getFlags().map(item => item.toJson(false))
+        } : {}),
+        ...(typeof this.getLinks() !== 'undefined' && this.getLinks() !== null ? {
+          'links': this.getLinks().map(item => item.toJson(false))
+        } : {}),
+        ...(typeof this.getTotalAvailableResults() !== 'undefined' && this.getTotalAvailableResults() !== null ? {
+          'totalAvailableResults': this.getTotalAvailableResults()
+        } : {}),
+        ...(typeof this.getMessages() !== 'undefined' && this.getMessages() !== null ? {
+          'messages': this.getMessages().map(item => item.toJson(false))
+        } : {}),
+        ...(typeof this.getExtraInfo() !== 'undefined' && this.getExtraInfo() !== null ? {
+          'extraInfo': this.getExtraInfo().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.getFlags() !== 'undefined' && this.getFlags() !== null ? {
+        'flags': this.getFlags().map(item => item.toJson(false))
+      } : {}),
+      ...(typeof this.getLinks() !== 'undefined' && this.getLinks() !== null ? {
+        'links': this.getLinks().map(item => item.toJson(false))
+      } : {}),
+      ...(typeof this.getTotalAvailableResults() !== 'undefined' && this.getTotalAvailableResults() !== null ? {
+        'totalAvailableResults': this.getTotalAvailableResults()
+      } : {}),
+      ...(typeof this.getMessages() !== 'undefined' && this.getMessages() !== null ? {
+        'messages': this.getMessages().map(item => item.toJson(false))
+      } : {}),
+      ...(typeof this.getExtraInfo() !== 'undefined' && this.getExtraInfo() !== null ? {
+        'extraInfo': this.getExtraInfo().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 === "flags") {
+      if (typeof this.flags === 'undefined' || this.flags === null) {
+        return new _ValidationError.default("flags", "undefined or null");
+      }
+      if (!_ValidationUtils.default.validateMaxItems(this.flags, 20)) {
+        return new _ValidationError.default("flags", "does not satisfy required maxItems constraint: 20");
+      }
+    }
+    if (property === "links") {
+      if (typeof this.links === 'undefined' || this.links === null) {
+        return new _ValidationError.default("links", "undefined or null");
+      }
+      if (!_ValidationUtils.default.validateMaxItems(this.links, 20)) {
+        return new _ValidationError.default("links", "does not satisfy required maxItems constraint: 20");
+      }
+    }
+    if (property === "totalAvailableResults") {
+      if (typeof this.totalAvailableResults === 'undefined' || this.totalAvailableResults === null) {
+        return new _ValidationError.default("totalAvailableResults", "undefined or null");
+      }
+    }
+    if (property === "messages") {
+      if (typeof this.messages === 'undefined' || this.messages === null) {
+        return new _ValidationError.default("messages", "undefined or null");
+      }
+      if (!_ValidationUtils.default.validateMaxItems(this.messages, 20)) {
+        return new _ValidationError.default("messages", "does not satisfy required maxItems constraint: 20");
+      }
+    }
+    if (property === "extraInfo") {
+      if (typeof this.extraInfo === 'undefined' || this.extraInfo === null) {
+        return new _ValidationError.default("extraInfo", "undefined or null");
+      }
+      if (!_ValidationUtils.default.validateMaxItems(this.extraInfo, 20)) {
+        return new _ValidationError.default("extraInfo", "does not satisfy required maxItems constraint: 20");
+      }
+    }
+    if (property === "$reserved") {
+      if (typeof this.$reserved === 'undefined' || this.$reserved === null) {
+        return new _ValidationError.default("$reserved", "undefined or null");
+      }
+    }
+    if (property === "$objectType") {
+      if (typeof this.$objectType === 'undefined' || this.$objectType === null) {
+        return new _ValidationError.default("$objectType", "undefined or null");
+      }
+    }
+    if (property === "$unknownFields") {
+      if (typeof this.$unknownFields === 'undefined' || this.$unknownFields === null) {
+        return new _ValidationError.default("$unknownFields", "undefined or null");
+      }
+    }
+    return new _ValidationError.default(property, "no such property exists");
+  }
+}
+
+/**
+ * An array of flags that may indicate the status of the response. For example, a flag with the name 'isPaginated' and value 'false', indicates that the response is not paginated. 
+ * @memberof ApiResponseMetadata
+ */
+exports.default = ApiResponseMetadata;
+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;
+}
+ApiResponseMetadata.prototype.flags = undefined;
+
+/**
+ * An array of HATEOAS style links for the response that may also include pagination links for list operations. 
+ * @memberof ApiResponseMetadata
+ */
+ApiResponseMetadata.prototype.links = undefined;
+
+/**
+ * The total number of entities that are available on the server for this type. 
+ * @memberof ApiResponseMetadata
+ */
+ApiResponseMetadata.prototype.totalAvailableResults = undefined;
+
+/**
+ * Information, Warning or Error messages that might provide additional contextual information related to the operation. 
+ * @memberof ApiResponseMetadata
+ */
+ApiResponseMetadata.prototype.messages = undefined;
+
+/**
+ * An array of entity-specific metadata 
+ * @memberof ApiResponseMetadata
+ */
+ApiResponseMetadata.prototype.extraInfo = undefined;
+ApiResponseMetadata.prototype.$reserved = undefined;
+ApiResponseMetadata.prototype.$objectType = undefined;
+ApiResponseMetadata.prototype.$unknownFields = undefined;

package/dist/es/models/common/v1/response/ExternalizableAbstractModel.d.ts

@@ -0,0 +1,34 @@
+/**
+ * The ExternalizableAbstractModel model module.
+ * @module Ntnx/ExternalizableAbstractModel
+ * @version 4.2.1
+ * @class ExternalizableAbstractModel
+ * @extends TenantAwareModel
+ */
+export default class ExternalizableAbstractModel extends TenantAwareModel {
+    /**
+     * Returns A globally unique identifier of an instance that is suitable for external consumption.
+     * @return {string}
+     */
+    getExtId(): string;
+    /**
+     * Sets A globally unique identifier of an instance that is suitable for external consumption.
+     * @param {string} extId A globally unique identifier of an instance that is suitable for external consumption.
+     */
+    setExtId(extId: string): void;
+    extId: string;
+    /**
+     * Returns 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.
+     * @return {ApiLink[]}
+     */
+    getLinks(): ApiLink[];
+    /**
+     * Sets 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.
+     * @param {ApiLink[]} links 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.
+     */
+    setLinks(links: ApiLink[]): void;
+    links: ApiLink[];
+    #private;
+}
+import TenantAwareModel from "../config/TenantAwareModel";
+import ApiLink from "./ApiLink";