@nutanix-scratch/opsmgmt-js-client 4.0.1

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

@@ -0,0 +1,275 @@
+"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.ReportArtifactsApi = void 0;
+var _ApiClient = require("../ApiClient");
+var _ListReportArtifactsApiResponse = _interopRequireDefault(require("../models/opsmgmt/v4/content/ListReportArtifactsApiResponse"));
+var _ReportArtifact = _interopRequireDefault(require("../models/opsmgmt/v4/content/ReportArtifact"));
+var _UploadArtifactApiResponse = _interopRequireDefault(require("../models/opsmgmt/v4/content/UploadArtifactApiResponse"));
+var _CreateReportArtifactApiResponse = _interopRequireDefault(require("../models/opsmgmt/v4/content/CreateReportArtifactApiResponse"));
+var _DownloadArtifactileApiResponse = _interopRequireDefault(require("../models/opsmgmt/v4/content/DownloadArtifactileApiResponse"));
+var _path2 = _interopRequireDefault(require("path"));
+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 Cloud Management Platform 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.
+ *
+ */
+/**
+ * ReportArtifacts service.
+ * @version 4.0.1
+ * @class ReportArtifactsApi
+ */
+var _headersToSkip = /*#__PURE__*/new WeakMap();
+var ReportArtifactsApi = exports.ReportArtifactsApi = /*#__PURE__*/function () {
+  /**
+   * Constructs a new ReportArtifactsApi. 
+   * @alias module:api/ReportArtifactsApi
+   * @class
+   * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+   * default to {@link module:ApiClient#instance} if unspecified.
+   */
+  function ReportArtifactsApi(apiClient) {
+    _classCallCheck(this, ReportArtifactsApi);
+    _classPrivateFieldInitSpec(this, _headersToSkip, void 0);
+    this.apiClient = apiClient || _ApiClient.ApiClient.instance;
+    _classPrivateFieldSet(_headersToSkip, this, new Set());
+    _classPrivateFieldGet(_headersToSkip, this).add('authorization');
+    _classPrivateFieldGet(_headersToSkip, this).add('cookie');
+    _classPrivateFieldGet(_headersToSkip, this).add('host');
+    _classPrivateFieldGet(_headersToSkip, this).add('user-agent');
+  }
+
+  /**
+   * Create a report artifact
+   * This operation creates a report artifact using the provided artifact type and file type.
+   * @param { Required<Pick<ReportArtifact, 'type' | 'fileType'>> & Partial<ReportArtifact> } body specification
+   * @param {Object} args Additional Arguments
+   * @return {Promise<CreateReportArtifactApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateReportArtifactApiResponse } and HTTP response
+   */
+  return _createClass(ReportArtifactsApi, [{
+    key: "createReportArtifact",
+    value: function createReportArtifact(body) {
+      var _this = this;
+      var argMap = (arguments.length <= 1 ? 0 : arguments.length - 1) > 0 ? arguments.length <= 1 ? undefined : arguments[1] : {};
+      var postBody = null;
+      if (body instanceof _ReportArtifact["default"] && typeof body.toJson === 'function') {
+        postBody = body.toJson();
+      } else {
+        postBody = body;
+      }
+      // verify the required parameter 'body' is set
+      if (typeof postBody === 'undefined' || postBody === null) {
+        throw new Error("Invalid body when calling createReportArtifact");
+      }
+      var pathParams = {};
+      var queryParams = {};
+      var headersToInclude = {};
+      Object.keys(argMap).forEach(function (header) {
+        if (!_classPrivateFieldGet(_headersToSkip, _this).has(header.toLowerCase())) {
+          headersToInclude[header] = argMap[header];
+        }
+      });
+      var headerParams = _objectSpread({}, headersToInclude);
+      var formParams = {};
+      _ApiClient.ApiClient.addEtagReferenceToHeader(body, headerParams);
+      var authNames = ['apiKeyAuthScheme', 'basicAuthScheme'];
+      var contentTypes = ['application/json'];
+      var accepts = ['application/json'];
+      var returnType = _CreateReportArtifactApiResponse["default"];
+      return this.apiClient.callApi('/api/opsmgmt/v4.0/content/report-artifacts', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+    }
+
+    /**
+     * Download an artifact file
+     * This operation downloads the artifact with the given UUID.
+     * @param { String } reportArtifactExtId Report artifact ID.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<DownloadArtifactileApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link DownloadArtifactileApiResponse } and HTTP response
+     */
+  }, {
+    key: "downloadArtifactFile",
+    value: function downloadArtifactFile(reportArtifactExtId) {
+      var _this2 = this;
+      var argMap = (arguments.length <= 1 ? 0 : arguments.length - 1) > 0 ? arguments.length <= 1 ? undefined : arguments[1] : {};
+      var postBody = null;
+      // verify the required parameter 'reportArtifactExtId' is set
+      if (typeof reportArtifactExtId === 'undefined' || reportArtifactExtId === null) {
+        throw new Error("Missing the required parameter 'reportArtifactExtId' when calling downloadArtifactFile");
+      }
+      var pathParams = {
+        'reportArtifactExtId': reportArtifactExtId
+      };
+      var queryParams = {};
+      var headersToInclude = {};
+      Object.keys(argMap).forEach(function (header) {
+        if (!_classPrivateFieldGet(_headersToSkip, _this2).has(header.toLowerCase())) {
+          headersToInclude[header] = argMap[header];
+        }
+      });
+      var headerParams = _objectSpread({}, headersToInclude);
+      var formParams = {};
+      var authNames = ['apiKeyAuthScheme', 'basicAuthScheme'];
+      var contentTypes = [];
+      var accepts = ['application/octet-stream', 'application/json'];
+      var returnType = _DownloadArtifactileApiResponse["default"];
+      return this.apiClient.callApi('/api/opsmgmt/v4.0/content/report-artifacts/{reportArtifactExtId}/file', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+    }
+
+    /**
+     * Get a list of report artifacts
+     * Endpoint for listing all report artifacts accessible to the user matching the filter criteria.
+     * @param {Object} opts Optional parameters defined for the operation
+     * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
+      * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
+      * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.<br>
+     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'.<br>
+     * The filter can be applied to the following fields:<br>
+     * - fileType<br>
+     * - type
+     * @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.
+    - extId
+    - fileType
+    - links
+    - tenantId
+    - type
+      * @param {Object} args Additional Arguments
+     * @return {Promise<ListReportArtifactsApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListReportArtifactsApiResponse } and HTTP response
+     */
+  }, {
+    key: "listReportArtifacts",
+    value: function listReportArtifacts(opts) {
+      var _this3 = this;
+      var argMap = (arguments.length <= 1 ? 0 : arguments.length - 1) > 0 ? arguments.length <= 1 ? undefined : arguments[1] : {};
+      opts = opts || {};
+      var postBody = null;
+      var pathParams = {};
+      var queryParams = _objectSpread(_objectSpread(_objectSpread(_objectSpread({}, opts.hasOwnProperty('$page') ? {
+        '$page': opts['$page']
+      } : {}), opts.hasOwnProperty('$limit') ? {
+        '$limit': opts['$limit']
+      } : {}), opts.hasOwnProperty('$filter') ? {
+        '$filter': opts['$filter']
+      } : {}), opts.hasOwnProperty('$select') ? {
+        '$select': opts['$select']
+      } : {});
+      var headersToInclude = {};
+      Object.keys(argMap).forEach(function (header) {
+        if (!_classPrivateFieldGet(_headersToSkip, _this3).has(header.toLowerCase())) {
+          headersToInclude[header] = argMap[header];
+        }
+      });
+      var headerParams = _objectSpread({}, headersToInclude);
+      var formParams = {};
+      var authNames = ['apiKeyAuthScheme', 'basicAuthScheme'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _ListReportArtifactsApiResponse["default"];
+      return this.apiClient.callApi('/api/opsmgmt/v4.0/content/report-artifacts', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+    }
+
+    /**
+     * Upload an artifact file
+     * This operation uploads an artifact file to the provided UUID.
+     * @param { Partial<String | ReadableStream> } body Accepts file path as a string or a file stream
+     * @param { String } reportArtifactExtId Report artifact ID.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<UploadArtifactApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link UploadArtifactApiResponse } and HTTP response
+     */
+  }, {
+    key: "uploadArtifactFile",
+    value: function uploadArtifactFile(reportArtifactExtId, body) {
+      var _this4 = this;
+      var argMap = (arguments.length <= 2 ? 0 : arguments.length - 2) > 0 ? arguments.length <= 2 ? undefined : arguments[2] : {};
+      var postBody = null;
+      var fs;
+      try {
+        fs = require('fs');
+      } catch (err) {}
+      if (typeof body.pipe === 'function') {
+        postBody = body;
+        argMap["Content-Length"] = fs.statSync(body.path).size;
+        if (!argMap.hasOwnProperty("Content-Disposition")) {
+          argMap["Content-Disposition"] = 'attachment; filename="' + _path2["default"].parse(body.path).base + '"';
+        }
+      } else if (typeof body === 'string') {
+        // body is a path string
+        var _path;
+        try {
+          _path = require('path');
+        } catch (err) {
+          throw new Error('Cannot find module \'path\'. Ensure you are using a Node.js environment. If not, use ReadableStream for body parameter.');
+        }
+        try {
+          postBody = fs.createReadStream(body);
+          argMap["Content-Length"] = fs.statSync(body).size;
+          if (!argMap.hasOwnProperty("Content-Disposition")) {
+            argMap["Content-Disposition"] = 'attachment; filename="' + _path.basename(body) + '"';
+          }
+        } catch (err) {
+          throw new Error('Cannot read file: ' + body + '. Error: ' + err.message);
+        }
+      } else {
+        postBody = body;
+      }
+      // verify the required parameter 'reportArtifactExtId' is set
+      if (typeof reportArtifactExtId === 'undefined' || reportArtifactExtId === null) {
+        throw new Error("Missing the required parameter 'reportArtifactExtId' when calling uploadArtifactFile");
+      }
+      // verify the required parameter 'body' is set
+      if (typeof postBody === 'undefined' || postBody === null) {
+        throw new Error("Invalid body when calling uploadArtifactFile");
+      }
+      var pathParams = {
+        'reportArtifactExtId': reportArtifactExtId
+      };
+      var queryParams = {};
+      var headersToInclude = {};
+      Object.keys(argMap).forEach(function (header) {
+        if (!_classPrivateFieldGet(_headersToSkip, _this4).has(header.toLowerCase())) {
+          headersToInclude[header] = argMap[header];
+        }
+      });
+      var headerParams = _objectSpread({}, headersToInclude);
+      var formParams = {};
+      _ApiClient.ApiClient.addEtagReferenceToHeader(body, headerParams);
+      var authNames = ['apiKeyAuthScheme', 'basicAuthScheme'];
+      var contentTypes = ['application/octet-stream'];
+      var accepts = ['application/json'];
+      var returnType = _UploadArtifactApiResponse["default"];
+      return this.apiClient.callApi('/api/opsmgmt/v4.0/content/report-artifacts/{reportArtifactExtId}/$actions/upload', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType);
+    }
+  }], [{
+    key: "ApiClient",
+    get:
+    /**
+    * Make the default {@link ApiClient} class available for developers to be able to extend it and bring
+    * their own fetch methods into the SDK
+    */
+    function get() {
+      return _ApiClient.ApiClient;
+    }
+  }]);
+}();

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

@@ -0,0 +1,110 @@
+/**
+ * ReportConfig service.
+ * @version 4.0.1
+ * @class ReportConfigApi
+ */
+export class ReportConfigApi {
+    /**
+    * 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 ReportConfigApi.
+     * @alias module:api/ReportConfigApi
+     * @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 report configuration
+     * Create a custom report configuration using the request body.
+     * @param { Required<Pick<ReportConfig, 'name' | 'sections'>> & Partial<ReportConfig> } body specification
+     * @param {Object} args Additional Arguments
+     * @return {Promise<CreateReportConfigApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link CreateReportConfigApiResponse } and HTTP response
+     */
+    createReportConfig(body: Required<Pick<ReportConfig, 'name' | 'sections'>> & Partial<ReportConfig>, ...args: any): Promise<CreateReportConfigApiResponse>;
+    /**
+     * Delete a report configuration
+     * Deletes a report configuration with the given UUID.
+     * @param { String } extId Report configuration UUID.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<DeleteReportConfigApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link DeleteReportConfigApiResponse } and HTTP response
+     */
+    deleteReportConfigById(extId: string, ...args: any): Promise<DeleteReportConfigApiResponse>;
+    /**
+     * Get report configuration information
+     * Returns report configuration information for the provided UUID.
+     * @param { String } extId Report configuration UUID.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<GetReportConfigApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link GetReportConfigApiResponse } and HTTP response
+     */
+    getReportConfigById(extId: string, ...args: any): Promise<GetReportConfigApiResponse>;
+    /**
+     * Get the list of report configurations
+     * Endpoint for listing all report configurations accessible to the user that match the filter criteria.
+     * @param {Object} opts Optional parameters defined for the operation
+     * @param { Number } opts.$page A URL query parameter that specifies the page number of the result set. It must be a positive integer between 0 and the maximum number of pages that are available for that resource. Any number out of this range might lead to no results.
+
+     * @param { Number } opts.$limit A URL query parameter that specifies the total number of records returned in the result set.  Must be a positive integer between 1 and 100. Any number out of this range will lead to a validation error. If the limit is not provided, a default value of 50 records will be returned in the result set.
+
+     * @param { String } opts.$filter A URL query parameter that allows clients to filter a collection of resources. The expression specified with $filter is evaluated for each resource in the collection, and only items where the expression evaluates to true are included in the response. Expression specified with the $filter must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions.<br>
+     * For example, filter '$filter=name eq 'karbon-ntnx-1.0' would filter the result on cluster name 'karbon-ntnx1.0', filter '$filter=startswith(name, 'C')' would filter on cluster name starting with 'C'.<br>
+     * The filter can be applied to the following fields:<br>
+     * - isSystemDefined<br>
+     * - name
+     * @param { String } opts.$orderby A URL query parameter that allows clients to specify the sort criteria for the returned list of objects. Resources can be sorted in ascending order using asc or descending order using desc. If asc or desc are not specified, the resources will be sorted in ascending order by default. For example, '$orderby=templateName desc' would get all templates sorted by templateName in descending order.<br>
+     * The orderby can be applied to the following fields:<br>
+     * - creationTime<br>
+     * - name
+     * @param { String } opts.$select A URL query parameter that allows clients to request a specific set of properties for each entity or complex type. Expression specified with the $select must conform to the [OData V4.01](https://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html) URL conventions. If a $select expression consists of a single select item that is an asterisk (i.e., *), then all properties on the matching resource will be returned.
+- creationTime
+- defaultSectionEntityType
+- description
+- endTimeOffsetSecs
+- extId
+- isImported
+- isPrivate
+- isSystemDefined
+- links
+- name
+- notificationPolicy
+- reportCustomization
+- retentionConfig
+- schedule
+- sections
+- startTimeOffsetSecs
+- supportedFormats
+- tenantId
+- timezone
+
+     * @param {Object} args Additional Arguments
+     * @return {Promise<ListReportConfigsApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link ListReportConfigsApiResponse } and HTTP response
+     */
+    listReportConfigs(opts: {
+        $page: number;
+        $limit: number;
+        $filter: string;
+        $orderby: string;
+        $select: string;
+    }, ...args: any): Promise<ListReportConfigsApiResponse>;
+    /**
+     * Update report configuration
+     * Updates the report configuration information for the provided UUID with the given specifications.
+     * @param { Required<Pick<ReportConfig, 'name' | 'sections'>> & Partial<ReportConfig> } body specification
+     * @param { String } extId Report configuration UUID.
+     * @param {Object} args Additional Arguments
+     * @return {Promise<UpdateReportConfigApiResponse>} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link UpdateReportConfigApiResponse } and HTTP response
+     */
+    updateReportConfigById(extId: string, body: Required<Pick<ReportConfig, 'name' | 'sections'>> & Partial<ReportConfig>, ...args: any): Promise<UpdateReportConfigApiResponse>;
+    #private;
+}
+import ReportConfig from "../models/opsmgmt/v4/config/ReportConfig";
+import CreateReportConfigApiResponse from "../models/opsmgmt/v4/config/CreateReportConfigApiResponse";
+import DeleteReportConfigApiResponse from "../models/opsmgmt/v4/config/DeleteReportConfigApiResponse";
+import GetReportConfigApiResponse from "../models/opsmgmt/v4/config/GetReportConfigApiResponse";
+import ListReportConfigsApiResponse from "../models/opsmgmt/v4/config/ListReportConfigsApiResponse";
+import UpdateReportConfigApiResponse from "../models/opsmgmt/v4/config/UpdateReportConfigApiResponse";
+import { ApiClient } from "../ApiClient";