Full documentation
install:
npm i @plasma-platform/service-products -S

Short documentation

Table of Contents

• ServiceProducts
  • Parameters
  • messages
  • getPossibleSuggestions
    • Parameters
    • Examples
  • disableTemplate
    • Parameters
    • Examples
  • freezeTemplate
    • Parameters
    • Examples
  • removedTemplate
    • Parameters
    • Examples
  • getTemplateByIdPublic
    • Parameters
    • Examples
  • getTemplateById
    • Parameters
    • Examples
  • getTemplatesTopics
    • Parameters
    • Examples
  • getTemplatesTypes
    • Parameters
    • Examples
  • getTemplates
    • Parameters
    • Examples
  • getTemplatesPublic
    • Parameters
    • Examples
  • getTotalTemplatesSales
    • Parameters
    • Examples
  • getUserOwnProducts
    • Parameters
    • Examples
  • getUserOwnProductsHead
    • Parameters
    • Examples
  • undoDisableProcess
    • Parameters
    • Examples
  • undoFreezeProcess
    • Parameters
    • Examples
  • undoRemovedProcess
    • Parameters
    • Examples
  • updateUserRatingAndTotalReviewsCount
    • Parameters
    • Examples
  • getProductsBySpecificParams
    • Parameters
    • Examples

ServiceProducts

• See: http://service-products.templatemonster.com/doc

Parameters

• url string service url
• token (string | null) user access token if available (optional, default null)

messages

Object with class service messages

Type: object

getPossibleSuggestions

Get possible suggestions

Parameters

• text text search suggests texts

Examples

(async () => {
  const service = new Service('http://service-products.dev/api/v1/', token);
  const request = await service.getPossibleSuggests('53001');
})();

Returns Promise<object> array with fined products

disableTemplate

Disable template

Parameters

• templateId number template ID

Examples

(async () => {
  const service = new Service('http://service-products.dev/api/v1/', token);
  const request = await service.disableTemplate(53001);
})();

Returns Promise<object> object of disable product

freezeTemplate

Freeze template

Parameters

• templateId number template ID

Examples

(async () => {
  const service = new Service('http://service-products.dev/api/v1/', token);
  const request = await service.freezeTemplate(53001);
})();

Returns Promise<object> object 0f freeze product

removedTemplate

Removed template

Parameters

• templateId number template ID

Examples

(async () => {
  const service = new Service('http://service-products.dev/api/v1/', token);
  const request = await service.removedTemplate(53001);
})();

Returns Promise<object> object 0f freeze product

getTemplateByIdPublic

Get template by id (public method)

Parameters

• props object
  • props.expand number expand information
  • props.ids string list of templates id divided by comma (e.g. "55555,55556,55557")
  • props.locale string 2 char locale (en, ru de, etc.)

Examples

(async () => {
  const service = new Service('http://service-products.dev/api/v1/');
  const request = await service.getTemplateByIdPublic({locale: 'en', ids: 53000});
)();

Returns Promise<object> object of product

getTemplateById

Get template by id

Parameters

• props object
  • props.expand number expand information
  • props.ids string list of templates id divided by comma (e.g. "55555,55556,55557")

Examples

(async () => {
  const service = new Service('http://service-products.dev/api/v1/', token);
  const request = await service.getTemplateById(53001);
})();

Returns Promise<object> object of product

getTemplatesTopics

Get templates topics

Parameters

• props object
  • props.isAdult number return only adult or not templates
  • props.ids string array of templates id divided by comma (e.g. "55555,55556,55557")
  • props.searchWord string
  • props.properties object array of properties where key is a property name and value is a value to search. e.g. (?properties[author_user_id]=1506970)
  • props.type string find all templates with given type name (e.g. "?type=wordpress", "?type=wordpress themes")

Examples

(async () => {
  const service = new Service('http://service-products.dev/api/v1/');
  const request = await service.getTemplatesTopics({
isAdult: 1,
ids: '53001',
searchWord: 'qwe',
properties: {
id: 2570,
propertyName: 'Name of the template',
},
type: 'wordpress',
});
})();

Returns Promise<object> object of topics products list

getTemplatesTypes

Get templates types

Parameters

• props object
  • props.isAdult number return only adult or not templates
  • props.ids string array of templates id divided by comma (e.g. "55555,55556,55557")
  • props.searchWord string
  • props.properties object array of properties where key is a property name and value is a value to search. e.g. (?properties[author_user_id]=1506970)

Examples

(async () => {
  const service = new Service('http://service-products.dev/api/v1/');
  const request = await service.getTemplatesTypes({
isAdult: 1,
ids: '53001',
searchWord: 'qwe',
properties: {
id: 2570,
propertyName: 'Name of the template',
},
});
})();

Returns Promise<object> object of types products list

getTemplates

Get templates

Parameters

• props object
  • props.isAdult number return only adult or not templates
  • props.ids string array of templates id divided by comma (e.g. "55555,55556,55557")
  • props.searchWord string
  • props.properties object array of properties where key is a property name and value is a value to search. e.g. (?properties[author_user_id]=1506970)
  • props.type string find all templates with given type name (e.g. "?type=wordpress", "?type=wordpress themes")
  • props.sort string available value [cheap, pricey, new, from doc API]
  • props.perPage number max templates per one page (20 by default, 200 is max size)
  • props.page number page number to view
  • props.filterTopic string topic id
  • props.filterUser string vendor id
  • props.filterPlatform string platform name [wordpress, joomla, ...]

Examples

(async () => {
  const service = new Service('http://service-products.dev/api/v1/', token);
  const request = await service.getTemplates({
isAdult: 1,
ids: '53001',
searchWord: 'qwe',
properties: {
id: 2570,
propertyName: 'Name of the template',
},
type: 'wordpress',
sort: 'price',
perPage: 20,
page: 1,
});
})();

Returns Promise<object> object of products list

getTemplatesPublic

Get templates public

Parameters

• props object
  • props.isAdult number return only adult or not templates
  • props.ids string array of templates id divided by comma (e.g. "55555,55556,55557")
  • props.searchWord string
  • props.properties object array of properties where key is a property name and value is a value to search. e.g. (?properties[author_user_id]=1506970)
  • props.type string find all templates with given type name (e.g. "?type=wordpress", "?type=wordpress themes")
  • props.sort string available value [cheap, pricey, new, from doc API]
  • props.perPage number max templates per one page (20 by default, 200 is max size)
  • props.page number page number to view
  • props.filterTopic string topic id
  • props.filterUser string vendor id
  • props.filterPlatform string platform name [wordpress, joomla, ...]

Examples

(async () => {
  const service = new Service('http://service-products.dev/api/v1/', token);
  const request = await service.getTemplatesPublic({
isAdult: 1,
ids: '53001',
searchWord: 'qwe',
properties: {
id: 2570,
propertyName: 'Name of the template',
},
type: 'wordpress',
sort: 'price',
perPage: 20,
page: 1,
});
})();

Returns Promise<object> object of products list

getTotalTemplatesSales

Get total templates sales

Parameters

• props object
  • props.isAdult number return only adult or not templates
  • props.ids string array of templates id divided by comma (e.g. "55555,55556,55557")
  • props.searchWord string
  • props.properties object array of properties where key is a property name and value is a value to search. e.g. (?properties[author_user_id]=1506970)
  • props.type string find all templates with given type name (e.g. "?type=wordpress", "?type=wordpress themes")

Examples

(async () => {
  const service = new Service('http://service-products.dev/api/v1/');
  const request = await service.getTotalTemplatesSales({
isAdult: 1,
ids: '53001',
searchWord: 'qwe',
properties: {
id: 2570,
propertyName: 'Name of the template',
},
type: 'wordpress',
});
})();

Returns Promise<object> object of templates total sales value

getUserOwnProducts

Get user own products

Parameters

• props object
  • props.locale string 2 char locale (en, ru de, etc.)
  • props.properties object array of properties where key is a property name and value is a value to search. e.g. (?properties[author_user_id]=1506970)
  • props.type string find all templates with given type name (e.g. "?type=wordpress", "?type=wordpress themes")
  • props.sort string defines on which fields to sort (e.g. ?sort=price,-templateId) ("-" symbol is DESC sort)
  • props.perPage number max templates per one page (20 by default, 200 is max size)
  • props.page number page number to view

Examples

(async () => {
  const service = new Service('http://service-products.dev/api/v1/products/', token);
  const request = await service.getUserOwnProducts({
properties: {
id: 2570,
propertyName: 'Name of the template',
},
type: 'wordpress',
sort: 'price',
perPage: 20,
page: 1,
});
})();

Returns Promise<object> object of product parameters

getUserOwnProductsHead

Get user own products heads

Parameters

• props object
  • props.locale string 2 char locale (en, ru de, etc.)
  • props.properties object array of properties where key is a property name and value is a value to search. e.g. (?properties[author_user_id]=1506970)
  • props.type string find all templates with given type name (e.g. "?type=wordpress", "?type=wordpress themes")
  • props.sort string defines on which fields to sort (e.g. ?sort=price,-templateId) ("-" symbol is DESC sort)
  • props.perPage number max templates per one page (20 by default, 200 is max size)
  • props.page number page number to view

Examples

(async () => {
  const service = new Service('http://service-products.dev/api/v1/products/', token);
  const request = await service.getUserOwnProductsHead({
properties: {
id: 2570,
propertyName: 'Name of the template',
},
type: 'wordpress',
sort: 'price',
perPage: 20,
page: 1,
});
})();

Returns Promise<object> object of product parameters

undoDisableProcess

Undo disable process

Parameters

• templateId number template ID

Examples

(async () => {
  const service = new Service('http://service-products.dev/api/v1/products/', token);
  const request = await service.undoDisableProcess(53001);
})();

Returns Promise<object> object of product

undoFreezeProcess

Undo freeze process

Parameters

• templateId number template ID

Examples

(async () => {
  const service = new Service('http://service-products.dev/api/v1/products/', token);
  const request = await service.undoFreezeProcess(53001);
})();

Returns Promise<object> object of product

undoRemovedProcess

Undo removed process

Parameters

• templateId number template ID

Examples

(async () => {
  const service = new Service('http://service-products.dev/api/v1/products/', token);
  const request = await service.undoRemovedProcess(53001);
})();

Returns Promise<object> object of product

updateUserRatingAndTotalReviewsCount

Update user rating and total reviews count

Parameters

• props object
  • props.templateId number Reviewed template id
  • props.reviewsAverageScore number Review score
  • props.reviewsTotal number Total amount of reviews for this template

Examples

(async () => {
  const service = new Service('http://service-products.dev/api/v1/', token);
  const request = await service.updateUserRatingAndTotalReviewsCount({
templateId: 53001,
reviewsAverageScore: 123,
reviewsTotal: 123,
});
})();

Returns Promise<object> object of updated product parameters

getProductsBySpecificParams

Search products by specific params (only v2)

Parameters

• params object
  • params.locale string locale

Examples

(async () => {
  const service = new Service('//api.templatemonsterdev.com/products/v2/');
  const request = await service.getProductsBySpecificParams({ locale: 'en' });
})();

Returns Promise<object> object product parameters