@nutanix-scratch/dataprotection-js-client 4.0.1-alpha.4

package/dist/lib/Paginable.d.ts

@@ -0,0 +1,95 @@
+/**
+* A model that represents a paginable response from a list endpoint.
+* @module Paginable
+* @version 4.0.1-alpha-4
+*/
+export default class Paginable {
+    /**
+    * Constructs a <code>Paginable</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} metadata The plain Javascript object bearing properties of interest.
+    * @param {module:Paginable} obj Optional instance to populate.
+    * @return {module:Paginable} The populated <code>Paginable</code> instance.
+    */
+    static constructFromObject(metadata: any, obj: any): any;
+    /**
+    * 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(): Promise<any>;
+    /**
+    * 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(): Promise<any>;
+    /**
+    * 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(): Promise<any>;
+    /**
+    * 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(): Promise<any>;
+    /**
+    * Get the current page number
+    * @return {Number} the current page number, starts at 0
+    */
+    currentPage(): number;
+    /**
+    * Get the total number of pages
+    * @return {Number} the total number of pages available
+    */
+    countPages(): number;
+    /**
+    * Check if current page is first page
+    * @return {Boolean} True if current page is 0, false otherwise
+    */
+    isFirstPage(): boolean;
+    /**
+    * Check if current page is last page
+    * @return {Boolean} True if current page is countPages()-1, false otherwise
+    */
+    isLastPage(): boolean;
+    populatePaginationMetadata(apiClient: any, page: any, resultsPerPage: any): void;
+    apiClient: ApiClient;
+    page: number;
+    resultsPerPage: number;
+    _getLink(path: any): Promise<any>;
+    /**
+    * The link to first page, if any
+    * @type {String}
+    * @memberOf Paginable
+    */
+    linkFirst: string;
+    /**
+    * The link to previous page, if any
+    * @type {String}
+    * @memberOf Paginable
+    */
+    linkPrev: string;
+    /**
+    * The link to next page, if any
+    * @type {String}
+    * @memberOf Paginable
+    */
+    linkNext: string;
+    /**
+    * The link to last page, if any
+    * @type {String}
+    * @memberOf Paginable
+    */
+    linkLast: string;
+    /**
+    * Number of total results available
+    * @type {Number}
+    * @memberOf Paginable
+    */
+    resultsTotal: number;
+}
+import { ApiClient } from "./ApiClient";

package/dist/lib/Paginable.js

@@ -0,0 +1,289 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = require("./ApiClient");
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, 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 normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); } /*
+                                                                                                                                                                                                                                                                                                                                                                                               * Nutanix Dataprotection Versioned APIs
+                                                                                                                                                                                                                                                                                                                                                                                               *
+                                                                                                                                                                                                                                                                                                                                                                                               * OpenAPI spec version: 4.0.1-alpha-4
+                                                                                                                                                                                                                                                                                                                                                                                               *
+                                                                                                                                                                                                                                                                                                                                                                                               * NOTE: This class is auto generated by the Open API Dev Platform.
+                                                                                                                                                                                                                                                                                                                                                                                               *
+                                                                                                                                                                                                                                                                                                                                                                                               * Open API Dev Platform Codegen version: 16.8.0.6343-RELEASE
+                                                                                                                                                                                                                                                                                                                                                                                               *
+                                                                                                                                                                                                                                                                                                                                                                                               * Do not edit the class manually.
+                                                                                                                                                                                                                                                                                                                                                                                               *
+                                                                                                                                                                                                                                                                                                                                                                                               */
+/**
+* A model that represents a paginable response from a list endpoint.
+* @module Paginable
+* @version 4.0.1-alpha-4
+*/
+var Paginable = /*#__PURE__*/function () {
+  /**
+  * Constructs a new <code>Paginable</code>.
+  * @alias module:Paginable
+  * @class
+  */
+  function Paginable() {
+    _classCallCheck(this, Paginable);
+  }
+
+  /**
+  * Constructs a <code>Paginable</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} metadata The plain Javascript object bearing properties of interest.
+  * @param {module:Paginable} obj Optional instance to populate.
+  * @return {module:Paginable} The populated <code>Paginable</code> instance.
+  */
+  _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');
+      }
+      if (this.linkFirst === null) {
+        return Promise.reject('No link to first page provided in previous API response');
+      }
+      return this._getLink(this.linkFirst);
+    }
+
+    /**
+    * 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 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);
+    }
+
+    /**
+    * 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 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;
+    }
+
+    /**
+    * 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);
+    }
+
+    /**
+    * 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;
+    }
+
+    /**
+    * 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;
+    }
+  }, {
+    key: "populatePaginationMetadata",
+    value: function populatePaginationMetadata(apiClient, page, resultsPerPage) {
+      this.apiClient = apiClient;
+      this.page = page;
+      this.resultsPerPage = resultsPerPage;
+    }
+  }, {
+    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);
+    }
+  }], [{
+    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 Paginable;
+}();
+/**
+* The link to first page, if any
+* @type {String}
+* @memberOf Paginable
+*/
+exports["default"] = Paginable;
+Paginable.prototype.linkFirst = null;
+
+/**
+* The link to previous page, if any
+* @type {String}
+* @memberOf Paginable
+*/
+Paginable.prototype.linkPrev = null;
+
+/**
+* The link to next page, if any
+* @type {String}
+* @memberOf Paginable
+*/
+Paginable.prototype.linkNext = null;
+
+/**
+* The link to last page, if any
+* @type {String}
+* @memberOf Paginable
+*/
+Paginable.prototype.linkLast = null;
+
+/**
+* The ApiClient instance to use for further query
+* @type {ApiClient}
+* @memberOf Paginable
+*/
+Paginable.prototype.apiClient = null;
+
+/**
+* Current page number
+* @type {Number}
+* @memberOf Paginable
+*/
+Paginable.prototype.page = null;
+
+/**
+* Number of results per page
+* @type {Number}
+* @memberOf Paginable
+*/
+Paginable.prototype.resultsPerPage = null;
+
+/**
+* Number of total results available
+* @type {Number}
+* @memberOf Paginable
+*/
+Paginable.prototype.resultsTotal = null;

package/dist/lib/apis/consistencygroup-endpoints.d.ts

@@ -0,0 +1,98 @@
+/**
+ * ConsistencyGroup service.
+ * @version 4.0.1-alpha-4
+ * @class ConsistencyGroupApi
+ */
+export class ConsistencyGroupApi {
+    /**
+    * 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 ConsistencyGroupApi.
+     * @alias module:api/ConsistencyGroupApi
+     * @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.
+     * @param {ConsistencyGroup} body specification
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ConsistencyGroupApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ConsistencyGroupApiResponse } and HTTP response
+     */
+    createConsistencyGroup(body: ConsistencyGroup, ...args: any): Promise<ConsistencyGroupApiResponse>;
+    /**
+     * Delete a Consistency group.
+     * Delete the Consistency group for the provided {extId}.
+     * @param { String } extId The external identifier that can be 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
+     */
+    deleteConsistencyGroup(extId: string, ...args: any): Promise<DeleteConsistencyGroupApiResponse>;
+    /**
+     * Get a Consistency group.
+     * Query the Consistency group for the provided {extId}.
+     * @param { String } extId The external identifier that can be used to retrieve the Consistency group.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ConsistencyGroupApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ConsistencyGroupApiResponse } and HTTP response
+     */
+    getConsistencyGroup(extId: string, ...args: any): Promise<ConsistencyGroupApiResponse>;
+    /**
+     * List Consistency groups.
+     * List of Consistency groups.
+     * @param {Object} opts Optional parameters defined for the operation
+     * @param { Array } opts.vmList List of VM external identifiers. This endpoint will return the list of Consistency groups that are part of the provided VM external identifiers list.
+     * @param { Array } opts.volumeGroupList List of volume group external identifiers. This endpoint will return the list of Consistency groups that are part of the provided volume group external identifiers list.
+     * @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.$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>
+     * - extId<br>
+     * - members/entityId<br>
+     * - members/extId<br>
+     * - name<br>
+     * - ownerExtId
+     * @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>
+     * The orderby can be applied to the following fields:<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.
+- extId
+- name
+- ownerExtId
+
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ConsistencyGroupListApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ConsistencyGroupListApiResponse } and HTTP response
+     */
+    getConsistencyGroups(opts: {
+        vmList: any[];
+        volumeGroupList: any[];
+        $page: number;
+        $limit: number;
+        $filter: string;
+        $orderby: string;
+        $select: string;
+    }, ...args: any): Promise<ConsistencyGroupListApiResponse>;
+    /**
+     * Update a Consistency group.
+     * Update details of the Consistency group for the provided {extId}.
+     * @param {ConsistencyGroup} body specification
+     * @param { String } extId The external identifier that can be used to retrieve the Consistency group.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ConsistencyGroupApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ConsistencyGroupApiResponse } and HTTP response
+     */
+    updateConsistencyGroup(extId: string, body: ConsistencyGroup, ...args: any): Promise<ConsistencyGroupApiResponse>;
+    #private;
+}
+import ConsistencyGroup from "../models/dataprotection/v4/config/ConsistencyGroup";
+import ConsistencyGroupApiResponse from "../models/dataprotection/v4/config/ConsistencyGroupApiResponse";
+import DeleteConsistencyGroupApiResponse from "../models/dataprotection/v4/config/DeleteConsistencyGroupApiResponse";
+import ConsistencyGroupListApiResponse from "../models/dataprotection/v4/config/ConsistencyGroupListApiResponse";
+import { ApiClient } from "../ApiClient";