@nutanix-scratch/dataprotection-js-client 4.0.1 → 4.2.1

package/dist/es/Paginable.d.ts

@@ -1,7 +1,7 @@
 /**
 * A model that represents a paginable response from a list endpoint.
 * @module Paginable
-* @version 4.0.1
+* @version 4.2.1
 */
 export default class Paginable {
     /**

package/dist/es/Paginable.js

@@ -3,42 +3,33 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports["default"] = void 0;
+exports.default = void 0;
 var _ApiClient = require("./ApiClient");
-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 _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
-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 _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); } /*
+/*
  * Nutanix Data Protection APIs
  *
- * OpenAPI spec version: 4.0.1
+ * OpenAPI spec version: 4.2.1
  *
  * NOTE: This class is auto generated by the Open API Dev Platform.
  *
- * Open API Dev Platform Codegen version: 16.9.0.8546-RELEASE
+ * Open API Dev Platform Codegen version: 17.5.0.10128-RELEASE
  *
  * Do not edit the class manually.
  *
  */
+
 /**
 * A model that represents a paginable response from a list endpoint.
 * @module Paginable
-* @version 4.0.1
+* @version 4.2.1
 */
-var Paginable = exports["default"] = /*#__PURE__*/function () {
+class Paginable {
   /**
   * Constructs a new <code>Paginable</code>.
   * @alias module:Paginable
   * @class
   */
-  function Paginable() {
-    _classCallCheck(this, Paginable);
-  }
+  constructor() {}
 
   /**
   * Constructs a <code>Paginable</code> from a plain Javascript object, optionally creating a new instance.
@@ -47,194 +38,164 @@ var Paginable = exports["default"] = /*#__PURE__*/function () {
   * @param {module:Paginable} obj Optional instance to populate.
   * @return {module:Paginable} The populated <code>Paginable</code> instance.
   */
-  return _createClass(Paginable, [{
-    key: "getFirstPage",
-    value:
-    /**
-    * Get the first page of the set, if any
-    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
-    *                   or rejects with error message if any issue (link not available, ...)
-    */
-    function getFirstPage() {
-      if (this.isFirstPage()) {
-        return Promise.reject('Cannot navigate to first page : already on first page');
+  static constructFromObject(metadata, obj) {
+    if (metadata) {
+      obj = obj || new Paginable();
+      if (metadata.hasOwnProperty('links') && metadata['links'] !== null && metadata['links'] !== undefined) {
+        for (const link of metadata['links']) {
+          if (link.hasOwnProperty('rel') && link.hasOwnProperty('href')) {
+            switch (link['rel']) {
+              case 'first':
+                obj.linkFirst = link['href'];
+                break;
+              case 'prev':
+                obj.linkPrev = link['href'];
+                break;
+              case 'next':
+                obj.linkNext = link['href'];
+                break;
+              case 'last':
+                obj.linkLast = link['href'];
+                break;
+              default:
+                break;
+            }
+          }
+        }
       }
-      if (this.linkFirst === null) {
-        return Promise.reject('No link to first page provided in previous API response');
+      if (metadata.hasOwnProperty('totalAvailableResults')) {
+        obj.resultsTotal = metadata['totalAvailableResults'];
       }
-      return this._getLink(this.linkFirst);
     }
+    return obj;
+  }
 
-    /**
-    * Get the previous page of the set, if any
-    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
-    *                   or rejects with error message if any issue (link not available, ...)
-    */
-  }, {
-    key: "getPrevPage",
-    value: function getPrevPage() {
-      if (this.isFirstPage()) {
-        return Promise.reject('Cannot navigate to previous page : already on first page');
-      }
-      if (this.linkPrev === null) {
-        return Promise.reject('No link to previous page provided in previous API response');
-      }
-      return this._getLink(this.linkPrev);
+  /**
+  * Get the first page of the set, if any
+  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
+  *                   or rejects with error message if any issue (link not available, ...)
+  */
+  getFirstPage() {
+    if (this.isFirstPage()) {
+      return Promise.reject('Cannot navigate to first page : already on first page');
     }
-
-    /**
-    * Get the next page of the set, if any
-    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
-    *                   or rejects with error message if any issue (link not available, ...)
-    */
-  }, {
-    key: "getNextPage",
-    value: function getNextPage() {
-      if (this.isLastPage()) {
-        return Promise.reject('Cannot navigate to next page : already on last page');
-      }
-      if (this.linkNext === null) {
-        return Promise.reject('No link to next page provided in previous API response');
-      }
-      return this._getLink(this.linkNext);
+    if (this.linkFirst === null) {
+      return Promise.reject('No link to first page provided in previous API response');
     }
+    return this._getLink(this.linkFirst);
+  }
 
-    /**
-    * Get the last page of the set, if any
-    * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
-    *                   or rejects with error message if any issue (link not available, ...)
-    */
-  }, {
-    key: "getLastPage",
-    value: function getLastPage() {
-      if (this.isLastPage()) {
-        return Promise.reject('Cannot navigate to last page : already on last page');
-      }
-      if (this.linkLast === null) {
-        return Promise.reject('No link to last page provided in previous API response');
-      }
-      return this._getLink(this.linkLast);
+  /**
+  * Get the previous page of the set, if any
+  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
+  *                   or rejects with error message if any issue (link not available, ...)
+  */
+  getPrevPage() {
+    if (this.isFirstPage()) {
+      return Promise.reject('Cannot navigate to previous page : already on first page');
     }
-
-    /**
-    * Get the current page number
-    * @return {Number} the current page number, starts at 0
-    */
-  }, {
-    key: "currentPage",
-    value: function currentPage() {
-      if (this.page === null) {
-        return 0;
-      }
-      return this.page;
+    if (this.linkPrev === null) {
+      return Promise.reject('No link to previous page provided in previous API response');
     }
+    return this._getLink(this.linkPrev);
+  }
 
-    /**
-    * Get the total number of pages
-    * @return {Number} the total number of pages available
-    */
-  }, {
-    key: "countPages",
-    value: function countPages() {
-      if (this.resultsPerPage === null || this.resultsTotal === null || this.resultsPerPage === 0) {
-        return 1;
-      }
-      return Math.ceil(this.resultsTotal / this.resultsPerPage);
+  /**
+  * Get the next page of the set, if any
+  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
+  *                   or rejects with error message if any issue (link not available, ...)
+  */
+  getNextPage() {
+    if (this.isLastPage()) {
+      return Promise.reject('Cannot navigate to next page : already on last page');
     }
-
-    /**
-    * Check if current page is first page
-    * @return {Boolean} True if current page is 0, false otherwise
-    */
-  }, {
-    key: "isFirstPage",
-    value: function isFirstPage() {
-      return this.currentPage() === 0;
+    if (this.linkNext === null) {
+      return Promise.reject('No link to next page provided in previous API response');
     }
+    return this._getLink(this.linkNext);
+  }
 
-    /**
-    * Check if current page is last page
-    * @return {Boolean} True if current page is countPages()-1, false otherwise
-    */
-  }, {
-    key: "isLastPage",
-    value: function isLastPage() {
-      return this.currentPage() === this.countPages() - 1;
+  /**
+  * Get the last page of the set, if any
+  * @return {Promise} a {@link https://www.promisejs.org/|Promise}, resolves with another Paginable
+  *                   or rejects with error message if any issue (link not available, ...)
+  */
+  getLastPage() {
+    if (this.isLastPage()) {
+      return Promise.reject('Cannot navigate to last page : already on last page');
     }
-  }, {
-    key: "populatePaginationMetadata",
-    value: function populatePaginationMetadata(apiClient, page, resultsPerPage) {
-      this.apiClient = apiClient;
-      this.page = page;
-      this.resultsPerPage = resultsPerPage;
+    if (this.linkLast === null) {
+      return Promise.reject('No link to last page provided in previous API response');
     }
-  }, {
-    key: "_getLink",
-    value: function _getLink(path) {
-      // If no ApiClient defined, instantiate default one
-      if (this.apiClient === null) {
-        this.apiClient = _ApiClient.ApiClient.instance;
-      }
-      var postBody = {};
-      var pathParams = {};
-      var queryParams = {};
-      var headerParams = {};
-      var formParams = {};
-      var authNames = [];
-      var contentTypes = [];
-      var accepts = ['application/json'];
-      var returnType = this.constructor;
-      return this.apiClient.callApi(path, 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+    return this._getLink(this.linkLast);
+  }
+
+  /**
+  * Get the current page number
+  * @return {Number} the current page number, starts at 0
+  */
+  currentPage() {
+    if (this.page === null) {
+      return 0;
     }
-  }], [{
-    key: "constructFromObject",
-    value: function constructFromObject(metadata, obj) {
-      if (metadata) {
-        obj = obj || new Paginable();
-        if (metadata.hasOwnProperty('links') && metadata['links'] !== null && metadata['links'] !== undefined) {
-          var _iterator = _createForOfIteratorHelper(metadata['links']),
-            _step;
-          try {
-            for (_iterator.s(); !(_step = _iterator.n()).done;) {
-              var link = _step.value;
-              if (link.hasOwnProperty('rel') && link.hasOwnProperty('href')) {
-                switch (link['rel']) {
-                  case 'first':
-                    obj.linkFirst = link['href'];
-                    break;
-                  case 'prev':
-                    obj.linkPrev = link['href'];
-                    break;
-                  case 'next':
-                    obj.linkNext = link['href'];
-                    break;
-                  case 'last':
-                    obj.linkLast = link['href'];
-                    break;
-                  default:
-                    break;
-                }
-              }
-            }
-          } catch (err) {
-            _iterator.e(err);
-          } finally {
-            _iterator.f();
-          }
-        }
-        if (metadata.hasOwnProperty('totalAvailableResults')) {
-          obj.resultsTotal = metadata['totalAvailableResults'];
-        }
-      }
-      return obj;
+    return this.page;
+  }
+
+  /**
+  * Get the total number of pages
+  * @return {Number} the total number of pages available
+  */
+  countPages() {
+    if (this.resultsPerPage === null || this.resultsTotal === null || this.resultsPerPage === 0) {
+      return 1;
     }
-  }]);
-}();
+    return Math.ceil(this.resultsTotal / this.resultsPerPage);
+  }
+
+  /**
+  * Check if current page is first page
+  * @return {Boolean} True if current page is 0, false otherwise
+  */
+  isFirstPage() {
+    return this.currentPage() === 0;
+  }
+
+  /**
+  * Check if current page is last page
+  * @return {Boolean} True if current page is countPages()-1, false otherwise
+  */
+  isLastPage() {
+    return this.currentPage() === this.countPages() - 1;
+  }
+  populatePaginationMetadata(apiClient, page, resultsPerPage) {
+    this.apiClient = apiClient;
+    this.page = page;
+    this.resultsPerPage = resultsPerPage;
+  }
+  _getLink(path) {
+    // If no ApiClient defined, instantiate default one
+    if (this.apiClient === null) {
+      this.apiClient = _ApiClient.ApiClient.instance;
+    }
+    const postBody = {};
+    const pathParams = {};
+    const queryParams = {};
+    const headerParams = {};
+    const formParams = {};
+    const authNames = [];
+    const contentTypes = [];
+    const accepts = ['application/json'];
+    const returnType = this.constructor;
+    return this.apiClient.callApi(path, 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+  }
+}
+
 /**
 * The link to first page, if any
 * @type {String}
 * @memberOf Paginable
 */
+exports.default = Paginable;
 Paginable.prototype.linkFirst = null;
 
 /**

package/dist/es/apis/consistencygroups-endpoints.d.ts

@@ -0,0 +1,84 @@
+/**
+ * ConsistencyGroups service.
+ * @version 4.2.1
+ * @class ConsistencyGroupsApi
+ */
+export class ConsistencyGroupsApi {
+    /**
+    * 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 ConsistencyGroupsApi.
+     * @alias module:api/ConsistencyGroupsApi
+     * @class
+     * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+     * default to {@link module:ApiClient#instance} if unspecified.
+     */
+    constructor(apiClient?: any);
+    apiClient: any;
+    /**
+     * Create a consistency group
+     * Create a new consistency group with provided specification.
+     * @param { Required<Pick<ConsistencyGroup, 'name' | 'members'>> & Partial<ConsistencyGroup> } body specification
+     * @param {Object} args Additional Arguments
+     * @return {Promise<CreateConsistencyGroupApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateConsistencyGroupApiResponse } and HTTP response
+     */
+    createConsistencyGroup(body: Required<Pick<ConsistencyGroup, 'name' | 'members'>> & Partial<ConsistencyGroup>, ...args: any): Promise<CreateConsistencyGroupApiResponse>;
+    /**
+     * Delete a consistency group
+     * Deletes a consistency group for the provided external identifier.
+     * @param { String } extId The external identifier used to retrieve the consistency group.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<DeleteConsistencyGroupApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link DeleteConsistencyGroupApiResponse } and HTTP response
+     */
+    deleteConsistencyGroupById(extId: string, ...args: any): Promise<DeleteConsistencyGroupApiResponse>;
+    /**
+     * Get details of a consistency group
+     * Fetches the details of the consistency group for the provided external identifier.
+     * @param { String } extId The external identifier used to retrieve the consistency group.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GetConsistencyGroupApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetConsistencyGroupApiResponse } and HTTP response
+     */
+    getConsistencyGroupById(extId: string, ...args: any): Promise<GetConsistencyGroupApiResponse>;
+    /**
+     * List consistency groups
+     * Lists the consistency groups defined on the system. List of consistency groups can be further filtered out using various filtering options.
+     * @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'.
+     * @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.
+     * @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.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ListConsistencyGroupsApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListConsistencyGroupsApiResponse } and HTTP response
+     */
+    listConsistencyGroups(opts: {
+        $page: number;
+        $limit: number;
+        $filter: string;
+        $orderby: string;
+        $select: string;
+    }, ...args: any): Promise<ListConsistencyGroupsApiResponse>;
+    /**
+     * Update a consistency group
+     * Updates the details of a consistency group for the provided external identifier.
+     * @param { Required<Pick<ConsistencyGroup, 'name' | 'members'>> & Partial<ConsistencyGroup> } body specification
+     * @param { String } extId The external identifier used to retrieve the consistency group.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<UpdateConsistencyGroupApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link UpdateConsistencyGroupApiResponse } and HTTP response
+     */
+    updateConsistencyGroupById(extId: string, body: Required<Pick<ConsistencyGroup, 'name' | 'members'>> & Partial<ConsistencyGroup>, ...args: any): Promise<UpdateConsistencyGroupApiResponse>;
+    #private;
+}
+import ConsistencyGroup from "../models/dataprotection/v4/config/ConsistencyGroup";
+import CreateConsistencyGroupApiResponse from "../models/dataprotection/v4/config/CreateConsistencyGroupApiResponse";
+import DeleteConsistencyGroupApiResponse from "../models/dataprotection/v4/config/DeleteConsistencyGroupApiResponse";
+import GetConsistencyGroupApiResponse from "../models/dataprotection/v4/config/GetConsistencyGroupApiResponse";
+import ListConsistencyGroupsApiResponse from "../models/dataprotection/v4/config/ListConsistencyGroupsApiResponse";
+import UpdateConsistencyGroupApiResponse from "../models/dataprotection/v4/config/UpdateConsistencyGroupApiResponse";
+import { ApiClient } from "../ApiClient";