@kestra-io/kestra-sdk 0.24.0

package/dist/api/DashboardsApi.js

@@ -0,0 +1,535 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _ChartFiltersOverrides = _interopRequireDefault(require("../model/ChartFiltersOverrides"));
+var _Dashboard = _interopRequireDefault(require("../model/Dashboard"));
+var _DashboardControllerPreviewRequest = _interopRequireDefault(require("../model/DashboardControllerPreviewRequest"));
+var _PagedResultsDashboard = _interopRequireDefault(require("../model/PagedResultsDashboard"));
+var _PagedResultsMapStringObject = _interopRequireDefault(require("../model/PagedResultsMapStringObject"));
+var _ValidateConstraintViolation = _interopRequireDefault(require("../model/ValidateConstraintViolation"));
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
+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 _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); } /**
+ * Kestra EE
+ * All API operations, except for Superadmin-only endpoints, require a tenant identifier in the HTTP path.<br/> Endpoints designated as Superadmin-only are not tenant-scoped.
+ *
+ * The version of the OpenAPI document: v1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+* Dashboards service.
+* @module api/DashboardsApi
+* @version v0.24.0
+*/
+var DashboardsApi = exports["default"] = /*#__PURE__*/function () {
+  /**
+  * Constructs a new DashboardsApi. 
+  * @alias module:api/DashboardsApi
+  * @class
+  * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+  * default to {@link module:ApiClient#instance} if unspecified.
+  */
+  function DashboardsApi(apiClient) {
+    _classCallCheck(this, DashboardsApi);
+    this.apiClient = apiClient || _ApiClient["default"].instance;
+  }
+
+  /**
+   * Callback function to receive the result of the createDashboard operation.
+   * @callback module:api/DashboardsApi~createDashboardCallback
+   * @param {String} error Error message, if any.
+   * @param {module:model/Dashboard} data The data returned by the service call.
+   * @param {String} response The complete HTTP response.
+   */
+
+  /**
+   * Create a dashboard from yaml source
+   * @param {String} tenant 
+   * @param {String} body The dashboard definition as YAML
+   * @param {module:api/DashboardsApi~createDashboardCallback} callback The callback function, accepting three arguments: error, data, response
+   * data is of type: {@link module:model/Dashboard}
+   */
+  return _createClass(DashboardsApi, [{
+    key: "createDashboard",
+    value: function createDashboard(tenant, body, callback) {
+      var postBody = body;
+      // verify the required parameter 'tenant' is set
+      if (tenant === undefined || tenant === null) {
+        throw new Error("Missing the required parameter 'tenant' when calling createDashboard");
+      }
+      // verify the required parameter 'body' is set
+      if (body === undefined || body === null) {
+        throw new Error("Missing the required parameter 'body' when calling createDashboard");
+      }
+      var pathParams = {
+        'tenant': tenant
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = [];
+      var contentTypes = ['application/x-yaml'];
+      var accepts = ['application/json'];
+      var returnType = _Dashboard["default"];
+      return this.apiClient.callApi('/api/v1/{tenant}/dashboards', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the deleteDashboard operation.
+     * @callback module:api/DashboardsApi~deleteDashboardCallback
+     * @param {String} error Error message, if any.
+     * @param data This operation does not return a value.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Delete a dashboard
+     * @param {String} id The dashboard id
+     * @param {String} tenant 
+     * @param {module:api/DashboardsApi~deleteDashboardCallback} callback The callback function, accepting three arguments: error, data, response
+     */
+  }, {
+    key: "deleteDashboard",
+    value: function deleteDashboard(id, tenant, callback) {
+      var postBody = null;
+      // verify the required parameter 'id' is set
+      if (id === undefined || id === null) {
+        throw new Error("Missing the required parameter 'id' when calling deleteDashboard");
+      }
+      // verify the required parameter 'tenant' is set
+      if (tenant === undefined || tenant === null) {
+        throw new Error("Missing the required parameter 'tenant' when calling deleteDashboard");
+      }
+      var pathParams = {
+        'id': id,
+        'tenant': tenant
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = [];
+      var contentTypes = [];
+      var accepts = [];
+      var returnType = null;
+      return this.apiClient.callApi('/api/v1/{tenant}/dashboards/{id}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the exportChartToCsv operation.
+     * @callback module:api/DashboardsApi~exportChartToCsvCallback
+     * @param {String} error Error message, if any.
+     * @param {Blob} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Export a table chart data to CSV
+     * @param {String} tenant 
+     * @param {module:model/DashboardControllerPreviewRequest} dashboardControllerPreviewRequest 
+     * @param {module:api/DashboardsApi~exportChartToCsvCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Blob}
+     */
+  }, {
+    key: "exportChartToCsv",
+    value: function exportChartToCsv(tenant, dashboardControllerPreviewRequest, callback) {
+      var postBody = dashboardControllerPreviewRequest;
+      // verify the required parameter 'tenant' is set
+      if (tenant === undefined || tenant === null) {
+        throw new Error("Missing the required parameter 'tenant' when calling exportChartToCsv");
+      }
+      // verify the required parameter 'dashboardControllerPreviewRequest' is set
+      if (dashboardControllerPreviewRequest === undefined || dashboardControllerPreviewRequest === null) {
+        throw new Error("Missing the required parameter 'dashboardControllerPreviewRequest' when calling exportChartToCsv");
+      }
+      var pathParams = {
+        'tenant': tenant
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = [];
+      var contentTypes = ['application/json'];
+      var accepts = ['application/octet-stream'];
+      var returnType = 'Blob';
+      return this.apiClient.callApi('/api/v1/{tenant}/dashboards/charts/export/to-csv', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the exportDashboardChartDataToCSV operation.
+     * @callback module:api/DashboardsApi~exportDashboardChartDataToCSVCallback
+     * @param {String} error Error message, if any.
+     * @param {Blob} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Export a dashboard chart data to CSV
+     * @param {String} id The dashboard id
+     * @param {String} chartId The chart id
+     * @param {String} tenant 
+     * @param {module:model/ChartFiltersOverrides} chartFiltersOverrides The filters to apply, some can override chart definition like labels & namespace
+     * @param {module:api/DashboardsApi~exportDashboardChartDataToCSVCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Blob}
+     */
+  }, {
+    key: "exportDashboardChartDataToCSV",
+    value: function exportDashboardChartDataToCSV(id, chartId, tenant, chartFiltersOverrides, callback) {
+      var postBody = chartFiltersOverrides;
+      // verify the required parameter 'id' is set
+      if (id === undefined || id === null) {
+        throw new Error("Missing the required parameter 'id' when calling exportDashboardChartDataToCSV");
+      }
+      // verify the required parameter 'chartId' is set
+      if (chartId === undefined || chartId === null) {
+        throw new Error("Missing the required parameter 'chartId' when calling exportDashboardChartDataToCSV");
+      }
+      // verify the required parameter 'tenant' is set
+      if (tenant === undefined || tenant === null) {
+        throw new Error("Missing the required parameter 'tenant' when calling exportDashboardChartDataToCSV");
+      }
+      // verify the required parameter 'chartFiltersOverrides' is set
+      if (chartFiltersOverrides === undefined || chartFiltersOverrides === null) {
+        throw new Error("Missing the required parameter 'chartFiltersOverrides' when calling exportDashboardChartDataToCSV");
+      }
+      var pathParams = {
+        'id': id,
+        'chartId': chartId,
+        'tenant': tenant
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = [];
+      var contentTypes = ['application/json'];
+      var accepts = ['application/octet-stream'];
+      var returnType = 'Blob';
+      return this.apiClient.callApi('/api/v1/{tenant}/dashboards/{id}/charts/{chartId}/export/to-csv', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the getDashboard operation.
+     * @callback module:api/DashboardsApi~getDashboardCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/Dashboard} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Get a dashboard
+     * @param {String} id The dashboard id
+     * @param {String} tenant 
+     * @param {module:api/DashboardsApi~getDashboardCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/Dashboard}
+     */
+  }, {
+    key: "getDashboard",
+    value: function getDashboard(id, tenant, callback) {
+      var postBody = null;
+      // verify the required parameter 'id' is set
+      if (id === undefined || id === null) {
+        throw new Error("Missing the required parameter 'id' when calling getDashboard");
+      }
+      // verify the required parameter 'tenant' is set
+      if (tenant === undefined || tenant === null) {
+        throw new Error("Missing the required parameter 'tenant' when calling getDashboard");
+      }
+      var pathParams = {
+        'id': id,
+        'tenant': tenant
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = [];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _Dashboard["default"];
+      return this.apiClient.callApi('/api/v1/{tenant}/dashboards/{id}', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the getDashboardChartData operation.
+     * @callback module:api/DashboardsApi~getDashboardChartDataCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/PagedResultsMapStringObject} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Generate a dashboard chart data
+     * @param {String} id The dashboard id
+     * @param {String} chartId The chart id
+     * @param {String} tenant 
+     * @param {module:model/ChartFiltersOverrides} chartFiltersOverrides The filters to apply, some can override chart definition like labels & namespace
+     * @param {module:api/DashboardsApi~getDashboardChartDataCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/PagedResultsMapStringObject}
+     */
+  }, {
+    key: "getDashboardChartData",
+    value: function getDashboardChartData(id, chartId, tenant, chartFiltersOverrides, callback) {
+      var postBody = chartFiltersOverrides;
+      // verify the required parameter 'id' is set
+      if (id === undefined || id === null) {
+        throw new Error("Missing the required parameter 'id' when calling getDashboardChartData");
+      }
+      // verify the required parameter 'chartId' is set
+      if (chartId === undefined || chartId === null) {
+        throw new Error("Missing the required parameter 'chartId' when calling getDashboardChartData");
+      }
+      // verify the required parameter 'tenant' is set
+      if (tenant === undefined || tenant === null) {
+        throw new Error("Missing the required parameter 'tenant' when calling getDashboardChartData");
+      }
+      // verify the required parameter 'chartFiltersOverrides' is set
+      if (chartFiltersOverrides === undefined || chartFiltersOverrides === null) {
+        throw new Error("Missing the required parameter 'chartFiltersOverrides' when calling getDashboardChartData");
+      }
+      var pathParams = {
+        'id': id,
+        'chartId': chartId,
+        'tenant': tenant
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = [];
+      var contentTypes = ['application/json'];
+      var accepts = ['application/json'];
+      var returnType = _PagedResultsMapStringObject["default"];
+      return this.apiClient.callApi('/api/v1/{tenant}/dashboards/{id}/charts/{chartId}', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the previewChart operation.
+     * @callback module:api/DashboardsApi~previewChartCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/PagedResultsMapStringObject} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Preview a chart data
+     * @param {String} tenant 
+     * @param {module:model/DashboardControllerPreviewRequest} dashboardControllerPreviewRequest 
+     * @param {module:api/DashboardsApi~previewChartCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/PagedResultsMapStringObject}
+     */
+  }, {
+    key: "previewChart",
+    value: function previewChart(tenant, dashboardControllerPreviewRequest, callback) {
+      var postBody = dashboardControllerPreviewRequest;
+      // verify the required parameter 'tenant' is set
+      if (tenant === undefined || tenant === null) {
+        throw new Error("Missing the required parameter 'tenant' when calling previewChart");
+      }
+      // verify the required parameter 'dashboardControllerPreviewRequest' is set
+      if (dashboardControllerPreviewRequest === undefined || dashboardControllerPreviewRequest === null) {
+        throw new Error("Missing the required parameter 'dashboardControllerPreviewRequest' when calling previewChart");
+      }
+      var pathParams = {
+        'tenant': tenant
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = [];
+      var contentTypes = ['application/json'];
+      var accepts = ['application/json'];
+      var returnType = _PagedResultsMapStringObject["default"];
+      return this.apiClient.callApi('/api/v1/{tenant}/dashboards/charts/preview', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the searchDashboards operation.
+     * @callback module:api/DashboardsApi~searchDashboardsCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/PagedResultsDashboard} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Search for dashboards
+     * @param {Number} page The current page
+     * @param {Number} size The current page size
+     * @param {String} tenant 
+     * @param {Object} opts Optional parameters
+     * @param {String} [q] The filter query
+     * @param {Array.<String>} [sort] The sort of current page
+     * @param {module:api/DashboardsApi~searchDashboardsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/PagedResultsDashboard}
+     */
+  }, {
+    key: "searchDashboards",
+    value: function searchDashboards(page, size, tenant, opts, callback) {
+      opts = opts || {};
+      var postBody = null;
+      // verify the required parameter 'page' is set
+      if (page === undefined || page === null) {
+        throw new Error("Missing the required parameter 'page' when calling searchDashboards");
+      }
+      // verify the required parameter 'size' is set
+      if (size === undefined || size === null) {
+        throw new Error("Missing the required parameter 'size' when calling searchDashboards");
+      }
+      // verify the required parameter 'tenant' is set
+      if (tenant === undefined || tenant === null) {
+        throw new Error("Missing the required parameter 'tenant' when calling searchDashboards");
+      }
+      var pathParams = {
+        'tenant': tenant
+      };
+      var queryParams = {
+        'page': page,
+        'size': size,
+        'q': opts['q'],
+        'sort': this.apiClient.buildCollectionParam(opts['sort'], 'csv')
+      };
+      var headerParams = {};
+      var formParams = {};
+      var authNames = [];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _PagedResultsDashboard["default"];
+      return this.apiClient.callApi('/api/v1/{tenant}/dashboards', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the updateDashboard operation.
+     * @callback module:api/DashboardsApi~updateDashboardCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/Dashboard} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Update a dashboard
+     * @param {String} id The dashboard id
+     * @param {String} tenant 
+     * @param {String} body The dashboard definition as YAML
+     * @param {module:api/DashboardsApi~updateDashboardCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/Dashboard}
+     */
+  }, {
+    key: "updateDashboard",
+    value: function updateDashboard(id, tenant, body, callback) {
+      var postBody = body;
+      // verify the required parameter 'id' is set
+      if (id === undefined || id === null) {
+        throw new Error("Missing the required parameter 'id' when calling updateDashboard");
+      }
+      // verify the required parameter 'tenant' is set
+      if (tenant === undefined || tenant === null) {
+        throw new Error("Missing the required parameter 'tenant' when calling updateDashboard");
+      }
+      // verify the required parameter 'body' is set
+      if (body === undefined || body === null) {
+        throw new Error("Missing the required parameter 'body' when calling updateDashboard");
+      }
+      var pathParams = {
+        'id': id,
+        'tenant': tenant
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = [];
+      var contentTypes = ['application/x-yaml'];
+      var accepts = ['application/json'];
+      var returnType = _Dashboard["default"];
+      return this.apiClient.callApi('/api/v1/{tenant}/dashboards/{id}', 'PUT', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the validateChart operation.
+     * @callback module:api/DashboardsApi~validateChartCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ValidateConstraintViolation} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Validate a chart from yaml source
+     * @param {String} tenant 
+     * @param {String} body The chart definition as YAML
+     * @param {module:api/DashboardsApi~validateChartCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/ValidateConstraintViolation}
+     */
+  }, {
+    key: "validateChart",
+    value: function validateChart(tenant, body, callback) {
+      var postBody = body;
+      // verify the required parameter 'tenant' is set
+      if (tenant === undefined || tenant === null) {
+        throw new Error("Missing the required parameter 'tenant' when calling validateChart");
+      }
+      // verify the required parameter 'body' is set
+      if (body === undefined || body === null) {
+        throw new Error("Missing the required parameter 'body' when calling validateChart");
+      }
+      var pathParams = {
+        'tenant': tenant
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = [];
+      var contentTypes = ['application/x-yaml'];
+      var accepts = ['application/json'];
+      var returnType = _ValidateConstraintViolation["default"];
+      return this.apiClient.callApi('/api/v1/{tenant}/dashboards/validate/chart', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the validateDashboard operation.
+     * @callback module:api/DashboardsApi~validateDashboardCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ValidateConstraintViolation} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Validate dashboard from yaml source
+     * @param {String} tenant 
+     * @param {String} body The dashboard definition as YAML
+     * @param {module:api/DashboardsApi~validateDashboardCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/ValidateConstraintViolation}
+     */
+  }, {
+    key: "validateDashboard",
+    value: function validateDashboard(tenant, body, callback) {
+      var postBody = body;
+      // verify the required parameter 'tenant' is set
+      if (tenant === undefined || tenant === null) {
+        throw new Error("Missing the required parameter 'tenant' when calling validateDashboard");
+      }
+      // verify the required parameter 'body' is set
+      if (body === undefined || body === null) {
+        throw new Error("Missing the required parameter 'body' when calling validateDashboard");
+      }
+      var pathParams = {
+        'tenant': tenant
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = [];
+      var contentTypes = ['application/x-yaml'];
+      var accepts = ['application/json'];
+      var returnType = _ValidateConstraintViolation["default"];
+      return this.apiClient.callApi('/api/v1/{tenant}/dashboards/validate', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+  }]);
+}();