@blues-inc/notehub-js 6.2.0-beta.46 → 6.2.0-beta.48

package/dist/api/JobsApi.js

@@ -11,7 +11,8 @@ var _DeleteJob200Response = _interopRequireDefault(require("../model/DeleteJob20
 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 _JobDefinition = _interopRequireDefault(require("../model/JobDefinition"));
+var _JobDetail = _interopRequireDefault(require("../model/JobDetail"));
 var _JobRun = _interopRequireDefault(require("../model/JobRun"));
 var _RunJob200Response = _interopRequireDefault(require("../model/RunJob200Response"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
@@ -22,7 +23,7 @@ function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r),
 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 OpenAPI definition for the Notehub.io API. 
  *
  * The version of the OpenAPI document: 1.2.0
  * Contact: engineering@blues.io
@@ -33,18 +34,18 @@ function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e
  *
  */
 /**
- * Jobs service.
- * @module api/JobsApi
- * @version 6.2.0-beta.46
- */
+* Jobs service.
+* @module api/JobsApi
+* @version 6.2.0-beta.48
+*/
 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.
-   */
+  * 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;
@@ -52,7 +53,7 @@ var JobsApi = exports["default"] = /*#__PURE__*/function () {
 
   /**
    * Cancel a running job execution
-   * @param {String} projectOrProductUID
+   * @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
    */
@@ -69,22 +70,22 @@ var JobsApi = exports["default"] = /*#__PURE__*/function () {
         throw new _Error["default"]("Missing the required parameter 'reportUID' when calling cancelJobRun");
       }
       var pathParams = {
-        projectOrProductUID: projectOrProductUID,
-        reportUID: reportUID
+        'projectOrProductUID': projectOrProductUID,
+        'reportUID': reportUID
       };
       var queryParams = {};
       var headerParams = {};
       var formParams = {};
-      var authNames = ["personalAccessToken"];
+      var authNames = ['personalAccessToken'];
       var contentTypes = [];
-      var accepts = ["application/json"];
+      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);
+      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} 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}
      */
@@ -98,15 +99,15 @@ var JobsApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Create a new batch job with an optional name
-     * @param {String} projectOrProductUID
+     * @param {String} projectOrProductUID 
      * @param {String} name Name for the job
-     * @param {Object.<String, Object>} body The job definition as raw JSON
+     * @param {module:model/JobDefinition} jobDefinition The batch job definition
      * @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;
+    value: function createJobWithHttpInfo(projectOrProductUID, name, jobDefinition) {
+      var postBody = jobDefinition;
       // verify the required parameter 'projectOrProductUID' is set
       if (projectOrProductUID === undefined || projectOrProductUID === null) {
         throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling createJob");
@@ -115,43 +116,43 @@ var JobsApi = exports["default"] = /*#__PURE__*/function () {
       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");
+      // verify the required parameter 'jobDefinition' is set
+      if (jobDefinition === undefined || jobDefinition === null) {
+        throw new _Error["default"]("Missing the required parameter 'jobDefinition' when calling createJob");
       }
       var pathParams = {
-        projectOrProductUID: projectOrProductUID
+        'projectOrProductUID': projectOrProductUID
       };
       var queryParams = {
-        name: name
+        'name': name
       };
       var headerParams = {};
       var formParams = {};
-      var authNames = ["personalAccessToken"];
-      var contentTypes = ["application/json"];
-      var accepts = ["application/json"];
+      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);
+      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} projectOrProductUID 
      * @param {String} name Name for the job
-     * @param {Object.<String, Object>} body The job definition as raw JSON
+     * @param {module:model/JobDefinition} jobDefinition The batch job definition
      * @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) {
+    value: function createJob(projectOrProductUID, name, jobDefinition) {
+      return this.createJobWithHttpInfo(projectOrProductUID, name, jobDefinition).then(function (response_and_data) {
         return response_and_data.data;
       });
     }
 
     /**
      * Delete a batch job
-     * @param {String} projectOrProductUID
+     * @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
      */
@@ -168,22 +169,22 @@ var JobsApi = exports["default"] = /*#__PURE__*/function () {
         throw new _Error["default"]("Missing the required parameter 'jobUID' when calling deleteJob");
       }
       var pathParams = {
-        projectOrProductUID: projectOrProductUID,
-        jobUID: jobUID
+        'projectOrProductUID': projectOrProductUID,
+        'jobUID': jobUID
       };
       var queryParams = {};
       var headerParams = {};
       var formParams = {};
-      var authNames = ["personalAccessToken"];
+      var authNames = ['personalAccessToken'];
       var contentTypes = [];
-      var accepts = ["application/json"];
+      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);
+      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} 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}
      */
@@ -195,11 +196,57 @@ var JobsApi = exports["default"] = /*#__PURE__*/function () {
       });
     }
 
+    /**
+     * Delete the results of a job run
+     * @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 HTTP response
+     */
+  }, {
+    key: "deleteJobRunWithHttpInfo",
+    value: function deleteJobRunWithHttpInfo(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 deleteJobRun");
+      }
+      // verify the required parameter 'reportUID' is set
+      if (reportUID === undefined || reportUID === null) {
+        throw new _Error["default"]("Missing the required parameter 'reportUID' when calling deleteJobRun");
+      }
+      var pathParams = {
+        'projectOrProductUID': projectOrProductUID,
+        'reportUID': reportUID
+      };
+      var queryParams = {};
+      var headerParams = {};
+      var formParams = {};
+      var authNames = ['personalAccessToken'];
+      var contentTypes = [];
+      var accepts = ['application/json'];
+      var returnType = null;
+      return this.apiClient.callApi('/v1/projects/{projectOrProductUID}/jobs/runs/{reportUID}', 'DELETE', pathParams, queryParams, headerParams, formParams, postBody, authNames, contentTypes, accepts, returnType, null);
+    }
+
+    /**
+     * Delete the results of a job run
+     * @param {String} projectOrProductUID 
+     * @param {String} reportUID Unique identifier for a job run report
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}
+     */
+  }, {
+    key: "deleteJobRun",
+    value: function deleteJobRun(projectOrProductUID, reportUID) {
+      return this.deleteJobRunWithHttpInfo(projectOrProductUID, reportUID).then(function (response_and_data) {
+        return response_and_data.data;
+      });
+    }
+
     /**
      * Get a specific batch job definition
-     * @param {String} projectOrProductUID
+     * @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
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/JobDetail} and HTTP response
      */
   }, {
     key: "getJobWithHttpInfo",
@@ -214,24 +261,24 @@ var JobsApi = exports["default"] = /*#__PURE__*/function () {
         throw new _Error["default"]("Missing the required parameter 'jobUID' when calling getJob");
       }
       var pathParams = {
-        projectOrProductUID: projectOrProductUID,
-        jobUID: jobUID
+        'projectOrProductUID': projectOrProductUID,
+        'jobUID': jobUID
       };
       var queryParams = {};
       var headerParams = {};
       var formParams = {};
-      var authNames = ["personalAccessToken"];
+      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);
+      var accepts = ['application/json'];
+      var returnType = _JobDetail["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} 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}
+     * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/JobDetail}
      */
   }, {
     key: "getJob",
@@ -243,13 +290,16 @@ var JobsApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Get the result of a job execution
-     * @param {String} projectOrProductUID
+     * @param {String} projectOrProductUID 
      * @param {String} reportUID Unique identifier for a job run report
+     * @param {Object} opts Optional parameters
+     * @param {module:model/String} opts.view Controls the level of detail returned: 'summary' returns metadata only, 'detail' returns the full result payload (default to 'summary')
      * @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) {
+    value: function getJobRunWithHttpInfo(projectOrProductUID, reportUID, opts) {
+      opts = opts || {};
       var postBody = null;
       // verify the required parameter 'projectOrProductUID' is set
       if (projectOrProductUID === undefined || projectOrProductUID === null) {
@@ -260,36 +310,40 @@ var JobsApi = exports["default"] = /*#__PURE__*/function () {
         throw new _Error["default"]("Missing the required parameter 'reportUID' when calling getJobRun");
       }
       var pathParams = {
-        projectOrProductUID: projectOrProductUID,
-        reportUID: reportUID
+        'projectOrProductUID': projectOrProductUID,
+        'reportUID': reportUID
+      };
+      var queryParams = {
+        'view': opts['view']
       };
-      var queryParams = {};
       var headerParams = {};
       var formParams = {};
-      var authNames = ["personalAccessToken"];
+      var authNames = ['personalAccessToken'];
       var contentTypes = [];
-      var accepts = ["application/json"];
+      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);
+      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} projectOrProductUID 
      * @param {String} reportUID Unique identifier for a job run report
+     * @param {Object} opts Optional parameters
+     * @param {module:model/String} opts.view Controls the level of detail returned: 'summary' returns metadata only, 'detail' returns the full result payload (default to 'summary')
      * @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) {
+    value: function getJobRun(projectOrProductUID, reportUID, opts) {
+      return this.getJobRunWithHttpInfo(projectOrProductUID, reportUID, opts).then(function (response_and_data) {
         return response_and_data.data;
       });
     }
 
     /**
      * List all runs for a specific job
-     * @param {String} projectOrProductUID
+     * @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
@@ -310,25 +364,25 @@ var JobsApi = exports["default"] = /*#__PURE__*/function () {
         throw new _Error["default"]("Missing the required parameter 'jobUID' when calling getJobRuns");
       }
       var pathParams = {
-        projectOrProductUID: projectOrProductUID,
-        jobUID: jobUID
+        'projectOrProductUID': projectOrProductUID,
+        'jobUID': jobUID
       };
       var queryParams = {
-        status: opts["status"],
-        dry_run: opts["dryRun"]
+        'status': opts['status'],
+        'dry_run': opts['dryRun']
       };
       var headerParams = {};
       var formParams = {};
-      var authNames = ["personalAccessToken"];
+      var authNames = ['personalAccessToken'];
       var contentTypes = [];
-      var accepts = ["application/json"];
+      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);
+      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} projectOrProductUID 
      * @param {String} jobUID Unique identifier for a batch job
      * @param {Object} opts Optional parameters
      * @param {String} opts.status Filter runs by status
@@ -345,7 +399,7 @@ var JobsApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * List all batch jobs for a project
-     * @param {String} projectOrProductUID
+     * @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
      */
   }, {
@@ -357,21 +411,21 @@ var JobsApi = exports["default"] = /*#__PURE__*/function () {
         throw new _Error["default"]("Missing the required parameter 'projectOrProductUID' when calling getJobs");
       }
       var pathParams = {
-        projectOrProductUID: projectOrProductUID
+        'projectOrProductUID': projectOrProductUID
       };
       var queryParams = {};
       var headerParams = {};
       var formParams = {};
-      var authNames = ["personalAccessToken"];
+      var authNames = ['personalAccessToken'];
       var contentTypes = [];
-      var accepts = ["application/json"];
+      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);
+      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
+     * @param {String} projectOrProductUID 
      * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/GetJobs200Response}
      */
   }, {
@@ -384,7 +438,7 @@ var JobsApi = exports["default"] = /*#__PURE__*/function () {
 
     /**
      * Execute a batch job
-     * @param {String} projectOrProductUID
+     * @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)
@@ -404,24 +458,24 @@ var JobsApi = exports["default"] = /*#__PURE__*/function () {
         throw new _Error["default"]("Missing the required parameter 'jobUID' when calling runJob");
       }
       var pathParams = {
-        projectOrProductUID: projectOrProductUID,
-        jobUID: jobUID
+        'projectOrProductUID': projectOrProductUID,
+        'jobUID': jobUID
       };
       var queryParams = {
-        dry_run: opts["dryRun"]
+        'dry_run': opts['dryRun']
       };
       var headerParams = {};
       var formParams = {};
-      var authNames = ["personalAccessToken"];
+      var authNames = ['personalAccessToken'];
       var contentTypes = [];
-      var accepts = ["application/json"];
+      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);
+      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} 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)