Merge pull request #155 from renderforest/update-get-projects-params

Update get projects params

Author: narekhovhannisyan

README.md

@@ -90,13 +90,18 @@ const renderforest = new Renderforest({ signKey: '<signKey>', clientId: -1 })
 
 const payload = {
   limit: 2,
-  offset: 10
+  offset: 10,
+  includeApiProjects: false,
+  order: 'DESC', // possible options: 'DESC', 'ASC'
+  orderBy: 'order', // possible options: 'order', 'date'
+  search: '' // get projects with specified title
 }
 renderforest.getProjects(payload)
   .then(console.log) // handle the success
   .catch(console.error) // handle the error
 ```
 - The renderedQualities property is optional and present if the project is in renders queue (ongoing rend).
+- All the properties of `payload` object are optional.
 
 [See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/examples/projects/get-projects.js)
 

examples/projects/get-projects.js

@@ -12,7 +12,11 @@ const renderforest = new Renderforest({ signKey: '<signKey>', clientId: -1 })
 
 const payload = {
   limit: 2,
-  offset: 10
+  offset: 10,
+  includeApiProjects: false,
+  order: 'DESC',
+  orderBy: 'order',
+  search: ''
 }
 renderforest.getProjects(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.9",
+  "version": "0.3.10",
   "author": "RenderForest LLC",
   "bugs": {
     "url": "https://github.com/renderforest/renderforest-sdk-node/issues"

package.json

@@ -19,7 +19,8 @@ class Projects {
    * @description Get All Projects.
    */
   static getProjects (payload) {
-    const qs = Params.destructParams(payload, ['limit', 'offset'])
+    const qs = Params.destructParams(payload,
+      ['limit', 'offset', 'includeApiProjects', 'order', 'orderBy', 'search'])
 
     const options = {
       endpoint: `${API_PREFIX}/projects`,