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

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

@@ -0,0 +1,106 @@
+"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.ClientsApi = void 0;
+var _ApiClient = require("../ApiClient");
+var _GetClientApiResponse = _interopRequireDefault(require("../models/iam/v4/authz/GetClientApiResponse"));
+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.
+ *
+ */
+/**
+ * Clients service.
+ * @version 4.0.1
+ * @class ClientsApi
+ */
+var _headersToSkip = /*#__PURE__*/new WeakMap();
+var ClientsApi = exports.ClientsApi = /*#__PURE__*/function () {
+  /**
+   * Constructs a new ClientsApi. 
+   * @alias module:api/ClientsApi
+   * @class
+   * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+   * default to {@link module:ApiClient#instance} if unspecified.
+   */
+  function ClientsApi(apiClient) {
+    _classCallCheck(this, ClientsApi);
+    _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');
+  }
+
+  /**
+   * Get client
+   * Fetches a registered client information.
+   * @param { String } extId External identifier of the client.
+   * @param {Object} args Additional Arguments
+   * @return {Promise<GetClientApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetClientApiResponse } and HTTP response
+   */
+  return _createClass(ClientsApi, [{
+    key: "getRegisteredClientById",
+    value: function getRegisteredClientById(extId) {
+      var _this = 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 getRegisteredClientById");
+      }
+      var pathParams = {
+        'extId': extId
+      };
+      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 = {};
+      var authNames = ['apiKeyAuthScheme', 'basicAuthScheme'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _GetClientApiResponse["default"];
+      return this.apiClient.callApi('/api/iam/v4.0/authz/clients/{extId}', 'GET', 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/{lib/apis/directoryservice-endpoints.d.ts → es/apis/directoryservices-endpoints.d.ts}

@@ -1,17 +1,17 @@
 /**
- * DirectoryService service.
- * @version 4.0.1-beta-1
- * @class DirectoryServiceApi
+ * DirectoryServices service.
+ * @version 4.0.1
+ * @class DirectoryServicesApi
  */
-export class DirectoryServiceApi {
+export class DirectoryServicesApi {
     /**
     * 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 DirectoryServiceApi.
-     * @alias module:api/DirectoryServiceApi
+     * Constructs a new DirectoryServicesApi.
+     * @alias module:api/DirectoryServicesApi
      * @class
      * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
      * default to {@link module:ApiClient#instance} if unspecified.
@@ -20,43 +20,59 @@ export class DirectoryServiceApi {
     apiClient: any;
     /**
      * Check directory service connection
-     * Check connection to the directory service
-     * @param {DirectoryServiceConnectionRequest} body specification
-     * @param { String } extId External identifier of the directory service
+     * Checks the connection to the directory service.
+     * @param { Required<Pick<DirectoryServiceConnectionRequest, 'username' | 'password'>> & Partial<DirectoryServiceConnectionRequest> } body specification
+     * @param { String } extId External identifier of the directory service.
      * @param {Object} args Additional Arguments
      * @return {Promise<ConnectionDirectoryServiceApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ConnectionDirectoryServiceApiResponse } and HTTP response
      */
-    connectionStatusDirectoryService(extId: string, body: DirectoryServiceConnectionRequest, ...args: any): Promise<ConnectionDirectoryServiceApiResponse>;
+    connectionStatusDirectoryService(extId: string, body: Required<Pick<DirectoryServiceConnectionRequest, 'username' | 'password'>> & Partial<DirectoryServiceConnectionRequest>, ...args: any): Promise<ConnectionDirectoryServiceApiResponse>;
     /**
      * Create directory service
-     * Create a directory service
-     * @param {DirectoryService} body specification
+     * Creates a directory service.
+     * @param { Partial<DirectoryService> } body specification
      * @param {Object} args Additional Arguments
      * @return {Promise<CreateDirectoryServiceApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateDirectoryServiceApiResponse } and HTTP response
      */
-    createDirectoryService(body: DirectoryService, ...args: any): Promise<CreateDirectoryServiceApiResponse>;
+    createDirectoryService(body: Partial<DirectoryService>, ...args: any): Promise<CreateDirectoryServiceApiResponse>;
     /**
-     * List directory service(s)
-     * List all directory service(s)
+     * Delete directory service
+     * Deletes a directory service based on the external identifier.
+     * @param { String } extId External identifier of the directory service.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<DeleteDirectoryServiceApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link DeleteDirectoryServiceApiResponse } and HTTP response
+     */
+    deleteDirectoryServiceById(extId: string, ...args: any): Promise<DeleteDirectoryServiceApiResponse>;
+    /**
+     * Get directory service
+     * Fetches a directory service based on the external identifier.
+     * @param { String } extId External identifier of the directory service.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GetDirectoryServiceApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetDirectoryServiceApiResponse } and HTTP response
+     */
+    getDirectoryServiceById(extId: string, ...args: any): Promise<GetDirectoryServiceApiResponse>;
+    /**
+     * List directory services
+     * Lists all directory service(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>
      * - domainName<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 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>
      * - domainName<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
 - directoryType
@@ -66,59 +82,50 @@ export class DirectoryServiceApi {
 - lastUpdatedTime
 - links
 - name
-- openLdapConfiguration/userConfiguration
-- openLdapConfiguration/userGroupConfiguration
+- openLdapConfiguration
 - secondaryUrls
-- serviceAccount/password
-- serviceAccount/username
+- serviceAccount
 - tenantId
 - url
 - whiteListedGroups
 
      * @param {Object} args Additional Arguments
-     * @return {Promise<ListDirectoryServiceApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListDirectoryServiceApiResponse } and HTTP response
+     * @return {Promise<ListDirectoryServicesApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListDirectoryServicesApiResponse } and HTTP response
      */
-    getDirectoryServiceList(opts: {
+    listDirectoryServices(opts: {
         $page: number;
         $limit: number;
         $filter: string;
         $orderby: string;
         $select: string;
-    }, ...args: any): Promise<ListDirectoryServiceApiResponse>;
-    /**
-     * Get directory service
-     * View a directory service
-     * @param { String } extId External identifier of the directory service
-     * @param {Object} args Additional Arguments
-     * @return {Promise<GetDirectoryServiceApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetDirectoryServiceApiResponse } and HTTP response
-     */
-    getDirectoryServicebyId(extId: string, ...args: any): Promise<GetDirectoryServiceApiResponse>;
+    }, ...args: any): Promise<ListDirectoryServicesApiResponse>;
     /**
      * Search user/group in directory service
-     * Search user or group in the directory service
-     * @param {DirectoryServiceSearchQuery} body specification
-     * @param { String } extId External identifier of the directory service
+     * Searches a user or group in the directory service through its external identifier.
+     * @param { Required<Pick<DirectoryServiceSearchQuery, 'query'>> & Partial<DirectoryServiceSearchQuery> } body specification
+     * @param { String } extId External identifier of the directory service.
      * @param {Object} args Additional Arguments
      * @return {Promise<SearchDirectoryServiceApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link SearchDirectoryServiceApiResponse } and HTTP response
      */
-    searchDirectoryService(extId: string, body: DirectoryServiceSearchQuery, ...args: any): Promise<SearchDirectoryServiceApiResponse>;
+    searchDirectoryService(extId: string, body: Required<Pick<DirectoryServiceSearchQuery, 'query'>> & Partial<DirectoryServiceSearchQuery>, ...args: any): Promise<SearchDirectoryServiceApiResponse>;
     /**
      * Update directory service
-     * Update a directory service
-     * @param {DirectoryService} body specification
-     * @param { String } extId External identifier of the directory service
+     * Updates a directory service based on the external identifier.
+     * @param { Partial<DirectoryService> } body specification
+     * @param { String } extId External identifier of the directory service.
      * @param {Object} args Additional Arguments
      * @return {Promise<UpdateDirectoryServiceApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link UpdateDirectoryServiceApiResponse } and HTTP response
      */
-    updateDirectoryService(extId: string, body: DirectoryService, ...args: any): Promise<UpdateDirectoryServiceApiResponse>;
+    updateDirectoryServiceById(extId: string, body: Partial<DirectoryService>, ...args: any): Promise<UpdateDirectoryServiceApiResponse>;
     #private;
 }
 import DirectoryServiceConnectionRequest from "../models/iam/v4/authn/DirectoryServiceConnectionRequest";
 import ConnectionDirectoryServiceApiResponse from "../models/iam/v4/authn/ConnectionDirectoryServiceApiResponse";
 import DirectoryService from "../models/iam/v4/authn/DirectoryService";
 import CreateDirectoryServiceApiResponse from "../models/iam/v4/authn/CreateDirectoryServiceApiResponse";
-import ListDirectoryServiceApiResponse from "../models/iam/v4/authn/ListDirectoryServiceApiResponse";
+import DeleteDirectoryServiceApiResponse from "../models/iam/v4/authn/DeleteDirectoryServiceApiResponse";
 import GetDirectoryServiceApiResponse from "../models/iam/v4/authn/GetDirectoryServiceApiResponse";
+import ListDirectoryServicesApiResponse from "../models/iam/v4/authn/ListDirectoryServicesApiResponse";
 import DirectoryServiceSearchQuery from "../models/iam/v4/authn/DirectoryServiceSearchQuery";
 import SearchDirectoryServiceApiResponse from "../models/iam/v4/authn/SearchDirectoryServiceApiResponse";
 import UpdateDirectoryServiceApiResponse from "../models/iam/v4/authn/UpdateDirectoryServiceApiResponse";