Merge pull request #164 from renderforest/lower-third-settigns

lower-third-settings-and-refactor

Author: narekhovhannisyan

README.md

@@ -0,0 +1,198 @@
+## Projects API
+
+  - [Get All Projects](#get-all-projects)
+  - [Add Project](#add-project)
+  - [Get Trial Project](#get-trial-project)
+  - [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)
+
+### Get All Projects
+
+Retrieves the projects.
+```js
+const RenderforestClient = require('@renderforest/sdk-node')
+
+const Renderforest = new RenderforestClient({ signKey: '<signKey>', clientId: -1 })
+
+Renderforest.getProjects({
+  limit: 2,
+  offset: 10,
+  includeApiProjects: false,
+  order: 'DESC',
+  orderBy: 'order',
+  search: ''
+})
+  .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/samples/projects/get-projects.js)
+
+
+### Add Project
+
+Creates a project.
+```js
+const RenderforestClient = require('@renderforest/sdk-node')
+
+const Renderforest = new RenderforestClient({ signKey: '<signKey>', clientId: -1 })
+
+Renderforest.addProject(701)
+  .then(console.log) // handle the success
+  .catch(console.error) // handle the error
+```
+- Also, project-data is created with the following list of initial properties: 
+  templateId, title, duration, equalizer, isLego, extendableScreens, fps, projectVersion, screens, muteMusic, 
+  currentScreenId, projectColors (optional), themeVariableName (optional), themeVariableValue (optional).
+
+
+- The "muteMusic" is false initially. 
+- If template is lego ("isLego": true), then no initial screen is added and "screens" defaults to []. Otherwise, at least one screen is present. 
+- The "currentScreenId" is the id of the first screen for non-lego templates & null for lego templates. 
+- The "projectColors" is optional and gets value if the template has default colors. Both lego & non-lego templates might have default colors.
+- Both "themeVariableName" & "themeVariableValue" are optional and are added (both) if template has theme. Both lego & non-lego templates might have a theme. 
+
+[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/projects/add-project.js)
+
+
+### Get Trial Project
+
+This endpoint retrieves a trial project. Designed to allow the user to make a project (trial - without saving) before
+ getting logged in to get an overall idea.
+The data can be used later to create real project (create project, update project-data with this data).
+
+_No authorization is required for this endpoint._
+```js
+const RenderforestClient = require('@renderforest/sdk-node')
+
+RenderforestClient.getTrialProject(701)
+  .then(console.log) // handle the success
+  .catch(console.error) // handle the error
+
+```
+[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/projects/get-trial-project.js)
+
+
+### Get a Specific Project
+
+Gets a specific project.
+```js
+const RenderforestClient = require('@renderforest/sdk-node')
+
+const Renderforest = new RenderforestClient({ signKey: '<signKey>', clientId: -1 })
+
+Renderforest.getProject(5000295)
+  .then(console.log) // handle the success
+  .catch(console.error) // handle the error
+```
+[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/projects/get-project.js)
+
+
+### Update the Project - partial update
+
+Updates the project (partial update).
+```js
+const RenderforestClient = require('@renderforest/sdk-node')
+
+const Renderforest = new RenderforestClient({ signKey: '<signKey>', clientId: -1 })
+
+Renderforest.updateProjectPartial(5000658, { customTitle: 'Graduation' })
+  .then(console.log) // handle the success
+  .catch(console.error) // handle the error
+```
+[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/projects/update-project-partial.js)
+
+
+### Delete a Specific Project
+
+Deletes a specific project.
+```js
+const RenderforestClient = require('@renderforest/sdk-node')
+
+const Renderforest = new RenderforestClient({ signKey: '<signKey>', clientId: -1 })
+
+Renderforest.deleteProject(5000658)
+  .then(console.log) // handle the success
+  .catch(console.error) // handle the error
+
+```
+[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/projects/delete-project.js)
+
+
+### Delete Specific Project Videos
+
+Deletes specific project videos. The quality parameter is optional.
+
+**IMPORTANT**: 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 RenderforestClient = require('@renderforest/sdk-node')
+
+const Renderforest = new RenderforestClient({ signKey: '<signKey>', clientId: -1 })
+
+Renderforest.deleteProjectVideos(4120385, 360)
+  .then(console.log) // handle the success
+  .catch(console.error) // handle the error
+```
+[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/projects/delete-project-videos.js)
+
+
+### Apply Template Preset on the Project
+
+Applies template preset on the project.
+```js
+const RenderforestClient = require('@renderforest/sdk-node')
+
+const Renderforest = new RenderforestClient({ signKey: '<signKey>', clientId: -1 })
+
+Renderforest.applyTemplatePresetOnProject(5000658, 55)
+  .then(console.log) // handle the success
+  .catch(console.error) // handle the error
+```
+[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/projects/apply-template-preset-on-project.js)
+
+
+### Duplicate the Project
+
+Duplicates the project.
+```js
+const RenderforestClient = require('@renderforest/sdk-node')
+
+const Renderforest = new RenderforestClient({ signKey: '<signKey>', clientId: -1 })
+
+Renderforest.duplicateProject(5000658)
+  .then(console.log) // handle the success
+  .catch(console.error) // handle the error
+```
+[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/projects/duplicate-project.js)
+
+
+### Render the Project
+
+Renders the project with given quality. The possible values for the quality are: 0, 360, 720, and 1080. 
+The watermark parameter is optional, must be in '.png' file format and have canvas size of 1920 x 1080 pixels,
+url length must not exceed 250 characters.
+
+```js
+const RenderforestClient = require('@renderforest/sdk-node')
+
+const Renderforest = new RenderforestClient({ signKey: '<signKey>', clientId: -1 })
+
+Renderforest.renderProject(4120385, { quality: 360, watermark: 'https://example.com/watermark.png' })
+  .then(console.log) // handle the success
+  .catch(console.error) // handle the error
+
+```
+- The possible values of the quality are: 0, 360, 720, and 1080.
+
+[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/projects/render-project.js)
+
+**[⬆ back to the top](#projects-api)**

docs/PROJECTS_API.md

@@ -0,0 +1,68 @@
+## Sounds API
+
+  - [Get All Sounds](#get-all-sounds)
+  - [Get Recommended Sounds](#get-recommended-sounds)
+
+### Get All Sounds
+
+Retrieves sounds given the duration.
+
+If the authorization is not present, then response limits to 5.
+```js
+const RenderforestClient = require('@renderforest/sdk-node')
+
+RenderforestClient.getCompanySoundsLimited({ duration: 4 })
+  .then(console.log) // handle the success
+  .catch(console.error) // handle the error
+```
+[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/sounds/get-company-sounds-limited.js)
+
+With authorization it's possible to fetch all sounds.
+
+```js
+const RenderforestClient = require('@renderforest/sdk-node')
+
+const Renderforest = new RenderforestClient({ signKey: '<signKey>', clientId: -1 })
+
+Renderforest.getSounds({ duration: 4 })
+  .then(console.log) // handle the success
+  .catch(console.error) // handle the error
+```
+- The sounds will have greater or equal duration to the specified one.
+- **Remember** — any given value of the duration greater than 180 will be overridden by 180!
+
+[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/sounds/get-sounds.js)
+
+
+### Get Recommended Sounds
+
+Retrieves recommended sounds for the given template.
+
+If the authorization is not present, then response limits to 5.
+ 
+```js
+const RenderforestClient = require('@renderforest/sdk-node')
+
+RenderforestClient.getRecommendedSoundsLimited(701, { duration: 5 })
+  .then(console.log) // handle the success
+  .catch(console.error) // handle the error
+```
+[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/sounds/get-recommended-sounds-limited.js)
+
+With authorization it's possible to fetch all recommended sounds.
+
+```js
+const RenderforestClient = require('@renderforest/sdk-node')
+
+const Renderforest = new RenderforestClient({ signKey: '<signKey>', clientId: -1 })
+
+Renderforest.getRecommendedSounds(701, { duration: 5 })
+  .then(console.log) // handle the success
+  .catch(console.error) // handle the error
+```
+- These sounds will have greater or equal duration to the specified one.
+- **Remember** — any given value of the duration greater than 180 will be overridden by 180!
+
+[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/sounds/get-recommended-sounds.js)
+
+**[⬆ back to the top](#sounds-api)**

docs/SOUNDS_API.md

@@ -0,0 +1,25 @@
+## Supports API
+
+  - [Add Supports Ticket](#add-supports-ticket)
+
+### Add Supports Ticket
+
+Creates supports ticket.
+```js
+const RenderforestClient = require('@renderforest/sdk-node')
+
+const Renderforest = new RenderforestClient({ signKey: '<signKey>', clientId: -1 })
+
+Renderforest.addSupportsTicket({
+    message: 'I need to...',
+    mailType: 'Creative team',
+    subject: 'Some help in ..'
+  })
+  .then(console.log) // handle the success
+  .catch(console.error) // handle the error
+```
+- The possible values of ticket `mailType` are: 'Sales', 'Report a bug', 'Editing process', 'Creative team', 'Other'.
+
+[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/supports/add-supports-ticket.js)
+
+**[⬆ back to the top](#supports-api)**