Add deleted param to job

Author: Mechazawa

src/proxy/ResourceProxy.js

@@ -72,7 +72,7 @@ export default class ResourceProxy extends SimpleResourceProxy {
   /**
    * Get target resource
    * @param {Number|String|Object} [id=] - The resource id to be requested
-   * @param {String} deleted - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
+   * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    * @returns {Promise<ResourceBase>} - Target resource
    * @throws {ApiError}
    */

src/resources/Job.js

@@ -35,6 +35,8 @@ import DownloadedResource from './base/DownloadedResource';
 import CrudBase from './base/CrudBase';
 import JobResult from './JobResult';
 import JobRevision from './JobRevision';
+import RequestParameters from '../RequestParameters';
+import { encodeQueryString } from '../utils/requests';
 
 export default class Job extends CrudBase {
   /**
@@ -94,10 +96,11 @@ export default class Job extends CrudBase {
 
   /**
    * Download the job preview
+   * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    * @returns {Promise<DownloadedResource>} - Job result preview
    */
-  async downloadPreview () {
-    const response = await this.api.axios.get(this.previewUrl, {
+  async downloadPreview (deleted = RequestParameters.deleted) {
+    const response = await this.api.axios.get(`${this.previewUrl}?${encodeQueryString({ deleted })}`, {
       responseType: 'arraybuffer',
     });
 
@@ -106,10 +109,11 @@ export default class Job extends CrudBase {
 
   /**
    * Get archive blob url
+   * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    * @returns {Promise<DownloadedResource>} - Job result output
    */
-  async downloadOutput () {
-    const response = await this.api.axios.get(this.lastArchiveUrl, {
+  async downloadOutput (deleted = RequestParameters.deleted) {
+    const response = await this.api.axios.get(`${this.lastArchiveUrl}?${encodeQueryString({ deleted })}`, {
       responseType: 'arraybuffer',
     });
 
@@ -118,11 +122,12 @@ export default class Job extends CrudBase {
 
   /**
    * Get the remote output url
+   * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    * @returns {Promise<string>} - The url to the output
    * @throws {ApiError}
    */
-  async getOutputUrl () {
-    const { data: { data } } = await this.api.axios.get(`${this.url}/output-url`);
+  async getOutputUrl (deleted = RequestParameters.deleted) {
+    const { data: { data } } = await this.api.axios.get(`${this.url}/output-url?${encodeQueryString({ deleted })}`);
 
     return data.url;
   }

src/resources/JobResult.js

@@ -70,7 +70,7 @@ export default class JobResult extends ResourceBase {
 
   /**
    * Get archive blob url
-   * @param {String} deleted - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
+   * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    * @returns {Promise<DownloadedResource>} - Job result output
    */
   async downloadOutput (deleted = RequestParameters.deleted) {
@@ -91,7 +91,7 @@ export default class JobResult extends ResourceBase {
 
   /**
    * Get the remote output url
-   * @param {String} deleted - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
+   * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    * @returns {Promise<string>} - The url to the output
    * @throws {ApiError}
    */
@@ -111,7 +111,7 @@ export default class JobResult extends ResourceBase {
 
   /**
    * Download the job result log
-   * @param {String} deleted - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
+   * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    * @returns {Promise<DownloadedResource>} - job result log
    */
   async downloadLog (deleted = RequestParameters.deleted) {
@@ -132,7 +132,7 @@ export default class JobResult extends ResourceBase {
 
   /**
    * Download the job preview
-   * @param {String} deleted - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
+   * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    * @returns {Promise<DownloadedResource>} - Job result preview
    */
   async downloadPreview (deleted = RequestParameters.deleted) {
@@ -148,7 +148,7 @@ export default class JobResult extends ResourceBase {
    * This method is for internal use for our support team.
    *
    * @param {boolean} [value=true] - What to set the dealt-with value to
-   * @param {String} deleted - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
+   * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    */
   async dealWith (value = true, deleted = RequestParameters.deleted) {
     value = Boolean(value);

src/resources/JobRevision.js

@@ -65,7 +65,7 @@ export default class JobRevision extends CrudBase {
 
   /**
    * Get the job result
-   * @param {String} deleted - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
+   * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    * @returns {Promise<JobResult>} - The associated job result
    * @throws {ApiError}
    */
@@ -97,7 +97,7 @@ export default class JobRevision extends CrudBase {
    * Save updated job revision
    * @param {Object} object - Map object
    * @param {Array<Layer>|Array<Number>|null} layers - Array containing all layers for this revision. If set to null the same layers will be used
-   * @param {String} deleted - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
+   * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    * @returns {Promise<JobRevision>} - New job revision
    * @throws {TypeError}
    * @throws {ApiError}
@@ -128,7 +128,7 @@ export default class JobRevision extends CrudBase {
 
   /**
    * Get job object
-   * @param {String} deleted - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
+   * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    * @returns {Promise<Object>} - The map object
    * @throws {ApiError}
    * @todo document object format
@@ -142,7 +142,7 @@ export default class JobRevision extends CrudBase {
   /**
    * Build the revision
    * @param {String} callbackUrl - Optional callback url for when the job completes
-   * @param {String} deleted - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
+   * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    * @throws {ApiError}
    */
   async build (callbackUrl, deleted = RequestParameters.deleted) {
@@ -151,7 +151,7 @@ export default class JobRevision extends CrudBase {
 
   /**
    * Cancels a running job
-   * @param {String} deleted - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
+   * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    */
   async cancel (deleted = RequestParameters.deleted) {
     await this.api.axios.post(`${this.url}/cancel?${encodeQueryString({ deleted })}`);
@@ -160,7 +160,7 @@ export default class JobRevision extends CrudBase {
   /**
    * Share the job revision
    * @param {String} visibility - See {@link JobShareVisibility}, either `private` or `organisation`
-   * @param {String} deleted - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
+   * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    * @returns {Promise<String>} - the share link
    * @throws {ApiError}
    */
@@ -180,7 +180,7 @@ export default class JobRevision extends CrudBase {
   // noinspection JSCheckFunctionSignatures
   /**
    * Clones a job revision to the user requesting it
-   * @param {String} deleted - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
+   * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    * @throws {ApiError}
    */
   async clone (deleted = RequestParameters.deleted) {