@nutanix-scratch/aiops-js-client 4.0.2-alpha.1 → 4.0.2

package/dist/lib/Paginable.d.ts

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

package/dist/lib/Paginable.js

@@ -5,21 +5,32 @@ Object.defineProperty(exports, "__esModule", {
 });
 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); }
+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 AIOps APIs
+ *
+ * OpenAPI spec version: 4.0.2
+ *
+ * NOTE: This class is auto generated by the Open API Dev Platform.
+ *
+ * Open API Dev Platform Codegen version: 17.4.0.8851-RELEASE
+ *
+ * Do not edit the class manually.
+ *
+ */
 /**
 * A model that represents a paginable response from a list endpoint.
 * @module Paginable
-* @version 4.0.2-alpha-1
+* @version 4.0.2
 */
-var Paginable = /*#__PURE__*/function () {
+var Paginable = exports["default"] = /*#__PURE__*/function () {
   /**
   * Constructs a new <code>Paginable</code>.
   * @alias module:Paginable
@@ -36,7 +47,7 @@ var Paginable = /*#__PURE__*/function () {
   * @param {module:Paginable} obj Optional instance to populate.
   * @return {module:Paginable} The populated <code>Paginable</code> instance.
   */
-  _createClass(Paginable, [{
+  return _createClass(Paginable, [{
     key: "getFirstPage",
     value:
     /**
@@ -218,14 +229,12 @@ var Paginable = /*#__PURE__*/function () {
       return obj;
     }
   }]);
-  return Paginable;
 }();
 /**
 * The link to first page, if any
 * @type {String}
 * @memberOf Paginable
 */
-exports["default"] = Paginable;
 Paginable.prototype.linkFirst = null;
 
 /**

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

@@ -0,0 +1,181 @@
+/**
+ * Scenarios service.
+ * @version 4.0.2
+ * @class ScenariosApi
+ */
+export class ScenariosApi {
+    /**
+    * 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 ScenariosApi.
+     * @alias module:api/ScenariosApi
+     * @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 capacity planning scenario
+     * Creates a capacity planning scenario which can be used to analyse the future workload.
+     * @param { Partial<Scenario> } body specification
+     * @param {Object} args Additional Arguments
+     * @return {Promise<CreateScenarioApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateScenarioApiResponse } and HTTP response
+     */
+    createScenario(body: Partial<Scenario>, ...args: any): Promise<CreateScenarioApiResponse>;
+    /**
+     * Create a simulation
+     * Creates a simulation which can be used in the capacity scenario as a part of VM workload.
+     * @param { Partial<Simulation> } body specification
+     * @param {Object} args Additional Arguments
+     * @return {Promise<CreateSimulationApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateSimulationApiResponse } and HTTP response
+     */
+    createSimulation(body: Partial<Simulation>, ...args: any): Promise<CreateSimulationApiResponse>;
+    /**
+     * Delete a capacity planning scenario
+     * Deletes a capacity planning scenario using the provided UUID.
+     * @param { String } extId UUID of a capacity planning scenario.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<DeleteScenarioApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link DeleteScenarioApiResponse } and HTTP response
+     */
+    deleteScenarioById(extId: string, ...args: any): Promise<DeleteScenarioApiResponse>;
+    /**
+     * Delete a simulation
+     * Deletes a simulation identified by the provided UUID.
+     * @param { String } extId UUID of a simulation.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<DeleteSimulationApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link DeleteSimulationApiResponse } and HTTP response
+     */
+    deleteSimulationById(extId: string, ...args: any): Promise<DeleteSimulationApiResponse>;
+    /**
+     * Generate recommendation for a capacity planning scenario
+     * Generates recommendation for a planned capacity scenario using the provided UUID. You can send a polling request to find out the task status. The external identifier provided in the response can be used in GET scenarios API to retrieve the recommendation result upon the task completion.
+     * @param { String } extId UUID of a capacity planning scenario.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GenerateRecommendationApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GenerateRecommendationApiResponse } and HTTP response
+     */
+    generateRecommendation(extId: string, ...args: any): Promise<GenerateRecommendationApiResponse>;
+    /**
+     * Generate a report for a planned capacity scenario
+     * Generates a report for a planned capacity scenario by the provided scenario UUID. You can send a polling request to know the task status. The external identifier from the response can be used in GET report API to fetch the generated report upon the task completion.
+     * @param { String } extId UUID of a capacity planning scenario.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GenerateReportApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GenerateReportApiResponse } and HTTP response
+     */
+    generateReport(extId: string, ...args: any): Promise<GenerateReportApiResponse>;
+    /**
+     * Generate runway for a planned capacity scenario
+     * Generates runway for planned capacity scenario with the given UUID. You can send a polling request to know about the task status. The external identifier from the response can be used in the GET capacity scenarios API to fetch the runway result upon task completion.
+     * @param { String } extId UUID of a capacity planning scenario.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GenerateRunwayApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GenerateRunwayApiResponse } and HTTP response
+     */
+    generateRunway(extId: string, ...args: any): Promise<GenerateRunwayApiResponse>;
+    /**
+     * Get a single capacity planning scenario
+     * Fetches a single capacity planing scenario using the UUID of the scenario.
+     * @param { String } extId UUID of a capacity planning scenario.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GetScenarioApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetScenarioApiResponse } and HTTP response
+     */
+    getScenarioById(extId: string, ...args: any): Promise<GetScenarioApiResponse>;
+    /**
+     * Get the generated report for a planned capacity scenario
+     * Fetches the generated capacity planning scenario report by the report UUID.
+     * @param { String } scenarioExtId UUID of the capacity planning scenario to get the report.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GetScenarioReportApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetScenarioReportApiResponse } and HTTP response
+     */
+    getScenarioReport(scenarioExtId: string, ...args: any): Promise<GetScenarioReportApiResponse>;
+    /**
+     * Get a simulation
+     * Fetches a simulation from the provided UUID.
+     * @param { String } extId UUID of a simulation.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GetSimulationApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetSimulationApiResponse } and HTTP response
+     */
+    getSimulationById(extId: string, ...args: any): Promise<GetSimulationApiResponse>;
+    /**
+     * Get a list of capacity planning scenarios
+     * Fetches a list of capacity planning scenarios in a paginated manner.
+     * @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<ListScenariosApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListScenariosApiResponse } and HTTP response
+     */
+    listScenarios(opts: {
+        $page: number;
+        $limit: number;
+        $filter: string;
+        $orderby: string;
+        $select: string;
+    }, ...args: any): Promise<ListScenariosApiResponse>;
+    /**
+     * Get a list of simulations
+     * Fetches a list of simulations in a paginated manner.
+     * @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<ListSimulationsApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListSimulationsApiResponse } and HTTP response
+     */
+    listSimulations(opts: {
+        $page: number;
+        $limit: number;
+        $filter: string;
+        $orderby: string;
+        $select: string;
+    }, ...args: any): Promise<ListSimulationsApiResponse>;
+    /**
+     * Update a capacity planning scenario
+     * Updates a capacity planning scenario using the provided UUID.
+     * @param { Partial<Scenario> } body specification
+     * @param { String } extId UUID of a capacity planning scenario.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<UpdateScenarioApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link UpdateScenarioApiResponse } and HTTP response
+     */
+    updateScenarioById(extId: string, body: Partial<Scenario>, ...args: any): Promise<UpdateScenarioApiResponse>;
+    /**
+     * Update a simulation
+     * Updates a simulation identified by the provided UUID.
+     * @param { Partial<Simulation> } body specification
+     * @param { String } extId UUID of a simulation.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<UpdateSimulationApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link UpdateSimulationApiResponse } and HTTP response
+     */
+    updateSimulationById(extId: string, body: Partial<Simulation>, ...args: any): Promise<UpdateSimulationApiResponse>;
+    #private;
+}
+import Scenario from "../models/aiops/v4/config/Scenario";
+import CreateScenarioApiResponse from "../models/aiops/v4/config/CreateScenarioApiResponse";
+import Simulation from "../models/aiops/v4/config/Simulation";
+import CreateSimulationApiResponse from "../models/aiops/v4/config/CreateSimulationApiResponse";
+import DeleteScenarioApiResponse from "../models/aiops/v4/config/DeleteScenarioApiResponse";
+import DeleteSimulationApiResponse from "../models/aiops/v4/config/DeleteSimulationApiResponse";
+import GenerateRecommendationApiResponse from "../models/aiops/v4/config/GenerateRecommendationApiResponse";
+import GenerateReportApiResponse from "../models/aiops/v4/config/GenerateReportApiResponse";
+import GenerateRunwayApiResponse from "../models/aiops/v4/config/GenerateRunwayApiResponse";
+import GetScenarioApiResponse from "../models/aiops/v4/config/GetScenarioApiResponse";
+import GetScenarioReportApiResponse from "../models/aiops/v4/config/GetScenarioReportApiResponse";
+import GetSimulationApiResponse from "../models/aiops/v4/config/GetSimulationApiResponse";
+import ListScenariosApiResponse from "../models/aiops/v4/config/ListScenariosApiResponse";
+import ListSimulationsApiResponse from "../models/aiops/v4/config/ListSimulationsApiResponse";
+import UpdateScenarioApiResponse from "../models/aiops/v4/config/UpdateScenarioApiResponse";
+import UpdateSimulationApiResponse from "../models/aiops/v4/config/UpdateSimulationApiResponse";
+import { ApiClient } from "../ApiClient";