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

package/dist/es/apis/samlidentityproviders-endpoints.js

@@ -0,0 +1,334 @@
+"use strict";
+
+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); }
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SAMLIdentityProvidersApi = void 0;
+var _ApiClient = require("../ApiClient");
+var _GetSamlSpMetadataApiResponse = _interopRequireDefault(require("../models/iam/v4/authn/GetSamlSpMetadataApiResponse"));
+var _SamlIdentityProvider = _interopRequireDefault(require("../models/iam/v4/authn/SamlIdentityProvider"));
+var _UpdateSamlIdentityProviderApiResponse = _interopRequireDefault(require("../models/iam/v4/authn/UpdateSamlIdentityProviderApiResponse"));
+var _GetSamlIdentityProviderApiResponse = _interopRequireDefault(require("../models/iam/v4/authn/GetSamlIdentityProviderApiResponse"));
+var _CreateSamlIdentityProviderApiResponse = _interopRequireDefault(require("../models/iam/v4/authn/CreateSamlIdentityProviderApiResponse"));
+var _DeleteSamlIdentityProviderApiResponse = _interopRequireDefault(require("../models/iam/v4/authn/DeleteSamlIdentityProviderApiResponse"));
+var _ListSamlIdentityProvidersApiResponse = _interopRequireDefault(require("../models/iam/v4/authn/ListSamlIdentityProvidersApiResponse"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+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 _classPrivateFieldInitSpec(e, t, a) { _checkPrivateRedeclaration(e, t), t.set(e, a); }
+function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object"); }
+function _classPrivateFieldGet(s, a) { return s.get(_assertClassBrand(s, a)); }
+function _classPrivateFieldSet(s, a, r) { return s.set(_assertClassBrand(s, a), r), r; }
+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 IAM Versioned APIs
+ *
+ * OpenAPI spec version: 4.0.1
+ *
+ * NOTE: This class is auto generated by the Open API Dev Platform.
+ *
+ * Open API Dev Platform Codegen version: 16.9.0.8546-RELEASE
+ *
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * SAMLIdentityProviders service.
+ * @version 4.0.1
+ * @class SAMLIdentityProvidersApi
+ */
+var _headersToSkip = /*#__PURE__*/new WeakMap();
+var SAMLIdentityProvidersApi = exports.SAMLIdentityProvidersApi = /*#__PURE__*/function () {
+  /**
+   * Constructs a new SAMLIdentityProvidersApi. 
+   * @alias module:api/SAMLIdentityProvidersApi
+   * @class
+   * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+   * default to {@link module:ApiClient#instance} if unspecified.
+   */
+  function SAMLIdentityProvidersApi(apiClient) {
+    _classCallCheck(this, SAMLIdentityProvidersApi);
+    _classPrivateFieldInitSpec(this, _headersToSkip, void 0);
+    this.apiClient = apiClient || _ApiClient.ApiClient.instance;
+    _classPrivateFieldSet(_headersToSkip, this, new Set());
+    _classPrivateFieldGet(_headersToSkip, this).add('authorization');
+    _classPrivateFieldGet(_headersToSkip, this).add('cookie');
+    _classPrivateFieldGet(_headersToSkip, this).add('host');
+    _classPrivateFieldGet(_headersToSkip, this).add('user-agent');
+  }
+
+  /**
+   * Create SAML identity provider
+   * Create a SAML identity provider from the given request payload.
+   * @param { Partial<SamlIdentityProvider> } body specification
+   * @param {Object} args Additional Arguments
+   * @return {Promise<CreateSamlIdentityProviderApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateSamlIdentityProviderApiResponse } and HTTP response
+   */
+  return _createClass(SAMLIdentityProvidersApi, [{
+    key: "createSamlIdentityProvider",
+    value: function createSamlIdentityProvider(body) {
+      var _this = this;
+      var argMap = (arguments.length <= 1 ? 0 : arguments.length - 1) > 0 ? arguments.length <= 1 ? undefined : arguments[1] : {};
+      var postBody = null;
+      if (body instanceof _SamlIdentityProvider["default"] && typeof body.toJson === 'function') {
+        postBody = body.toJson();
+      } else {
+        postBody = body;
+      }
+      // verify the required parameter 'body' is set
+      if (typeof postBody === 'undefined' || postBody === null) {
+        throw new Error("Invalid body when calling createSamlIdentityProvider");
+      }
+      var pathParams = {};
+      var queryParams = {};
+      var headersToInclude = {};
+      Object.keys(argMap).forEach(function (header) {
+        if (!_classPrivateFieldGet(_headersToSkip, _this).has(header.toLowerCase())) {
+          headersToInclude[header] = argMap[header];
+        }
+      });
+      var headerParams = _objectSpread({}, headersToInclude);
+      var formParams = {};
+      _ApiClient.ApiClient.addEtagReferenceToHeader(body, headerParams);
+      var authNames = ['apiKeyAuthScheme', 'basicAuthScheme'];
+      var contentTypes = ['application/json'];
+      var accepts = ['application/json'];
+      var returnType = _CreateSamlIdentityProviderApiResponse["default"];
+      return this.apiClient.callApi('/api/iam/v4.0/authn/saml-identity-providers', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+    }
+
+    /**
+     * Delete SAML identity provider
+     * Deletes a SAML identity provider based on its external identifier.
+     * @param { String } extId External identifier of the SAML identity provider.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<DeleteSamlIdentityProviderApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link DeleteSamlIdentityProviderApiResponse } and HTTP response
+     */
+  }, {
+    key: "deleteSamlIdentityProviderById",
+    value: function deleteSamlIdentityProviderById(extId) {
+      var _this2 = this;
+      var argMap = (arguments.length <= 1 ? 0 : arguments.length - 1) > 0 ? arguments.length <= 1 ? undefined : arguments[1] : {};
+      var postBody = null;
+      // verify the required parameter 'extId' is set
+      if (typeof extId === 'undefined' || extId === null) {
+        throw new Error("Missing the required parameter 'extId' when calling deleteSamlIdentityProviderById");
+      }
+      var pathParams = {
+        'extId': extId
+      };
+      var queryParams = {};
+      var headersToInclude = {};
+      Object.keys(argMap).forEach(function (header) {
+        if (!_classPrivateFieldGet(_headersToSkip, _this2).has(header.toLowerCase())) {
+          headersToInclude[header] = argMap[header];
+        }
+      });
+      var headerParams = _objectSpread({}, headersToInclude);
+      var formParams = {};
+      var authNames = ['apiKeyAuthScheme', 'basicAuthScheme'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _DeleteSamlIdentityProviderApiResponse["default"];
+      return this.apiClient.callApi('/api/iam/v4.0/authn/saml-identity-providers/{extId}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+    }
+
+    /**
+     * Get SAML identity provider
+     * Fetches a SAML identity provider based on its external identifier.
+     * @param { String } extId External identifier of the SAML identity provider.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GetSamlIdentityProviderApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetSamlIdentityProviderApiResponse } and HTTP response
+     */
+  }, {
+    key: "getSamlIdentityProviderById",
+    value: function getSamlIdentityProviderById(extId) {
+      var _this3 = this;
+      var argMap = (arguments.length <= 1 ? 0 : arguments.length - 1) > 0 ? arguments.length <= 1 ? undefined : arguments[1] : {};
+      var postBody = null;
+      // verify the required parameter 'extId' is set
+      if (typeof extId === 'undefined' || extId === null) {
+        throw new Error("Missing the required parameter 'extId' when calling getSamlIdentityProviderById");
+      }
+      var pathParams = {
+        'extId': extId
+      };
+      var queryParams = {};
+      var headersToInclude = {};
+      Object.keys(argMap).forEach(function (header) {
+        if (!_classPrivateFieldGet(_headersToSkip, _this3).has(header.toLowerCase())) {
+          headersToInclude[header] = argMap[header];
+        }
+      });
+      var headerParams = _objectSpread({}, headersToInclude);
+      var formParams = {};
+      var authNames = ['apiKeyAuthScheme', 'basicAuthScheme'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _GetSamlIdentityProviderApiResponse["default"];
+      return this.apiClient.callApi('/api/iam/v4.0/authn/saml-identity-providers/{extId}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+    }
+
+    /**
+     * Get SP-Metadata for SAML identity provider
+     * Downloads SP-Metadata for SAML identity provider.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GetSamlSpMetadataApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetSamlSpMetadataApiResponse } and HTTP response
+     */
+  }, {
+    key: "getSamlSpMetadata",
+    value: function getSamlSpMetadata() {
+      var _this4 = this;
+      var argMap = arguments.length > 0 ? arguments.length <= 0 ? undefined : arguments[0] : {};
+      var postBody = null;
+      var pathParams = {};
+      var queryParams = {};
+      var headersToInclude = {};
+      Object.keys(argMap).forEach(function (header) {
+        if (!_classPrivateFieldGet(_headersToSkip, _this4).has(header.toLowerCase())) {
+          headersToInclude[header] = argMap[header];
+        }
+      });
+      var headerParams = _objectSpread({}, headersToInclude);
+      var formParams = {};
+      var authNames = ['apiKeyAuthScheme', 'basicAuthScheme'];
+      var contentTypes = [];
+      var accepts = ['text/xml', 'application/json'];
+      var returnType = _GetSamlSpMetadataApiResponse["default"];
+      return this.apiClient.callApi('/api/iam/v4.0/authn/saml-sp-metadata', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+    }
+
+    /**
+     * List SAML identity providers
+     * Lists all SAML identity providers configured in the system.
+     * @param {Object} opts Optional parameters defined for the operation
+     * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
+      * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
+      * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.<br>
+     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'.<br>
+     * The filter can be applied to the following fields:<br>
+     * - createdBy<br>
+     * - extId<br>
+     * - name
+     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order.<br>
+     * The orderby can be applied to the following fields:<br>
+     * - createdTime<br>
+     * - lastUpdatedTime<br>
+     * - name
+     * @param { String } opts.$select A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned.
+    - createdBy
+    - createdTime
+    - customAttributes
+    - emailAttribute
+    - entityIssuer
+    - extId
+    - groupsAttribute
+    - groupsDelim
+    - idpMetadata
+    - isSignedAuthnReqEnabled
+    - lastUpdatedTime
+    - links
+    - name
+    - tenantId
+    - usernameAttribute
+      * @param {Object} args Additional Arguments
+     * @return {Promise<ListSamlIdentityProvidersApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListSamlIdentityProvidersApiResponse } and HTTP response
+     */
+  }, {
+    key: "listSamlIdentityProviders",
+    value: function listSamlIdentityProviders(opts) {
+      var _this5 = this;
+      var argMap = (arguments.length <= 1 ? 0 : arguments.length - 1) > 0 ? arguments.length <= 1 ? undefined : arguments[1] : {};
+      opts = opts || {};
+      var postBody = null;
+      var pathParams = {};
+      var queryParams = _objectSpread(_objectSpread(_objectSpread(_objectSpread(_objectSpread({}, opts.hasOwnProperty('$page') ? {
+        '$page': opts['$page']
+      } : {}), opts.hasOwnProperty('$limit') ? {
+        '$limit': opts['$limit']
+      } : {}), opts.hasOwnProperty('$filter') ? {
+        '$filter': opts['$filter']
+      } : {}), opts.hasOwnProperty('$orderby') ? {
+        '$orderby': opts['$orderby']
+      } : {}), opts.hasOwnProperty('$select') ? {
+        '$select': opts['$select']
+      } : {});
+      var headersToInclude = {};
+      Object.keys(argMap).forEach(function (header) {
+        if (!_classPrivateFieldGet(_headersToSkip, _this5).has(header.toLowerCase())) {
+          headersToInclude[header] = argMap[header];
+        }
+      });
+      var headerParams = _objectSpread({}, headersToInclude);
+      var formParams = {};
+      var authNames = ['apiKeyAuthScheme', 'basicAuthScheme'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _ListSamlIdentityProvidersApiResponse["default"];
+      return this.apiClient.callApi('/api/iam/v4.0/authn/saml-identity-providers', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+    }
+
+    /**
+     * Update SAML identity provider
+     * Updates a SAML identity provider based on its external identifier.
+     * @param { Partial<SamlIdentityProvider> } body specification
+     * @param { String } extId External identifier of the SAML identity provider.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<UpdateSamlIdentityProviderApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link UpdateSamlIdentityProviderApiResponse } and HTTP response
+     */
+  }, {
+    key: "updateSamlIdentityProviderById",
+    value: function updateSamlIdentityProviderById(extId, body) {
+      var _this6 = this;
+      var argMap = (arguments.length <= 2 ? 0 : arguments.length - 2) > 0 ? arguments.length <= 2 ? undefined : arguments[2] : {};
+      var postBody = null;
+      if (body instanceof _SamlIdentityProvider["default"] && typeof body.toJson === 'function') {
+        postBody = body.toJson();
+      } else {
+        postBody = body;
+      }
+      // verify the required parameter 'extId' is set
+      if (typeof extId === 'undefined' || extId === null) {
+        throw new Error("Missing the required parameter 'extId' when calling updateSamlIdentityProviderById");
+      }
+      // verify the required parameter 'body' is set
+      if (typeof postBody === 'undefined' || postBody === null) {
+        throw new Error("Invalid body when calling updateSamlIdentityProviderById");
+      }
+      var pathParams = {
+        'extId': extId
+      };
+      var queryParams = {};
+      var headersToInclude = {};
+      Object.keys(argMap).forEach(function (header) {
+        if (!_classPrivateFieldGet(_headersToSkip, _this6).has(header.toLowerCase())) {
+          headersToInclude[header] = argMap[header];
+        }
+      });
+      var headerParams = _objectSpread({}, headersToInclude);
+      var formParams = {};
+      _ApiClient.ApiClient.addEtagReferenceToHeader(body, headerParams);
+      var authNames = ['apiKeyAuthScheme', 'basicAuthScheme'];
+      var contentTypes = ['application/json'];
+      var accepts = ['application/json'];
+      var returnType = _UpdateSamlIdentityProviderApiResponse["default"];
+      return this.apiClient.callApi('/api/iam/v4.0/authn/saml-identity-providers/{extId}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+    }
+  }], [{
+    key: "ApiClient",
+    get:
+    /**
+    * Make the default {@link ApiClient} class available for developers to be able to extend it and bring
+    * their own fetch methods into the SDK
+    */
+    function get() {
+      return _ApiClient.ApiClient;
+    }
+  }]);
+}();

package/dist/es/apis/{usergroup-endpoints.d.ts → usergroups-endpoints.d.ts}

@@ -1,17 +1,17 @@
 /**
- * UserGroup service.
- * @version 4.0.1-beta-1
- * @class UserGroupApi
+ * UserGroups service.
+ * @version 4.0.1
+ * @class UserGroupsApi
  */
-export class UserGroupApi {
+export class UserGroupsApi {
     /**
     * Make the default {@link ApiClient} class available for developers to be able to extend it and bring
     * their own fetch methods into the SDK
     */
     static get ApiClient(): typeof ApiClient;
     /**
-     * Constructs a new UserGroupApi.
-     * @alias module:api/UserGroupApi
+     * Constructs a new UserGroupsApi.
+     * @alias module:api/UserGroupsApi
      * @class
      * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
      * default to {@link module:ApiClient#instance} if unspecified.
@@ -20,45 +20,53 @@ export class UserGroupApi {
     apiClient: any;
     /**
      * Create user group
-     * Create a user group
-     * @param {UserGroup} body specification
+     * Creates a user group.
+     * @param { Partial<UserGroup> } body specification
      * @param {Object} args Additional Arguments
      * @return {Promise<CreateUserGroupApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateUserGroupApiResponse } and HTTP response
      */
-    createUserGroup(body: UserGroup, ...args: any): Promise<CreateUserGroupApiResponse>;
+    createUserGroup(body: Partial<UserGroup>, ...args: any): Promise<CreateUserGroupApiResponse>;
+    /**
+     * Delete user group
+     * Deletes a user group based on the provided external identifier.
+     * @param { String } extId External identifier of the user group.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<DeleteUserGroupApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link DeleteUserGroupApiResponse } and HTTP response
+     */
+    deleteUserGroupById(extId: string, ...args: any): Promise<DeleteUserGroupApiResponse>;
     /**
      * Get user group
-     * View a user group
-     * @param { String } extId External Identifier of the user group
+     * Displays a user group based on the provided external identifier.
+     * @param { String } extId External identifier of the user group.
      * @param {Object} args Additional Arguments
      * @return {Promise<GetUserGroupApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetUserGroupApiResponse } and HTTP response
      */
     getUserGroupById(extId: string, ...args: any): Promise<GetUserGroupApiResponse>;
     /**
-     * List user group(s)
-     * List all user group(s)
+     * List user groups
+     * Lists all user group(s).
      * @param {Object} opts Optional parameters defined for the operation
-     * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set.  Must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range will lead to no results being returned.
+     * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
 
-     * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided a default value of 50 records will be returned in the result set.
+     * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
 
-     * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the OData V4.01 URL conventions.<br>
-     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter result on cluster name karbon-ntnx1.0, filter '$filter=startswith(name, 'C')' would filter on cluster name starting with C.<br>
-     * The filter can be applied on the following fields:<br>
+     * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.<br>
+     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'.<br>
+     * The filter can be applied to the following fields:<br>
      * - createdBy<br>
      * - distinguishedName<br>
      * - extId<br>
      * - groupType<br>
      * - idpId<br>
      * - name
-     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in desc order.<br>
+     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order.<br>
      * The orderby can be applied to the following fields:<br>
      * - createdTime<br>
      * - distinguishedName<br>
      * - groupType<br>
      * - lastUpdatedTime<br>
      * - name
-     * @param { String } opts.$select A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the OData V4.01 URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e. *), then all properties on the matching resource will be returned.
+     * @param { String } opts.$select A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned.
 - createdBy
 - createdTime
 - distinguishedName
@@ -71,19 +79,20 @@ export class UserGroupApi {
 - tenantId
 
      * @param {Object} args Additional Arguments
-     * @return {Promise<ListUserGroupApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListUserGroupApiResponse } and HTTP response
+     * @return {Promise<ListUserGroupsApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListUserGroupsApiResponse } and HTTP response
      */
-    getUserGroupList(opts: {
+    listUserGroups(opts: {
         $page: number;
         $limit: number;
         $filter: string;
         $orderby: string;
         $select: string;
-    }, ...args: any): Promise<ListUserGroupApiResponse>;
+    }, ...args: any): Promise<ListUserGroupsApiResponse>;
     #private;
 }
 import UserGroup from "../models/iam/v4/authn/UserGroup";
 import CreateUserGroupApiResponse from "../models/iam/v4/authn/CreateUserGroupApiResponse";
+import DeleteUserGroupApiResponse from "../models/iam/v4/authn/DeleteUserGroupApiResponse";
 import GetUserGroupApiResponse from "../models/iam/v4/authn/GetUserGroupApiResponse";
-import ListUserGroupApiResponse from "../models/iam/v4/authn/ListUserGroupApiResponse";
+import ListUserGroupsApiResponse from "../models/iam/v4/authn/ListUserGroupsApiResponse";
 import { ApiClient } from "../ApiClient";