@kestra-io/kestra-sdk 0.24.0

package/dist/api/MiscApi.js

@@ -0,0 +1,385 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _Action = _interopRequireDefault(require("../model/Action"));
+var _ApiUser = _interopRequireDefault(require("../model/ApiUser"));
+var _MiscControllerBasicAuthCredentials = _interopRequireDefault(require("../model/MiscControllerBasicAuthCredentials"));
+var _MiscControllerEEConfiguration = _interopRequireDefault(require("../model/MiscControllerEEConfiguration"));
+var _MiscControllerLicenseInfo = _interopRequireDefault(require("../model/MiscControllerLicenseInfo"));
+var _Permission = _interopRequireDefault(require("../model/Permission"));
+var _SetupConfiguration = _interopRequireDefault(require("../model/SetupConfiguration"));
+var _SetupConfigurationSetupData = _interopRequireDefault(require("../model/SetupConfigurationSetupData"));
+var _Usage = _interopRequireDefault(require("../model/Usage"));
+var _UsageEE = _interopRequireDefault(require("../model/UsageEE"));
+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.
+ *
+ */
+/**
+* Misc service.
+* @module api/MiscApi
+* @version v0.24.0
+*/
+var MiscApi = exports["default"] = /*#__PURE__*/function () {
+  /**
+  * Constructs a new MiscApi. 
+  * @alias module:api/MiscApi
+  * @class
+  * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+  * default to {@link module:ApiClient#instance} if unspecified.
+  */
+  function MiscApi(apiClient) {
+    _classCallCheck(this, MiscApi);
+    this.apiClient = apiClient || _ApiClient["default"].instance;
+  }
+
+  /**
+   * Callback function to receive the result of the createBasicAuth operation.
+   * @callback module:api/MiscApi~createBasicAuthCallback
+   * @param {String} error Error message, if any.
+   * @param data This operation does not return a value.
+   * @param {String} response The complete HTTP response.
+   */
+
+  /**
+   * Configure basic authentication for the instance.
+   * Sets up basic authentication credentials.
+   * @param {String} tenant 
+   * @param {module:model/MiscControllerBasicAuthCredentials} miscControllerBasicAuthCredentials 
+   * @param {module:api/MiscApi~createBasicAuthCallback} callback The callback function, accepting three arguments: error, data, response
+   */
+  return _createClass(MiscApi, [{
+    key: "createBasicAuth",
+    value: function createBasicAuth(tenant, miscControllerBasicAuthCredentials, callback) {
+      var postBody = miscControllerBasicAuthCredentials;
+      // verify the required parameter 'tenant' is set
+      if (tenant === undefined || tenant === null) {
+        throw new Error("Missing the required parameter 'tenant' when calling createBasicAuth");
+      }
+      // verify the required parameter 'miscControllerBasicAuthCredentials' is set
+      if (miscControllerBasicAuthCredentials === undefined || miscControllerBasicAuthCredentials === null) {
+        throw new Error("Missing the required parameter 'miscControllerBasicAuthCredentials' when calling createBasicAuth");
+      }
+      var pathParams = {
+        'tenant': tenant
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['basicAuth', 'bearerAuth'];
+      var contentTypes = ['application/json'];
+      var accepts = [];
+      var returnType = null;
+      return this.apiClient.callApi('/api/v1/{tenant}/basicAuth', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the getBasicAuthConfigErrors operation.
+     * @callback module:api/MiscApi~getBasicAuthConfigErrorsCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<String>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Retrieve the instance configuration.
+     * Global endpoint available to all users.
+     * @param {module:api/MiscApi~getBasicAuthConfigErrorsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<String>}
+     */
+  }, {
+    key: "getBasicAuthConfigErrors",
+    value: function getBasicAuthConfigErrors(callback) {
+      var postBody = null;
+      var pathParams = {};
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['basicAuth', 'bearerAuth'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = ['String'];
+      return this.apiClient.callApi('/api/v1/basicAuthValidationErrors', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the getConfiguration operation.
+     * @callback module:api/MiscApi~getConfigurationCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/MiscControllerEEConfiguration} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Retrieve the instance configuration.
+     * Global endpoint available to all users.
+     * @param {module:api/MiscApi~getConfigurationCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/MiscControllerEEConfiguration}
+     */
+  }, {
+    key: "getConfiguration",
+    value: function getConfiguration(callback) {
+      var postBody = null;
+      var pathParams = {};
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['basicAuth', 'bearerAuth'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _MiscControllerEEConfiguration["default"];
+      return this.apiClient.callApi('/api/v1/configs', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the getUsages operation.
+     * @callback module:api/MiscApi~getUsagesCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/Usage} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Retrieve instance usage information
+     * @param {String} tenant 
+     * @param {module:api/MiscApi~getUsagesCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/Usage}
+     */
+  }, {
+    key: "getUsages",
+    value: function getUsages(tenant, callback) {
+      var postBody = null;
+      // verify the required parameter 'tenant' is set
+      if (tenant === undefined || tenant === null) {
+        throw new Error("Missing the required parameter 'tenant' when calling getUsages");
+      }
+      var pathParams = {
+        'tenant': tenant
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['basicAuth', 'bearerAuth'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _Usage["default"];
+      return this.apiClient.callApi('/api/v1/{tenant}/usages/all', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the licenseInfo operation.
+     * @callback module:api/MiscApi~licenseInfoCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/MiscControllerLicenseInfo} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Retrieve license information
+     * Global endpoint, available to any authenticated user.
+     * @param {module:api/MiscApi~licenseInfoCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/MiscControllerLicenseInfo}
+     */
+  }, {
+    key: "licenseInfo",
+    value: function licenseInfo(callback) {
+      var postBody = null;
+      var pathParams = {};
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['basicAuth', 'bearerAuth'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _MiscControllerLicenseInfo["default"];
+      return this.apiClient.callApi('/api/v1/license-info', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the listActions operation.
+     * @callback module:api/MiscApi~listActionsCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/Action>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Retrieve list of actions
+     * Actions are used to restrict possible operations for each permission. Each action must be one of the following: CREATE, READ, UPDATE, DELETE. Using permissions and actions together, you can control access to resources e.g. only allow a user to read a flow, but not update or delete it.
+     * @param {String} tenant 
+     * @param {module:api/MiscApi~listActionsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/Action>}
+     */
+  }, {
+    key: "listActions",
+    value: function listActions(tenant, callback) {
+      var postBody = null;
+      // verify the required parameter 'tenant' is set
+      if (tenant === undefined || tenant === null) {
+        throw new Error("Missing the required parameter 'tenant' when calling listActions");
+      }
+      var pathParams = {
+        'tenant': tenant
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['basicAuth', 'bearerAuth'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = [_Action["default"]];
+      return this.apiClient.callApi('/api/v1/{tenant}/acls/actions', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the listPermissions operation.
+     * @callback module:api/MiscApi~listPermissionsCallback
+     * @param {String} error Error message, if any.
+     * @param {Array.<module:model/Permission>} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Retrieve list of permissions
+     * Permissions are used to control access to resources within the Kestra platform. Example of permissions are: FLOW, EXECUTION, NAMESPACE, APP, TEST, etc.
+     * @param {String} tenant 
+     * @param {module:api/MiscApi~listPermissionsCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link Array.<module:model/Permission>}
+     */
+  }, {
+    key: "listPermissions",
+    value: function listPermissions(tenant, callback) {
+      var postBody = null;
+      // verify the required parameter 'tenant' is set
+      if (tenant === undefined || tenant === null) {
+        throw new Error("Missing the required parameter 'tenant' when calling listPermissions");
+      }
+      var pathParams = {
+        'tenant': tenant
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['basicAuth', 'bearerAuth'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = [_Permission["default"]];
+      return this.apiClient.callApi('/api/v1/{tenant}/acls/permissions', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the setupConfiguration operation.
+     * @callback module:api/MiscApi~setupConfigurationCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/SetupConfiguration} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Retrieve current setup configuration
+     * @param {module:api/MiscApi~setupConfigurationCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/SetupConfiguration}
+     */
+  }, {
+    key: "setupConfiguration",
+    value: function setupConfiguration(callback) {
+      var postBody = null;
+      var pathParams = {};
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['basicAuth', 'bearerAuth'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _SetupConfiguration["default"];
+      return this.apiClient.callApi('/api/v1/setup', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the setupKestra operation.
+     * @callback module:api/MiscApi~setupKestraCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/ApiUser} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Create the first Superadmin user
+     * Only used during initial instance setup.
+     * @param {module:model/SetupConfigurationSetupData} setupConfigurationSetupData 
+     * @param {module:api/MiscApi~setupKestraCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/ApiUser}
+     */
+  }, {
+    key: "setupKestra",
+    value: function setupKestra(setupConfigurationSetupData, callback) {
+      var postBody = setupConfigurationSetupData;
+      // verify the required parameter 'setupConfigurationSetupData' is set
+      if (setupConfigurationSetupData === undefined || setupConfigurationSetupData === null) {
+        throw new Error("Missing the required parameter 'setupConfigurationSetupData' when calling setupKestra");
+      }
+      var pathParams = {};
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['basicAuth', 'bearerAuth'];
+      var contentTypes = ['application/json'];
+      var accepts = ['application/json'];
+      var returnType = _ApiUser["default"];
+      return this.apiClient.callApi('/api/v1/setup', 'POST', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+
+    /**
+     * Callback function to receive the result of the tenantUsage operation.
+     * @callback module:api/MiscApi~tenantUsageCallback
+     * @param {String} error Error message, if any.
+     * @param {module:model/UsageEE} data The data returned by the service call.
+     * @param {String} response The complete HTTP response.
+     */
+
+    /**
+     * Retrieve usage information for the current tenant
+     * @param {String} tenant 
+     * @param {module:api/MiscApi~tenantUsageCallback} callback The callback function, accepting three arguments: error, data, response
+     * data is of type: {@link module:model/UsageEE}
+     */
+  }, {
+    key: "tenantUsage",
+    value: function tenantUsage(tenant, callback) {
+      var postBody = null;
+      // verify the required parameter 'tenant' is set
+      if (tenant === undefined || tenant === null) {
+        throw new Error("Missing the required parameter 'tenant' when calling tenantUsage");
+      }
+      var pathParams = {
+        'tenant': tenant
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['basicAuth', 'bearerAuth'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = _UsageEE["default"];
+      return this.apiClient.callApi('/api/v1/{tenant}/usages', 'GET', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null, callback);
+    }
+  }]);
+}();