Merge pull request #147 from renderforest/update-routes

Update endpoints

Author: narekhovhannisyan

README.md

@@ -18,6 +18,7 @@ Welcome to the Renderforest API! You can use our API to:
   - [Get a Specific Project](#get-a-specific-project)
   - [Update the Project - partial update](#update-the-project---partial-update)
   - [Delete a Specific Project](#delete-a-specific-project)
+  - [Delete Specific Project Videos](#delete-specific-project-videos)
   - [Apply Template Preset on the Project](#apply-template-preset-on-the-project)
   - [Duplicate the Project](#duplicate-the-project)
   - [Render the Project](#render-the-project)
@@ -204,6 +205,25 @@ renderforest.deleteProject(payload)
 [See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/examples/projects/delete-project.js)
 
 
+### Delete Specific Project Videos
+
+Deletes specific project videos.
+The quality parameter is optional. If you want to delete only a single quality video, you have to specify quality parameter, otherwise all quality videos of the project will be deleted.
+```js
+const Renderforest = require('@renderforest/sdk-node')
+
+const renderforest = new Renderforest({ signKey: '<signKey>', clientId: -1 })
+
+const payload = {
+  projectId: 5000658,
+  quality: 360
+}
+renderforest.deleteProjectVideos(payload)
+  .then(console.log) // handle the success
+  .catch(console.error) // handle the error
+```
+[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/examples/projects/delete-project-videos.js)
+
 ### Apply Template Preset on the Project
 
 Applies template preset on the project.

examples/projects/delete-project-videos.js

@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) 2018-present, Renderforest, LLC.
+ * All rights reserved.
+ *
+ * This source code is licensed under the license found in the
+ * LICENSE file in the root directory.
+ */
+
+const Renderforest = require('../../src/lib/renderforest')
+
+const renderforest = new Renderforest({ signKey: '<signKey>', clientId: -1 })
+
+const payload = {
+  projectId: 5000658,
+  quality: 360
+}
+renderforest.deleteProjectVideos(payload)
+  .then(console.log) // handle the success
+  .catch(console.error) // handle the error

examples/projects/render-project.js

@@ -12,7 +12,8 @@ const renderforest = new Renderforest({ signKey: '<signKey>', clientId: -1 })
 
 const payload = {
   projectId: 5000658,
-  quality: 1080
+  quality: 360,
+  watermark: 'watermarkURL'
 }
 renderforest.renderProject(payload)
   .then(console.log) // handle the success

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@renderforest/sdk-node",
   "description": "Renderforest SDK for Node.js",
-  "version": "0.3.6",
+  "version": "0.3.7",
   "author": "RenderForest LLC",
   "bugs": {
     "url": "https://github.com/renderforest/renderforest-sdk-node/issues"

package.json

@@ -98,6 +98,15 @@ class Renderforest {
     return Projects.deleteProject(payload)
   }
 
+  /**
+   * @param {Object} payload
+   * @returns {Promise.<Object>}
+   * @description Delete Specific Project Videos.
+   */
+  deleteProjectVideos (payload) {
+    return Projects.deleteProjectVideos(payload)
+  }
+
   /**
    * @param {Object} payload
    * @returns {Promise.<Object>}

src/lib/renderforest.js

@@ -105,6 +105,22 @@ class Projects {
     return ApiRequest.authorizedRequest(options)
   }
 
+  /**
+   * @param {Object} payload
+   * @returns {Promise.<Object>}
+   * @description Delete Specific Project Videos.
+   */
+  static deleteProjectVideos (payload) {
+    const projectId = Params.destructURLParam(payload, 'projectId')
+    const quality = Params.destructOptionalURLParam(payload, 'quality')
+
+    const options = {
+      method: 'DELETE',
+      endpoint: `${API_PREFIX}/projects/${projectId}/videos/${quality}`
+    }
+    return ApiRequest.authorizedRequest(options)
+  }
+
   /**
    * @param {Object} payload
    * @returns {Promise.<Object>}
@@ -143,7 +159,7 @@ class Projects {
    * @description Render the Project.
    */
   static renderProject (payload) {
-    const body = Params.destructParams(payload, ['quality'])
+    const body = Params.destructParams(payload, ['quality', 'watermark'])
     const projectId = Params.destructURLParam(payload, 'projectId')
 
     const options = {

src/lib/resources/projects.js

@@ -43,6 +43,24 @@ class Params {
 
     return payload[param]
   }
+
+  /**
+   * @param {Object} payload
+   * @param {string} param
+   * @returns {number|string}
+   * @throws RenderforestError
+   * @description Destruct optional URL param from the payload.
+   */
+  static destructOptionalURLParam (payload, param) {
+    if (!payload || !Object.keys(payload).length) {
+      throw new RenderforestError(`No parameter specified`)
+    }
+    if (payload[param] === undefined) {
+      return ''
+    }
+
+    return payload[param]
+  }
 }
 
 module.exports = Params