@nutanix-scratch/security-js-client 4.0.1-beta.1 → 4.1.1

package/dist/es/models/security/v4/config/KeyManagementServer.js

@@ -0,0 +1,320 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+var _TenantAwareModel = _interopRequireDefault(require("../../../common/v1/config/TenantAwareModel"));
+var _ExternalizableAbstractModel = _interopRequireDefault(require("../../../common/v1/response/ExternalizableAbstractModel"));
+var _AzureAccessInformation = _interopRequireDefault(require("./AzureAccessInformation"));
+var _KmipAccessInformation = _interopRequireDefault(require("./KmipAccessInformation"));
+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.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 KeyManagementServer model module.
+ * @module Ntnx/KeyManagementServer
+ * @version 4.1.1
+ * @class KeyManagementServer
+ * @extends ExternalizableAbstractModel
+ */
+var _KeyManagementServer_brand = /*#__PURE__*/new WeakSet();
+class KeyManagementServer extends _ExternalizableAbstractModel.default {
+  /**
+   * Constructs a new <code>KeyManagementServer</code>.
+   * Key Management Server.
+   * @alias module:Ntnx/KeyManagementServer
+   * @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, _KeyManagementServer_brand);
+    this.$objectType = "security.v4.config.KeyManagementServer";
+    /** @type {object<string, any>} */
+    this.$reserved = {
+      '$fv': "v4.r1"
+    };
+    /** @type {object<string, any>} */
+    this.$unknownFields = {};
+  }
+
+  /**
+   * Constructs a <code>KeyManagementServer</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/KeyManagementServer} obj Optional instance to populate.
+   * @param callFromChild {Boolean} Flag to recognise calling instance
+   * @return {module:Ntnx/KeyManagementServer} The populated <code>KeyManagementServer</code> instance.
+   */
+  static constructFromObject(data, obj = null, callFromChild = false) {
+    let items, item, i, itemArr, discriminator;
+    if (data) {
+      obj = obj || new KeyManagementServer();
+      _ExternalizableAbstractModel.default.constructFromObject(data, obj, true);
+      if (data.hasOwnProperty('name') && data.name !== null && data.name !== undefined) {
+        obj.setName(data['name']);
+      }
+      if (data.hasOwnProperty('accessInformation') && data.accessInformation !== null && data.accessInformation !== undefined) {
+        if (data['accessInformation'].hasOwnProperty('$objectType')) {
+          discriminator = data['accessInformation']['$objectType'];
+        } else {
+          discriminator = typeof data['accessInformation'];
+        }
+        switch (discriminator) {
+          case 'security.v4.config.AzureAccessInformation':
+            obj.setAccessInformation(_AzureAccessInformation.default.constructFromObject(data['accessInformation'], undefined));
+            break;
+          case 'security.v4.config.KmipAccessInformation':
+            obj.setAccessInformation(_KmipAccessInformation.default.constructFromObject(data['accessInformation'], undefined));
+            break;
+          default:
+            throw "Unknown datatype " + discriminator + " in data";
+        }
+      }
+      if (data.hasOwnProperty('creationTimestamp') && data.creationTimestamp !== null && data.creationTimestamp !== undefined) {
+        obj.setCreationTimestamp(data['creationTimestamp']);
+      }
+      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 Name of the key management server (KMS).
+   * @return {string}
+   */
+  getName() {
+    return this.name;
+  }
+
+  /**
+   * Sets Name of the key management server (KMS).
+   * @param {string} name Name of the key management server (KMS).
+   */
+  setName(name) {
+    this.name = name;
+  }
+
+  /**
+   * Returns KMS access information.
+   * @return {AzureAccessInformation | KmipAccessInformation}
+   */
+  getAccessInformation() {
+    return this.accessInformation;
+  }
+
+  /**
+   * Sets KMS access information.
+   * @param {AzureAccessInformation | KmipAccessInformation} accessInformation KMS access information.
+   */
+  setAccessInformation(accessInformation) {
+    this.accessInformation = accessInformation;
+  }
+
+  /**
+   * Returns Timestamp of KMS Creation.
+   * @return {Date}
+   */
+  getCreationTimestamp() {
+    return this.creationTimestamp;
+  }
+
+  /**
+   * Sets Timestamp of KMS Creation.
+   * @param {Date} creationTimestamp Timestamp of KMS Creation.
+   */
+  setCreationTimestamp(creationTimestamp) {
+    this.creationTimestamp = creationTimestamp;
+  }
+  toJson(forMutation) {
+    if (forMutation === false) {
+      return {
+        ...(typeof this.getName() !== 'undefined' && this.getName() !== null ? {
+          'name': this.getName()
+        } : {}),
+        ...(typeof this.getAccessInformation() !== 'undefined' && this.getAccessInformation() !== null ? {
+          'accessInformation': typeof this.getAccessInformation().toJson !== "undefined" ? this.getAccessInformation().toJson(false) : Array.isArray(this.getAccessInformation()) ? this.getAccessInformation().map(item => typeof item.toJson !== "undefined" ? item.toJson(false) : item) : _assertClassBrand(_KeyManagementServer_brand, this, _toJsonMapType).call(this, this.getAccessInformation(), false)
+        } : {}),
+        ...(typeof this.getCreationTimestamp() !== 'undefined' && this.getCreationTimestamp() !== null ? {
+          'creationTimestamp': _assertClassBrand(_KeyManagementServer_brand, this, _handleDateType).call(this, this.getCreationTimestamp(), true)
+        } : {}),
+        ...(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.getName() !== 'undefined' && this.getName() !== null ? {
+        'name': this.getName()
+      } : {}),
+      ...(typeof this.getAccessInformation() !== 'undefined' && this.getAccessInformation() !== null ? {
+        'accessInformation': typeof this.getAccessInformation().toJson !== "undefined" ? this.getAccessInformation().toJson() : Array.isArray(this.getAccessInformation()) ? this.getAccessInformation().map(item => typeof item.toJson !== "undefined" ? item.toJson() : item) : _assertClassBrand(_KeyManagementServer_brand, this, _toJsonMapType).call(this, this.getAccessInformation())
+      } : {}),
+      '$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 === "name") {
+      if (typeof this.name === 'undefined' || this.name === null) {
+        return new _ValidationError.default("name", "undefined or null");
+      }
+      if (!_ValidationUtils.default.validateMaxLength(this.name, 256)) {
+        return new _ValidationError.default("name", "does not satisfy required maxLength constraint: 256");
+      }
+    }
+    if (property === "accessInformation") {
+      if (typeof this.accessInformation === 'undefined' || this.accessInformation === null) {
+        return new _ValidationError.default("accessInformation", "undefined or null");
+      }
+    }
+    if (property === "creationTimestamp") {
+      if (typeof this.creationTimestamp === 'undefined' || this.creationTimestamp === null) {
+        return new _ValidationError.default("creationTimestamp", "undefined or null");
+      }
+    }
+    return new _ValidationError.default(property, "no such property exists");
+  }
+}
+
+/**
+ * Name of the key management server (KMS).
+ * @memberof KeyManagementServer
+ */
+exports.default = KeyManagementServer;
+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;
+}
+KeyManagementServer.prototype.name = undefined;
+
+/**
+ * KMS access information.
+ * @memberof KeyManagementServer
+ */
+KeyManagementServer.prototype.accessInformation = undefined;
+
+/**
+ * Timestamp of KMS Creation.
+ * @memberof KeyManagementServer
+ */
+KeyManagementServer.prototype.creationTimestamp = undefined;
+
+/**
+  * A globally unique identifier of an instance that is suitable for external consumption. 
+  * @memberof KeyManagementServer
+  */
+_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 KeyManagementServer
+  */
+_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 KeyManagementServer
+  */
+_TenantAwareModel.default.prototype.tenantId = undefined;
+// Implement OneOfsecurity.v4.config.GetKeyManagementServerApiResponsedata interface:

package/dist/es/models/security/v4/config/KmipAccessInformation.d.ts

@@ -0,0 +1,118 @@
+/**
+ * The KmipAccessInformation model module.
+ * @module Ntnx/KmipAccessInformation
+ * @version 4.1.1
+ * @class KmipAccessInformation
+ *
+ * @param { string } certPem Cert PEM File.
+ *
+ * @param { string } privateKey Private Key used by the External Key Manager.
+ *
+ * @param { string } caName Name of the Certificate Authority.
+ *
+ * @param { string } caPem CA PEM file.
+ *
+ * @param { EndpointInfo[] } endpoints List of endpoints of the External Key Manager server.
+ */
+export default class KmipAccessInformation {
+    /**
+     * Constructs a <code>KmipAccessInformation</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/KmipAccessInformation} obj Optional instance to populate.
+     * @param callFromChild {Boolean} Flag to recognise calling instance
+     * @return {module:Ntnx/KmipAccessInformation} The populated <code>KmipAccessInformation</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;
+    /**
+     * Constructs a new <code>KmipAccessInformation</code>.
+     * Access info for KMIP based External Key Manager.
+     * @alias module:Ntnx/KmipAccessInformation
+     *
+     * @param { string } certPem Cert PEM File.
+     *
+     * @param { string } privateKey Private Key used by the External Key Manager.
+     *
+     * @param { string } caName Name of the Certificate Authority.
+     *
+     * @param { string } caPem CA PEM file.
+     *
+     * @param { EndpointInfo[] } endpoints List of endpoints of the External Key Manager server.
+    */
+    constructor(certPem: string, privateKey: string, caName: string, caPem: string, endpoints: EndpointInfo[]);
+    certPem: string;
+    privateKey: string;
+    caName: string;
+    caPem: string;
+    endpoints: EndpointInfo[];
+    $objectType: string;
+    /** @type {object<string, any>} */
+    $reserved: object;
+    /** @type {object<string, any>} */
+    $unknownFields: object;
+    /**
+     * Returns Cert PEM File.
+     * @return {string}
+     */
+    getCertPem(): string;
+    /**
+     * Sets Cert PEM File.
+     * @param {string} certPem Cert PEM File.
+     */
+    setCertPem(certPem: string): void;
+    /**
+     * Returns Private Key used by the External Key Manager.
+     * @return {string}
+     */
+    getPrivateKey(): string;
+    /**
+     * Sets Private Key used by the External Key Manager.
+     * @param {string} privateKey Private Key used by the External Key Manager.
+     */
+    setPrivateKey(privateKey: string): void;
+    /**
+     * Returns Name of the Certificate Authority.
+     * @return {string}
+     */
+    getCaName(): string;
+    /**
+     * Sets Name of the Certificate Authority.
+     * @param {string} caName Name of the Certificate Authority.
+     */
+    setCaName(caName: string): void;
+    /**
+     * Returns CA PEM file.
+     * @return {string}
+     */
+    getCaPem(): string;
+    /**
+     * Sets CA PEM file.
+     * @param {string} caPem CA PEM file.
+     */
+    setCaPem(caPem: string): void;
+    /**
+     * Returns List of endpoints of the External Key Manager server.
+     * @return {EndpointInfo[]}
+     */
+    getEndpoints(): EndpointInfo[];
+    /**
+     * Sets List of endpoints of the External Key Manager server.
+     * @param {EndpointInfo[]} endpoints List of endpoints of the External Key Manager server.
+     */
+    setEndpoints(endpoints: EndpointInfo[]): void;
+    get$Reserved(): any;
+    get$ObjectType(): string;
+    get$UnknownFields(): any;
+    toJson(forMutation: any): any;
+    validate(scope: any, properties: any, ...args: any[]): Promise<any>;
+    validateProperty(scope: any, property: any): ValidationError;
+    #private;
+}
+import EndpointInfo from "./EndpointInfo";
+import ValidationError from "../../../validation/ValidationError";