npm package: @plasma-platform/tm-service-promos
Description: Promos service api
Author: Daria Hromyk
Latest version: 1.0.3

# Documentation

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

### Table of Contents

-   [PromosService](#promosservice)
    -   [messages](#messages)
-   [getPromosBySlot](#getpromosbyslot)
-   [getPromos](#getpromos)
-   [getPromosMetadata](#getpromosmetadata)

## PromosService

-   **See: <https://jsonplaceholder.typicode.com/>**

Promos Micro Service API that you may adopt for your needs

**Parameters**

-   `url` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** service url
-   `token` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | null)** user access tocken if available (optional, default `null`)

### messages

Object with class service messages

## getPromosBySlot

Return promos information for given slot.

**Parameters**

-   `slot` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Slot Name
-   `locale` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** locale

Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** <pre>
{
  "_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"
  ]
}
</pre>

## getPromos

Return promos information for all slots.

Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** <pre>
[{
  "_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"
  ]
},
...]
</pre>

## getPromosMetadata

Return promos information for all slots.

Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** <pre>

</pre>