Full documentation
install:
npm i @plasma-platform/service-promos -S
Short documentation
Table of Contents
- PromosService
- getPromosBySlot
- getPromos
- getPromosMetadata
- getAuthorNotifications
- setActionAuthorNotification
- createGiftForAuthor
- createGiftForAuthor
PromosService
Promos Micro Service API that you may adopt for your needs
Parameters
-
url
string service url -
token
(string | null) user access tocken if available (optional, defaultnull
)
messages
Object with class service messages
Type: Object
getPromosBySlot
Return promos information for given slot.
Parameters
Returns Object
{ "_id" : "5b62fab40643dd000b634c92", "slot" : "Main", "type" : "slider", "created_at" : 1533213364, "updated_at" : 1533214495, "params" : { "switch_time" : "15", "slides" : [ { "en" : { "productId" : "55555", "title" : "Monstroid - Wordpress Theme", "titleHtmlType" : "h1", "rating" : "5", "price" : "99.9", "promoPrice" : "77", "blueButtonName" : "View Details", "blueButtonLink" : "https://www.templatemonster.com/intense-multipurpose-html-template.html", "grayButtonName" : "Live Demo", "grayButtonLink" : "https://www.templatemonster.com/demo/55555.html", "image" : "https://s.tmimgcdn.com/scr/62200/monstroid2-multipurpose-wordpress-theme_62222-original.jpg?width=1280", "imageAlt" : "monstroid wordpress theme", "bgImage" : "https://s.tmimgcdn.com/scr/59500/59555-prestashop-b.jpg?width=50", "display" : "left", "type" : "product", "active" : "1" } }, ... ] }, "tags" : [ "main", "test" ] }
getPromos
Return promos information for all slots.
Returns Object
[{ "_id" : "5b62fab40643dd000b634c92", "slot" : "Main", "type" : "slider", "created_at" : 1533213364, "updated_at" : 1533214495, "params" : { "switch_time" : "15", "slides" : [ { "en" : { "productId" : "55555", "title" : "Monstroid - Wordpress Theme", "titleHtmlType" : "h1", "rating" : "5", "price" : "99.9", "promoPrice" : "77", "blueButtonName" : "View Details", "blueButtonLink" : "https://www.templatemonster.com/intense-multipurpose-html-template.html", "grayButtonName" : "Live Demo", "grayButtonLink" : "https://www.templatemonster.com/demo/55555.html", "image" : "https://s.tmimgcdn.com/scr/62200/monstroid2-multipurpose-wordpress-theme_62222-original.jpg?width=1280", "imageAlt" : "monstroid wordpress theme", "bgImage" : "https://s.tmimgcdn.com/scr/59500/59555-prestashop-b.jpg?width=50", "display" : "left", "type" : "product", "active" : "1" } }, ... ] }, "tags" : [ "main", "test" ] }, ...]
getPromosMetadata
Return promos information for all slots.
Returns Object
getAuthorNotifications
Get author's notifications items.
Parameters
Examples
(async () => {
const service = new Service('http://service-promos.templatemonsterdev.com/api/v1/', token);
const request = await service.getAuthorNotifications(properties);
})();
Returns Object
Returns Promise<any>
setActionAuthorNotification
Set action to author's notification.
Parameters
Examples
(async () => {
const service = new Service('http://service-promos.templatemonsterdev.com/api/v1/', token);
const request = await service.setActionAuthorNotification(params);
})();
Returns Object
Returns Promise<any>
createGiftForAuthor
Create gift to author.
Parameters
Examples
(async () => {
const service = new Service('http://service-promos.templatemonsterdev.com/api/v1/', token);
const request = await service.createGiftForAuthor(params);
})();
Returns Object
Returns Promise<any>
createGiftForAuthor
Get authors gift.
Parameters
Examples
(async () => {
const service = new Service('http://service-promos.templatemonsterdev.com/api/v1/', token);
const request = await service.getGiftAuthor(params);
})();
Returns Object
Returns Promise<any>