Merge pull request #171 from renderforest/template-fonts

template-fonts

Author: narekhovhannisyan

README.md

@@ -9,13 +9,14 @@ Renderforest SDK for Node.js.
 
 Welcome to the Renderforest API! With our SDK you can use following resources:
 
-* [Projects](https://github.com/renderforest/renderforest-sdk-node/blob/master/docs/PROJECTS_API.md)
-* [Project-data](https://github.com/renderforest/renderforest-sdk-node/blob/master/docs/project-data-api/PROJECT_DATA_API.md)
-  - [Screens](https://github.com/renderforest/renderforest-sdk-node/blob/master/docs/project-data-api/SCREENS_API.md)
-  - [Areas](https://github.com/renderforest/renderforest-sdk-node/blob/master/docs/project-data-api/AREAS_API.md)
-* [Sounds](https://github.com/renderforest/renderforest-sdk-node/blob/master/docs/SOUNDS_API.md)
-* [Supports](https://github.com/renderforest/renderforest-sdk-node/blob/master/docs/SUPPORTS_API.md)
-* [Templates](https://github.com/renderforest/renderforest-sdk-node/blob/master/docs/TEMPLATES_API.md)
-* [Users](https://github.com/renderforest/renderforest-sdk-node/blob/master/docs/USERS_API.md)
+* [Fonts](docs/FONTS.md)
+* [Projects](docs/PROJECTS_API.md)
+* [Project-data](docs/project-data-api/PROJECT_DATA_API.md)
+  - [Screens](docs/project-data-api/SCREENS_API.md)
+  - [Areas](docs/project-data-api/AREAS_API.md)
+* [Sounds](docs/SOUNDS_API.md)
+* [Supports](docs/SUPPORTS_API.md)
+* [Templates](docs/TEMPLATES_API.md)
+* [Users](docs/USERS_API.md)
 
 #### [Renderforest SDK License Agreement](https://developers.renderforest.com/policy.html)

docs/FONTS.md

@@ -0,0 +1,34 @@
+## Fonts API
+
+  - [Get Template Available Fonts](#get-template-available-fonts)
+
+### Get template available fonts
+
+Retrieves template available fonts.
+```js
+const RenderforestClient = require('@renderforest/sdk-node')
+
+const Renderforest = new RenderforestClient({ signKey: '<signKey>', clientId: -1 })
+
+Renderforest.getTemplateAvailableFonts(1021)
+  .then(console.log) // handle the success
+  .catch(console.error) // handle the error
+```
+
+[See example](/samples/fonts/get-template-available-fonts.js)
+
+`getTemplateAvailabeFonts ` function returns an object containing all fonts. 
+The returned object has `getFontById ` method which accepts `fontId` parameter. 
+`getFontId` method returns flattened font.
+
+**Be careful**: `setFonts()` project data instance setter accepts only flattened font. 
+
+```js
+const primaryFont = fonts.getFontById(256) // returns flatten font with tuned character size
+```
+
+Now the flatten font can be used as parameter for `setFonts` setter in project data instance.
+
+[See setFonts() setter in project data](/docs/project-data-api/PROJECT_DATA_API.md#set-project-fonts)
+
+**[⬆ back to the top](#fonts-api)**

docs/PROJECTS_API.md

@@ -34,7 +34,7 @@ Renderforest.getProjects({
 - 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)
+[See example](/samples/projects/get-projects.js)
 
 
 ### Add Project
@@ -60,7 +60,7 @@ Renderforest.addProject(701)
 - 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)
+[See example](/samples/projects/add-project.js)
 
 
 ### Get Trial Project
@@ -78,7 +78,7 @@ RenderforestClient.getTrialProject(701)
   .catch(console.error) // handle the error
 
 ```
-[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/projects/get-trial-project.js)
+[See example](/samples/projects/get-trial-project.js)
 
 
 ### Get a Specific Project
@@ -93,7 +93,7 @@ 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)
+[See example](/samples/projects/get-project.js)
 
 
 ### Update the Project - partial update
@@ -108,7 +108,7 @@ 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)
+[See example](/samples/projects/update-project-partial.js)
 
 
 ### Delete a Specific Project
@@ -124,7 +124,7 @@ Renderforest.deleteProject(5000658)
   .catch(console.error) // handle the error
 
 ```
-[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/projects/delete-project.js)
+[See example](/samples/projects/delete-project.js)
 
 
 ### Delete Specific Project Videos
@@ -143,7 +143,7 @@ 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)
+[See example](/samples/projects/delete-project-videos.js)
 
 
 ### Apply Template Preset on the Project
@@ -158,7 +158,7 @@ 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)
+[See example](/samples/projects/apply-template-preset-on-project.js)
 
 
 ### Duplicate the Project
@@ -173,7 +173,7 @@ 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)
+[See example](/samples/projects/duplicate-project.js)
 
 
 ### Render the Project
@@ -194,7 +194,7 @@ Renderforest.renderProject(4120385, { quality: 360, watermark: 'https://example.
 ```
 - 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)
+[See example](/samples/projects/render-project.js)
 
 
 ### Get rendering status

docs/SOUNDS_API.md

@@ -15,7 +15,7 @@ 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)
+[See example](/samples/sounds/get-company-sounds-limited.js)
 
 With authorization it's possible to fetch all sounds.
 
@@ -31,7 +31,7 @@ Renderforest.getSounds({ duration: 4 })
 - 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)
+[See example](/samples/sounds/get-sounds.js)
 
 
 ### Get Recommended Sounds
@@ -47,7 +47,7 @@ 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)
+[See example](/samples/sounds/get-recommended-sounds-limited.js)
 
 With authorization it's possible to fetch all recommended sounds.
 
@@ -63,6 +63,6 @@ Renderforest.getRecommendedSounds(701, { duration: 5 })
 - 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)
+[See example](/samples/sounds/get-recommended-sounds.js)
 
 **[⬆ back to the top](#sounds-api)**

docs/SUPPORTS_API.md

@@ -20,6 +20,6 @@ Renderforest.addSupportsTicket({
 ```
 - 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)
+[See example](/samples/supports/add-supports-ticket.js)
 
 **[⬆ back to the top](#supports-api)**

docs/TEMPLATES_API.md

@@ -28,7 +28,7 @@ RenderforestClient.getTemplates({
   .then(console.log) // handle the success
   .catch(console.error) // handle the error
 ```
-[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/templates/get-templates.js)
+[See example](/samples/templates/get-templates.js)
 
 
 ### Get Templates Categories
@@ -44,7 +44,7 @@ RenderforestClient.getTemplatesCategories({ language: 'en' })
 ```
 - The supported language codes are: ar, de, en, es, fr, pt, ru, tr.
 
-[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/templates/get-templates-categories.js)
+[See example](/samples/templates/get-templates-categories.js)
 
 
 ### Get a Specific Template
@@ -59,7 +59,7 @@ RenderforestClient.getTemplate(701, { language: 'en' })
 ```
 - The supported language codes are: ar, de, en, es, fr, pt, ru, tr.
 
-[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/templates/get-template.js)
+[See example](/samples/templates/get-template.js)
 
 
 ### Get Color-Presets of the Template
@@ -75,7 +75,7 @@ RenderforestClient.getTemplateColorPresets(701)
 ```
 - The number of color-presets is varying from template to template.
 
-[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/templates/get-template-color-presets.js)
+[See example](/samples/templates/get-template-color-presets.js)
 
 
 ### Get Pluggable-Screens of the Template
@@ -92,7 +92,7 @@ RenderforestClient.getTemplatePluggableScreens(701)
 - The number of pluggable-screens is varying from template to template.
 Pluggable-Screens are grouped by categories.
 
-[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/templates/get-template-pluggable-screens.js)
+[See example](/samples/templates/get-template-pluggable-screens.js)
 
 
 ### Get Recommended-Custom-Colors of the Template
@@ -108,7 +108,7 @@ RenderforestClient.getTemplateRecommendedCustomColors(701)
 ```
 - The number of recommended-custom-colors is varying from template to template.
 
-[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/templates/get-template-recommended-custom-colors.js)
+[See example](/samples/templates/get-template-recommended-custom-colors.js)
 
 
 ### Get Template-Presets of the Template
@@ -126,7 +126,7 @@ RenderforestClient.getTemplatePresets(701)
 - The number of template-presets is varying from template to template.
 Template-presets are ready-made stories created from this template to fasten your video production.
 
-[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/templates/get-template-presets.js)
+[See example](/samples/templates/get-template-presets.js)
 
 
 ### Get SVG Content of the Template
@@ -140,7 +140,7 @@ RenderforestClient.getTemplateSVGContent(701)
   .catch(console.error) // handle the error
 ```
 
-[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/templates/get-template-svg-content.js)
+[See example](/samples/templates/get-template-svg-content.js)
 
 
 ### Get Theme of the Template
@@ -155,7 +155,7 @@ RenderforestClient.getTemplateTheme(701)
 ```
 - Both lego & non-lego templates might have a theme.
 
-[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/templates/get-template-theme.js)
+[See example](/samples/templates/get-template-theme.js)
 
 
 
@@ -165,12 +165,11 @@ Retrieves transitions of the template.
 ```js
 const RenderforestClient = require('@renderforest/sdk-node')
 
-
 RenderforestClient.getTemplateTransitions(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/templates/get-template-transitions.js)
+[See example](/samples/templates/get-template-transitions.js)
 
 **[⬆ back to the top](#templates-api)**

docs/USERS_API.md

@@ -15,6 +15,6 @@ Renderforest.getCurrentUser()
   .catch(console.error) // handle the error
 ```
 
-[See example](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/users/get-current-user.js)
+[See example](/samples/users/get-current-user.js)
 
 **[⬆ back to the top](#users-api)**

docs/project-data-api/AREAS_API.md

@@ -107,6 +107,6 @@ Renderforest.getProjectData(15220886)
   })
 ```
 
-[See advanced example for areas](https://github.com/renderforest/renderforest-sdk-node/blob/master/samples/project-data/set-text-image-video.js)
+[See advanced example for areas](/samples/project-data/set-text-image-video.js)
 
 **[⬆ back to the top](#areas-api)**