@blues-inc/notehub-js 6.0.0-beta.9 → 6.1.0

package/dist/api/JobsApi.js

@@ -0,0 +1,438 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _ApiClient = _interopRequireDefault(require("../ApiClient"));
+var _CancelJobRun200Response = _interopRequireDefault(require("../model/CancelJobRun200Response"));
+var _CreateJob201Response = _interopRequireDefault(require("../model/CreateJob201Response"));
+var _DeleteJob200Response = _interopRequireDefault(require("../model/DeleteJob200Response"));
+var _Error = _interopRequireDefault(require("../model/Error"));
+var _GetJobRuns200Response = _interopRequireDefault(require("../model/GetJobRuns200Response"));
+var _GetJobs200Response = _interopRequireDefault(require("../model/GetJobs200Response"));
+var _Job = _interopRequireDefault(require("../model/Job"));
+var _JobRun = _interopRequireDefault(require("../model/JobRun"));
+var _RunJob200Response = _interopRequireDefault(require("../model/RunJob200Response"));
+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); } /**
+ * Notehub API
+ * The OpenAPI definition for the Notehub.io API.
+ *
+ * The version of the OpenAPI document: 1.2.0
+ * Contact: engineering@blues.io
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ *
+ */
+/**
+ * Jobs service.
+ * @module api/JobsApi
+ * @version 6.1.0
+ */
+var JobsApi = exports["default"] = /*#__PURE__*/function () {
+  /**
+   * Constructs a new JobsApi.
+   * @alias module:api/JobsApi
+   * @class
+   * @param {module:ApiClient} [apiClient] Optional API client implementation to use,
+   * default to {@link module:ApiClient#instance} if unspecified.
+   */
+  function JobsApi(apiClient) {
+    _classCallCheck(this, JobsApi);
+    this.apiClient = apiClient || _ApiClient["default"].instance;
+  }
+
+  /**
+   * Cancel a running job execution
+   * @param {String} projectOrProductUID
+   * @param {String} reportUID Unique identifier for a job run report
+   * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CancelJobRun200Response} and HTTP response
+   */
+  return _createClass(JobsApi, [{
+    key: "cancelJobRunWithHttpInfo",
+    value: function cancelJobRunWithHttpInfo(projectOrProductUID, reportUID) {
+      var postBody = null;
+      // verify the required parameter 'projectOrProductUID' is set
+      if (projectOrProductUID === undefined || projectOrProductUID === null) {
+        throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling cancelJobRun");
+      }
+      // verify the required parameter 'reportUID' is set
+      if (reportUID === undefined || reportUID === null) {
+        throw new _Error["default"]("Missing the required parameter 'reportUID' when calling cancelJobRun");
+      }
+      var pathParams = {
+        projectOrProductUID: projectOrProductUID,
+        reportUID: reportUID
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ["personalAccessToken"];
+      var contentTypes = [];
+      var accepts = ["application/json"];
+      var returnType = _CancelJobRun200Response["default"];
+      return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/jobs/runs/{reportUID}/cancel", "POST", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Cancel a running job execution
+     * @param {String} projectOrProductUID
+     * @param {String} reportUID Unique identifier for a job run report
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CancelJobRun200Response}
+     */
+  }, {
+    key: "cancelJobRun",
+    value: function cancelJobRun(projectOrProductUID, reportUID) {
+      return this.cancelJobRunWithHttpInfo(projectOrProductUID, reportUID).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
+    /**
+     * Create a new batch job with an optional name
+     * @param {String} projectOrProductUID
+     * @param {String} name Name for the job
+     * @param {Object.<String, Object>} body The job definition as raw JSON
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/CreateJob201Response} and HTTP response
+     */
+  }, {
+    key: "createJobWithHttpInfo",
+    value: function createJobWithHttpInfo(projectOrProductUID, name, body) {
+      var postBody = body;
+      // verify the required parameter 'projectOrProductUID' is set
+      if (projectOrProductUID === undefined || projectOrProductUID === null) {
+        throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling createJob");
+      }
+      // verify the required parameter 'name' is set
+      if (name === undefined || name === null) {
+        throw new _Error["default"]("Missing the required parameter 'name' when calling createJob");
+      }
+      // verify the required parameter 'body' is set
+      if (body === undefined || body === null) {
+        throw new _Error["default"]("Missing the required parameter 'body' when calling createJob");
+      }
+      var pathParams = {
+        projectOrProductUID: projectOrProductUID
+      };
+      var queryParams = {
+        name: name
+      };
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ["personalAccessToken"];
+      var contentTypes = ["application/json"];
+      var accepts = ["application/json"];
+      var returnType = _CreateJob201Response["default"];
+      return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/jobs", "POST", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Create a new batch job with an optional name
+     * @param {String} projectOrProductUID
+     * @param {String} name Name for the job
+     * @param {Object.<String, Object>} body The job definition as raw JSON
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/CreateJob201Response}
+     */
+  }, {
+    key: "createJob",
+    value: function createJob(projectOrProductUID, name, body) {
+      return this.createJobWithHttpInfo(projectOrProductUID, name, body).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
+    /**
+     * Delete a batch job
+     * @param {String} projectOrProductUID
+     * @param {String} jobUID Unique identifier for a batch job
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/DeleteJob200Response} and HTTP response
+     */
+  }, {
+    key: "deleteJobWithHttpInfo",
+    value: function deleteJobWithHttpInfo(projectOrProductUID, jobUID) {
+      var postBody = null;
+      // verify the required parameter 'projectOrProductUID' is set
+      if (projectOrProductUID === undefined || projectOrProductUID === null) {
+        throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling deleteJob");
+      }
+      // verify the required parameter 'jobUID' is set
+      if (jobUID === undefined || jobUID === null) {
+        throw new _Error["default"]("Missing the required parameter 'jobUID' when calling deleteJob");
+      }
+      var pathParams = {
+        projectOrProductUID: projectOrProductUID,
+        jobUID: jobUID
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ["personalAccessToken"];
+      var contentTypes = [];
+      var accepts = ["application/json"];
+      var returnType = _DeleteJob200Response["default"];
+      return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/jobs/{jobUID}", "DELETE", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Delete a batch job
+     * @param {String} projectOrProductUID
+     * @param {String} jobUID Unique identifier for a batch job
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/DeleteJob200Response}
+     */
+  }, {
+    key: "deleteJob",
+    value: function deleteJob(projectOrProductUID, jobUID) {
+      return this.deleteJobWithHttpInfo(projectOrProductUID, jobUID).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
+    /**
+     * Get a specific batch job definition
+     * @param {String} projectOrProductUID
+     * @param {String} jobUID Unique identifier for a batch job
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Job} and HTTP response
+     */
+  }, {
+    key: "getJobWithHttpInfo",
+    value: function getJobWithHttpInfo(projectOrProductUID, jobUID) {
+      var postBody = null;
+      // verify the required parameter 'projectOrProductUID' is set
+      if (projectOrProductUID === undefined || projectOrProductUID === null) {
+        throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling getJob");
+      }
+      // verify the required parameter 'jobUID' is set
+      if (jobUID === undefined || jobUID === null) {
+        throw new _Error["default"]("Missing the required parameter 'jobUID' when calling getJob");
+      }
+      var pathParams = {
+        projectOrProductUID: projectOrProductUID,
+        jobUID: jobUID
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ["personalAccessToken"];
+      var contentTypes = [];
+      var accepts = ["application/json"];
+      var returnType = _Job["default"];
+      return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/jobs/{jobUID}", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Get a specific batch job definition
+     * @param {String} projectOrProductUID
+     * @param {String} jobUID Unique identifier for a batch job
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Job}
+     */
+  }, {
+    key: "getJob",
+    value: function getJob(projectOrProductUID, jobUID) {
+      return this.getJobWithHttpInfo(projectOrProductUID, jobUID).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
+    /**
+     * Get the result of a job execution
+     * @param {String} projectOrProductUID
+     * @param {String} reportUID Unique identifier for a job run report
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/JobRun} and HTTP response
+     */
+  }, {
+    key: "getJobRunWithHttpInfo",
+    value: function getJobRunWithHttpInfo(projectOrProductUID, reportUID) {
+      var postBody = null;
+      // verify the required parameter 'projectOrProductUID' is set
+      if (projectOrProductUID === undefined || projectOrProductUID === null) {
+        throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling getJobRun");
+      }
+      // verify the required parameter 'reportUID' is set
+      if (reportUID === undefined || reportUID === null) {
+        throw new _Error["default"]("Missing the required parameter 'reportUID' when calling getJobRun");
+      }
+      var pathParams = {
+        projectOrProductUID: projectOrProductUID,
+        reportUID: reportUID
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ["personalAccessToken"];
+      var contentTypes = [];
+      var accepts = ["application/json"];
+      var returnType = _JobRun["default"];
+      return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/jobs/runs/{reportUID}", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Get the result of a job execution
+     * @param {String} projectOrProductUID
+     * @param {String} reportUID Unique identifier for a job run report
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/JobRun}
+     */
+  }, {
+    key: "getJobRun",
+    value: function getJobRun(projectOrProductUID, reportUID) {
+      return this.getJobRunWithHttpInfo(projectOrProductUID, reportUID).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
+    /**
+     * List all runs for a specific job
+     * @param {String} projectOrProductUID
+     * @param {String} jobUID Unique identifier for a batch job
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.status Filter runs by status
+     * @param {Boolean} opts.dryRun Filter runs by dry run flag
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetJobRuns200Response} and HTTP response
+     */
+  }, {
+    key: "getJobRunsWithHttpInfo",
+    value: function getJobRunsWithHttpInfo(projectOrProductUID, jobUID, opts) {
+      opts = opts || {};
+      var postBody = null;
+      // verify the required parameter 'projectOrProductUID' is set
+      if (projectOrProductUID === undefined || projectOrProductUID === null) {
+        throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling getJobRuns");
+      }
+      // verify the required parameter 'jobUID' is set
+      if (jobUID === undefined || jobUID === null) {
+        throw new _Error["default"]("Missing the required parameter 'jobUID' when calling getJobRuns");
+      }
+      var pathParams = {
+        projectOrProductUID: projectOrProductUID,
+        jobUID: jobUID
+      };
+      var queryParams = {
+        status: opts["status"],
+        dry_run: opts["dryRun"]
+      };
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ["personalAccessToken"];
+      var contentTypes = [];
+      var accepts = ["application/json"];
+      var returnType = _GetJobRuns200Response["default"];
+      return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/jobs/{jobUID}/runs", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * List all runs for a specific job
+     * @param {String} projectOrProductUID
+     * @param {String} jobUID Unique identifier for a batch job
+     * @param {Object} opts Optional parameters
+     * @param {String} opts.status Filter runs by status
+     * @param {Boolean} opts.dryRun Filter runs by dry run flag
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetJobRuns200Response}
+     */
+  }, {
+    key: "getJobRuns",
+    value: function getJobRuns(projectOrProductUID, jobUID, opts) {
+      return this.getJobRunsWithHttpInfo(projectOrProductUID, jobUID, opts).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
+    /**
+     * List all batch jobs for a project
+     * @param {String} projectOrProductUID
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/GetJobs200Response} and HTTP response
+     */
+  }, {
+    key: "getJobsWithHttpInfo",
+    value: function getJobsWithHttpInfo(projectOrProductUID) {
+      var postBody = null;
+      // verify the required parameter 'projectOrProductUID' is set
+      if (projectOrProductUID === undefined || projectOrProductUID === null) {
+        throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling getJobs");
+      }
+      var pathParams = {
+        projectOrProductUID: projectOrProductUID
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ["personalAccessToken"];
+      var contentTypes = [];
+      var accepts = ["application/json"];
+      var returnType = _GetJobs200Response["default"];
+      return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/jobs", "GET", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * List all batch jobs for a project
+     * @param {String} projectOrProductUID
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetJobs200Response}
+     */
+  }, {
+    key: "getJobs",
+    value: function getJobs(projectOrProductUID) {
+      return this.getJobsWithHttpInfo(projectOrProductUID).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
+    /**
+     * Execute a batch job
+     * @param {String} projectOrProductUID
+     * @param {String} jobUID Unique identifier for a batch job
+     * @param {Object} opts Optional parameters
+     * @param {Boolean} opts.dryRun Run job in dry-run mode without making actual changes (default to false)
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/RunJob200Response} and HTTP response
+     */
+  }, {
+    key: "runJobWithHttpInfo",
+    value: function runJobWithHttpInfo(projectOrProductUID, jobUID, opts) {
+      opts = opts || {};
+      var postBody = null;
+      // verify the required parameter 'projectOrProductUID' is set
+      if (projectOrProductUID === undefined || projectOrProductUID === null) {
+        throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling runJob");
+      }
+      // verify the required parameter 'jobUID' is set
+      if (jobUID === undefined || jobUID === null) {
+        throw new _Error["default"]("Missing the required parameter 'jobUID' when calling runJob");
+      }
+      var pathParams = {
+        projectOrProductUID: projectOrProductUID,
+        jobUID: jobUID
+      };
+      var queryParams = {
+        dry_run: opts["dryRun"]
+      };
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ["personalAccessToken"];
+      var contentTypes = [];
+      var accepts = ["application/json"];
+      var returnType = _RunJob200Response["default"];
+      return this.apiClient.callApi("/v1/projects/{projectOrProductUID}/jobs/{jobUID}/run", "POST", pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Execute a batch job
+     * @param {String} projectOrProductUID
+     * @param {String} jobUID Unique identifier for a batch job
+     * @param {Object} opts Optional parameters
+     * @param {Boolean} opts.dryRun Run job in dry-run mode without making actual changes (default to false)
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/RunJob200Response}
+     */
+  }, {
+    key: "runJob",
+    value: function runJob(projectOrProductUID, jobUID, opts) {
+      return this.runJobWithHttpInfo(projectOrProductUID, jobUID, opts).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+  }]);
+}();