open-index/open-npm huggingface dataset:
npm package: @plasma-platform/livr-rules
Description: Custom plasma platform rules for livr ))
Author: Mirza Sergey
Latest version: 1.1.7-alpha.0

![version](https://badgen.net/npm/v/@plasma-platform/livr-rules)
![nextVersion](https://badgen.net/npm/v/@plasma-platform/livr-rules/next)
![downloads](https://badgen.net/npm/dt/@plasma-platform/livr-rules)
![license](https://badgen.net/npm/license/@plasma-platform/livr-rules)
![dependency](https://badgen.net/npm/dependents/@plasma-platform/livr-rules)  

* * *

[Full documentation](https://undefined)  
install:  
`npm i @plasma-platform/livr-rules -S`  

# Short documentation

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

## Table of Contents
npm package: @plasma-platform/service-auth
Description: Service Auth Api
Author: Kyrylo Voronoi
Latest version: 1.3.0

![version](https://badgen.net/npm/v/@plasma-platform/service-auth)
![nextVersion](https://badgen.net/npm/v/@plasma-platform/service-auth/next)
![downloads](https://badgen.net/npm/dt/@plasma-platform/service-auth)
![license](https://badgen.net/npm/license/@plasma-platform/service-auth)
![dependency](https://badgen.net/npm/dependents/@plasma-platform/service-auth)  

* * *

[Full documentation](https://templatemonster.gitlab.io/PlasmaPlatform/Frontend/plasma-platform/?path=/story/plasma-platform-sdk--service-auth)  
install:  
`npm i @plasma-platform/service-auth -S`  

# Short documentation

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

### Table of Contents

-   [ServiceAuth](#serviceauth)
    -   [getTokenInfo](#gettokeninfo)
        -   [Examples](#examples)
    -   [revokeToken](#revoketoken)
        -   [Examples](#examples-1)

## ServiceAuth

-   **See: <http://service-auth.templatemonsterdev.com/doc/>**

Auth API

### getTokenInfo

-   **See: <http://service-locales.templatemonsterdev.com/doc/#api-Token-TokenInfo>**

Get info about token

#### Examples

```javascript
(async () => {
  const service = new Service(url, token);
  const request = await service.getTokenInfo();
})();
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;any>** 

### revokeToken

-   **See: <http://service-locales.templatemonsterdev.com/doc/#api-Token-DeleteToken>**

Revoke token

#### Examples

```javascript
(async () => {
  const service = new Service(url, token);
  const request = await service.revokeToken();
})();
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;any>**
npm package: @plasma-platform/service-chat
Description: Chat service api
Author: Anton Nemtsev
Latest version: 2.5.0

![version](https://badgen.net/npm/v/@plasma-platform/service-chat)
![nextVersion](https://badgen.net/npm/v/@plasma-platform/service-chat/next)
![downloads](https://badgen.net/npm/dt/@plasma-platform/service-chat)
![license](https://badgen.net/npm/license/@plasma-platform/service-chat)
![dependency](https://badgen.net/npm/dependents/@plasma-platform/service-chat)  

* * *

[Full documentation](https://templatemonster.gitlab.io/PlasmaPlatform/Frontend/plasma-platform/?path=/story/plasma-platform-sdk--service-chat)  
install:  
`npm i @plasma-platform/service-chat -S`  

# Short documentation

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

### Table of Contents

-   [ChatService](#chatservice)
    -   [Parameters](#parameters)
    -   [getRooms](#getrooms)
        -   [Parameters](#parameters-1)
    -   [getRoomsName](#getroomsname)
        -   [Parameters](#parameters-2)
    -   [getRoomsLocales](#getroomslocales)
        -   [Parameters](#parameters-3)
    -   [getRoomsLocalesName](#getroomslocalesname)
        -   [Parameters](#parameters-4)
    -   [messages](#messages)

## ChatService

-   **See: //chat.template-help.com/api/**

Chat 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 token if available (optional, default `null`)

### getRooms

Get chat rooms

#### Parameters

-   `params`   (optional, default `{}`)

### getRoomsName

Get chat rooms of name

#### Parameters

-   `roomName`  
-   `params`   (optional, default `{}`)

### getRoomsLocales

Get chat rooms of name

#### Parameters

-   `params`   (optional, default `{}`)

### getRoomsLocalesName

Get chat rooms of name

#### Parameters

-   `roomName`  
-   `params`   (optional, default `{}`)

### messages

Object with class service messages

Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
npm package: @plasma-platform/service-currencies
Description: Service Currencies Api
Author: Kyrylo Voronoi
Latest version: 1.5.0

![version](https://badgen.net/npm/v/@plasma-platform/service-currencies)
![nextVersion](https://badgen.net/npm/v/@plasma-platform/service-currencies/next)
![downloads](https://badgen.net/npm/dt/@plasma-platform/service-currencies)
![license](https://badgen.net/npm/license/@plasma-platform/service-currencies)
![dependency](https://badgen.net/npm/dependents/@plasma-platform/service-currencies)  

* * *

[Full documentation](https://templatemonster.gitlab.io/PlasmaPlatform/Frontend/plasma-platform/?path=/story/plasma-platform-sdk--service-currencies)  
install:  
`npm i @plasma-platform/service-currencies -S`  

# Short documentation

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

### Table of Contents

-   [ServiceCurrencies](#servicecurrencies)
    -   [getCurrencyExchangeRate](#getcurrencyexchangerate)
        -   [Parameters](#parameters)
        -   [Examples](#examples)
-   [getExchangeRateList](#getexchangeratelist)
    -   [Parameters](#parameters-1)
    -   [Examples](#examples-1)

## ServiceCurrencies

-   **See: <http://service-currencies.templatemonsterdev.com/doc/>**

Currencies API

### getCurrencyExchangeRate

-   **See: <http://service-currencies.templatemonsterdev.com/doc/#api-Currency-GetCurrency>**

Request Currency information

#### Parameters

-   `params` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
    -   `params.currency` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Currency iso3 code
    -   `params.date` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** Date in format 'YYYY-mm-dd'. (By default: current date)

#### Examples

```javascript
(async () => {
  const service = new Service(url);
  const request = await service.getCurrencyExchangeRate(params);
})();
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;any>** 

## getExchangeRateList

-   **See: <http://service-currencies.templatemonsterdev.com/doc/#api-Currency-GetCurrency>**

Get list of available currencies

### Parameters

-   `params` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
    -   `params.date` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** Date in format 'YYYY-mm-dd'. (By default: current date)

### Examples

```javascript
(async () => {
  const service = new Service(url);
  const request = await service.getExchangeRateList(date);
})();
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;any>**
npm package: @plasma-platform/service-discounts
Description: Discounts Service API
Author: Vira Peretiatko
Latest version: 2.6.0

![version](https://badgen.net/npm/v/@plasma-platform/service-discounts)
![nextVersion](https://badgen.net/npm/v/@plasma-platform/service-discounts/next)
![downloads](https://badgen.net/npm/dt/@plasma-platform/service-discounts)
![license](https://badgen.net/npm/license/@plasma-platform/service-discounts)
![dependency](https://badgen.net/npm/dependents/@plasma-platform/service-discounts)  

* * *

[Full documentation](https://templatemonster.gitlab.io/PlasmaPlatform/Frontend/plasma-platform/?path=/story/plasma-platform-sdk--service-discounts)  
install:  
`npm i @plasma-platform/service-discounts -S`  

# Short documentation

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

### Table of Contents

-   [DiscountService](#discountservice)
    -   [Parameters](#parameters)
    -   [messages](#messages)
    -   [applyDiscount](#applydiscount)
        -   [Examples](#examples)
    -   [getDiscountApplicability](#getdiscountapplicability)
        -   [Parameters](#parameters-1)
        -   [Examples](#examples-1)

## DiscountService

Discount Micro Service API

### Parameters

-   `url` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** service url

### messages

Object with class service messages

Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)

### applyDiscount

View discount

#### Examples

```javascript
To use
(async () => {
  const DiscountService = new DiscountService(url);
  const result = await DiscountService.viewDiscount();
})();
```

Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** array of posts

### getDiscountApplicability

Get discount applicability

#### Parameters

-   `code` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** promocode
-   `cart` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** cart info
-   `items` **[array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** product from the cart

#### Examples

```javascript
To use
(async () => {
  const DiscountService = new DiscountService(url);
  const result = await DiscountService.getDiscountApplicability('sddf6gdfg6df', {}, []);
})();
```

Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** discount applicability to products provided with params
npm package: @plasma-platform/service-geo
Description: Geo Service API
Author: Vira Peretiatko
Latest version: 0.0.4

![version](https://badgen.net/npm/v/@plasma-platform/service-users)
![nextVersion](https://badgen.net/npm/v/@plasma-platform/service-users/next)
![downloads](https://badgen.net/npm/dt/@plasma-platform/service-users)
![license](https://badgen.net/npm/license/@plasma-platform/service-users)
![dependency](https://badgen.net/npm/dependents/@plasma-platform/service-users)  

* * *

[Full documentation](https://templatemonster.gitlab.io/PlasmaPlatform/Frontend/plasma-platform/?path=/story/plasma-platform-sdk--service-users)  
install:  
`npm i @plasma-platform/service-users -S`  

# Short documentation

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

### Table of Contents

-   [GeoService](#geoservice)
    -   [Parameters](#parameters)
    -   [messages](#messages)
    -   [getCityByIpAddress](#getcitybyipaddress)
        -   [Parameters](#parameters-1)
        -   [Examples](#examples)
    -   [getIpInfo](#getipinfo)
        -   [Parameters](#parameters-2)
        -   [Examples](#examples-1)
    -   [getCountries](#getcountries)
        -   [Examples](#examples-2)

## GeoService

-   **See: <http://service-geo.templatemonster.com/doc/>**

Users Micro Service API

### 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

Type: [object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)

### getCityByIpAddress

Cities - Get city by ip address

#### Parameters

-   `params` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** ip: IP address.

#### Examples

```javascript
(async () => {
  const service = new Service('//api.templatemonsterdev.com/geo/v1/');
  const request = await service.getCityByIpAddress('192.168.2.59');
})();
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;cityInfo>** 

### getIpInfo

Cities - Get info by ip address

#### Parameters

-   `params` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** ip: IP address.

#### Examples

```javascript
(async () => {
  const service = new Service('//api.templatemonsterdev.com/geo/v1/');
  const request = await service.getIpInfo('192.168.2.59');
})();
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;ipInfo>** 

### getCountries

Geo - getCountries

#### Examples

```javascript
(async () => {
  const service = new Service('//api.templatemonsterdev.com/geo/v1/');
  const request = await service.getCountries('192.168.2.59');
})();
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;listCountries>**
npm package: @plasma-platform/service-licenses
Description: Licenses Service API
Latest version: 0.5.0

![version](https://badgen.net/npm/v/@plasma-platform/service-licenses)
![nextVersion](https://badgen.net/npm/v/@plasma-platform/service-licenses/next)
![downloads](https://badgen.net/npm/dt/@plasma-platform/service-licenses)
![license](https://badgen.net/npm/license/@plasma-platform/service-licenses)
![dependency](https://badgen.net/npm/dependents/@plasma-platform/service-licenses)  

* * *

[Full documentation](https://templatemonster.gitlab.io/PlasmaPlatform/Frontend/plasma-platform/?path=/story/plasma-platform-sdk--service-users)  
install:  
`npm i @plasma-platform/service-licenses -S`

# Short documentation

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

### Table of Contents

-   [LicensesService](#licensesservice)
    -   [Parameters](#parameters)
    -   [getLicenseById](#getlicensebyid)
        -   [Examples](#examples)
    -   [getLicensesByIds](#getlicensesbyids)
        -   [Examples](#examples-1)
    -   [searchLicenses](#searchlicenses)
        -   [Parameters](#parameters-1)
        -   [Examples](#examples-2)

## LicensesService

-   **See: <http://service-licenses.templatemonsterdev.com/doc/>**

Users Micro Service API

### Parameters

-   `url` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** service url

### getLicenseById

Licenses - Get license by id with locale

#### Examples

Get license by Id


```javascript
(async () => {
  const licenses = new LicensesService('//service-licenses.templatemonsterdev.com/api/v1/');
  const licenseData = await licenses.getLicenseById(5);
})();
```

Returns **license** license data

### getLicensesByIds

Licenses - Get licenses by ids with locale

#### Examples

Get license by Ids


```javascript
(async () => {
  const licenses = new LicensesService('//service-licenses.templatemonsterdev.com/api/v1/');
  const licenseData = await licenses.getLicensesByIds([5,3,4]);
})();
```

Returns **license** license data

### searchLicenses

Licenses - Search licenses

#### Parameters

-   `params` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
    -   `params.locale` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** locale
    -   `params.filter` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** filters for license search (e.g ?filter=name eq 'david'&$orderBy=hireDate)

#### Examples

Search licenses


```javascript
(async () => {
  const service = new LicensesService(serviceUrl);
  const licensesList = await service.searchLicenses(params);
})();
```

Returns **[array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** licenses list
npm package: @plasma-platform/service-locales
Description: Service Locales Api
Author: Kyrylo Voronoi
Latest version: 1.1.0

![version](https://badgen.net/npm/v/@plasma-platform/service-locales)
![nextVersion](https://badgen.net/npm/v/@plasma-platform/service-locales/next)
![downloads](https://badgen.net/npm/dt/@plasma-platform/service-locales)
![license](https://badgen.net/npm/license/@plasma-platform/service-locales)
![dependency](https://badgen.net/npm/dependents/@plasma-platform/service-locales)  

* * *

[Full documentation](https://templatemonster.gitlab.io/PlasmaPlatform/Frontend/plasma-platform/?path=/story/plasma-platform-sdk--service-locales)  
install:  
`npm i @plasma-platform/service-locales -S`  

# Short documentation

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

### Table of Contents

-   [ServiceLocales](#servicelocales)
    -   [getLocales](#getlocales)
        -   [Examples](#examples)
    -   [getLocale](#getlocale)
        -   [Parameters](#parameters)
        -   [Examples](#examples-1)

## ServiceLocales

-   **See: <http://service-locales.templatemonsterdev.com/doc/>**

Locales API

### getLocales

-   **See: <http://service-locales.templatemonsterdev.com/doc/#api-Locales-GetLocales>**

Get list of all TM locales

#### Examples

```javascript
(async () => {
  const service = new Service(url);
  const request = await service.getLocales();
})();
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;any>** 

### getLocale

-   **See: <http://service-locales.templatemonsterdev.com/doc/#api-Locales-GetLocale>**

Get locale by ico2 code

#### Parameters

-   `code` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Locale ico2 code

#### Examples

```javascript
(async () => {
  const service = new Service(url);
  const request = await service.getLocale(code);
})();
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;any>**
npm package: @plasma-platform/service-loyalty
Description: Loyalty Program Service API
Author: Evgenii Latyshev
Latest version: 1.4.0

![version](https://badgen.net/npm/v/@plasma-platform/service-loyalty)
![nextVersion](https://badgen.net/npm/v/@plasma-platform/service-loyalty/next)
![downloads](https://badgen.net/npm/dt/@plasma-platform/service-loyalty)
![license](https://badgen.net/npm/license/@plasma-platform/service-loyalty)
![dependency](https://badgen.net/npm/dependents/@plasma-platform/service-loyalty) 

* * *

[Full documentation](https://templatemonster.gitlab.io/PlasmaPlatform/Frontend/plasma-platform/?path=/story/plasma-platform-sdk--service-loyalty)  
install:  
`npm i @plasma-platform/service-loyalty -S`  

# Short documentation

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

### Table of Contents

-   [LoyaltyProgramService](#loyaltyprogramservice)
    -   [Parameters](#parameters)
    -   [getLevels](#getlevels)
        -   [Examples](#examples)
    -   [getLevelsById](#getlevelsbyid)
        -   [Parameters](#parameters-1)
        -   [Examples](#examples-1)
    -   [getUserProfile](#getuserprofile)
        -   [Examples](#examples-2)

## LoyaltyProgramService

Loyalty Program Micro Service API SDK

### 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 token if available (optional, default `null`)

### getLevels

Get Loyalty Levels

#### Examples

```javascript
To use
(async () => {
  const LoyaltyProgramService = new LoyaltyProgramService(url, token);
  const list = await LoyaltyProgramService.getLevels();
})();
```

Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** array of loyalty levels

### getLevelsById

Get Loyalty Level by id

#### Parameters

-   `id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** level id

#### Examples

```javascript
To use
(async () => {
  const LoyaltyProgramService = new LoyaltyProgramService(url, token);
  const list = await LoyaltyProgramService.getLevelsById(id);
})();
```

Returns **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** object of loyalty level

### getUserProfile

Get Loyalty Levels

#### Examples

```javascript
To use
(async () => {
  const LoyaltyProgramService = new LoyaltyProgramService(url, token);
  const list = await LoyaltyProgramService.getUserProfile();
})();
```

Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** object of user profile
npm package: @plasma-platform/service-mailer
Description: Mailer Service API
Author: Vira Peretiatko
Latest version: 1.3.0

![version](https://badgen.net/npm/v/@plasma-platform/service-mailer)
![nextVersion](https://badgen.net/npm/v/@plasma-platform/service-mailer/next)
![downloads](https://badgen.net/npm/dt/@plasma-platform/service-mailer)
![license](https://badgen.net/npm/license/@plasma-platform/service-mailer)
![dependency](https://badgen.net/npm/dependents/@plasma-platform/service-mailer)  

* * *

[Full documentation](https://templatemonster.gitlab.io/PlasmaPlatform/Frontend/plasma-platform/?path=/story/plasma-platform-sdk--service-mailer)  
install:  
`npm i @plasma-platform/service-mailer -S`  

# Short documentation

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

### Table of Contents

-   [MailerService](#mailerservice)
    -   [Parameters](#parameters)
    -   [messages](#messages)
-   [sendMail](#sendmail)
    -   [Parameters](#parameters-1)
    -   [Examples](#examples)

## MailerService

Mailer 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

### messages

Object with class service messages

Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)

## sendMail

Send mail

### Parameters

-   `key` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** emails key
-   `email` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** users mail

### Examples

Send mail


```javascript
(async () => {
  const MailerService = new MailerService(url);
  const result = await MailerService.sendMail('api-empty-checkout-free-ebook', 'test@gmail.com');
})();
```

Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** send email result
npm package: @plasma-platform/service-navigations
Description: Navigastions Service API
Author: Andrii Balaniuk
Latest version: 2.3.0

![version](https://badgen.net/npm/v/@plasma-platform/service-navigations)
![nextVersion](https://badgen.net/npm/v/@plasma-platform/service-navigations/next)
![downloads](https://badgen.net/npm/dt/@plasma-platform/service-navigations)
![license](https://badgen.net/npm/license/@plasma-platform/service-navigations)
![dependency](https://badgen.net/npm/dependents/@plasma-platform/service-navigations)  

* * *

[Full documentation](https://templatemonster.gitlab.io/PlasmaPlatform/Frontend/plasma-platform/?path=/story/plasma-platform-sdk--service-navigations)  
install:  
`npm i @plasma-platform/service-navigations -S`  

# Short documentation

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

### Table of Contents

-   [NavigationsService](#navigationsservice)
    -   [Parameters](#parameters)
    -   [getNavigations](#getnavigations)
        -   [Parameters](#parameters-1)
        -   [Examples](#examples)
    -   [getNavigationByCode](#getnavigationbycode)
        -   [Parameters](#parameters-2)
        -   [Examples](#examples-1)

## NavigationsService

-   **See: <http://http://api.templatemonster.com/navigations/doc/>**

Navigations Micro Service API

### 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`)

### getNavigations

Get navigations list

#### Parameters

-   `args` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** options
    -   `args.tags` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** navigation tags
    -   `args.locale` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** navigation locale

#### Examples

Get all navigations


```javascript
(async () => {
  const Navigations = new NavigationsService('//api.templatemonster.com/navigations/v1/');
  const navigation = await Navigations.getNavigations();
})();
```

### getNavigationByCode

Get specific navigation by code

#### Parameters

-   `args` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** options
    -   `args.code` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** navigation code
    -   `args.locale` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** navigation locale

#### Examples

Get specific navigation by code


```javascript
(async () => {
  const Navigations = new NavigationsService('//api.templatemonster.com/navigations/v1/');
  const navigation = await Navigations.getNavigationByCode('header_top');
})();
```
npm package: @plasma-platform/tm-message-hook
Description: Check commit message format
Author: Anton Nemtsev
Latest version: 2.0.14

# Commit message format checker

Use inside **package.json** with **husky** like this:

```
  …
  "scripts": {
    "commitmsg": "commit-msg ${GIT_PARAMS} -r (^[A-Z]+-[0-9]+\s-\s[\W\w\s]{5,}[\s]*$|^lock[\s]*$|^((m|M)erge[\w\W\s]*)|^[\d]+(.[\d]+)?(.[\d]+)?[\s]*$)"
  },
  …
```
npm package: @plasma-platform/tm-service-apv
Description: APV Service API
Author: Kyrylo Voronoi
Latest version: 1.0.1

# Documentation

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

### Table of Contents

-   [APVService](#apvservice)
    -   [messages](#messages)
    -   [confirmPhoneByPinCode](#confirmphonebypincode)
    -   [getPaginationHeaders](#getpaginationheaders)
    -   [updateApv](#updateapv)

## APVService

-   **See: <http://service-apv.templatemonsterdev.com/doc/>**

### messages

object with class service messages

### confirmPhoneByPinCode

Apv - Confirm phone by pin-code

**Parameters**

-   `params` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
    -   `params.phoneNumber` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Phone number (required)
    -   `params.pinCode` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Pin code to verify. Allowed values: {1000-9999} (required)

**Examples**

```javascript
(async () => {
  const service = new APVService(url);
  const request = await service.confirmPhoneByPinCode(params);
})();
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;any>** 

### getPaginationHeaders

Apv - Get pagination headers
Verification status:
0 - pending
1 - success
2 - failed
3 - skipped
4 - expired

**Parameters**

-   `params` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
    -   `params.phoneNumber` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Phone number (required)
    -   `params.status` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?** Apv status filter (see status explanations). Allowed values: 0..4

**Examples**

```javascript
(async () => {
  const service = new APVService(url);
  const request = await service.getPaginationHeaders(params);
})();
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;any>** 

### updateApv

Apv - Update apv
Verification status:
0 - pending
1 - success
2 - failed
3 - skipped
4 - expired

**Parameters**

-   `params` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
    -   `params.phoneNumber` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Phone number (required)
    -   `params.status` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** Apv status filter (see status explanations). Allowed values: 0..4

**Examples**

```javascript
(async () => {
  const service = new APVService(url);
  const request = await service.updateApv(params);
})();
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;any>**
npm package: @plasma-platform/tm-service-chat
Description: Chat service api
Author: Anton Nemtsev
Latest version: 2.0.3

# Documentation

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

### Table of Contents

-   [ChatService](#chatservice)
    -   [getRooms](#getrooms)
    -   [getRoomsName](#getroomsname)
    -   [getRoomsLocales](#getroomslocales)
    -   [getRoomsLocalesName](#getroomslocalesname)
    -   [messages](#messages)

## ChatService

-   **See: //chat.template-help.com/api/**

Chat 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 token if available (optional, default `null`)

### getRooms

Get chat rooms

### getRoomsName

Get chat rooms of name

### getRoomsLocales

Get chat rooms of name

### getRoomsLocalesName

Get chat rooms of name

### messages

Object with class service messages
npm package: @plasma-platform/tm-service-currencies
Description: Service Currencies Api
Author: Kyrylo Voronoi
Latest version: 1.0.2

# Documentation

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

### Table of Contents

-   [ServiceCurrencies](#servicecurrencies)
    -   [getCurrencyExchangeRate](#getcurrencyexchangerate)
-   [getExchangeRateList](#getexchangeratelist)

## ServiceCurrencies

-   **See: <http://service-currencies.templatemonsterdev.com/doc/>**

Currencies API

### getCurrencyExchangeRate

-   **See: <http://service-currencies.templatemonsterdev.com/doc/#api-Currency-GetCurrency>**

Request Currency information

**Parameters**

-   `params` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
    -   `params.currency` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Currency iso3 code
    -   `params.date` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** Date in format 'YYYY-mm-dd'. (By default: current date)

**Examples**

```javascript
(async () => {
  const service = new Service(url);
  const request = await service.getCurrencyExchangeRate(params);
})();
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;any>** 

## getExchangeRateList

-   **See: <http://service-currencies.templatemonsterdev.com/doc/#api-Currency-GetCurrency>**

Get list of available currencies

**Parameters**

-   `params` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
    -   `params.date` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** Date in format 'YYYY-mm-dd'. (By default: current date)

**Examples**

```javascript
(async () => {
  const service = new Service(url);
  const request = await service.getExchangeRateList(date);
})();
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;any>**
npm package: @plasma-platform/tm-service-delivery
Description: Delivery Service API
Author: Kyrylo Voronoi
Latest version: 1.1.3

# Documentation

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

### Table of Contents

-   [DeliveryService](#deliveryservice)
    -   [messages](#messages)
    -   [getDeliveriesByOrderId](#getdeliveriesbyorderid)
    -   [getDeliveryByProductId](#getdeliverybyproductid)

## DeliveryService

-   **See: <http://service-delivery.templatemonsterdev.com/doc/>**

### messages

object with class service messages

### getDeliveriesByOrderId

-   **See: <http://service-delivery.dev/api/v1/deliveries/orders/:order_id>**

Get deliveries by order id

**Parameters**

-   `params` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
    -   `params.orderId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** ID of order.
    -   `params.page` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** 
    -   `params.perPage` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** 

**Examples**

```javascript
(async () => {
  const service = new DeliveryService(url, token);
  const request = await service.getDeliveriesByOrderId(params);
})();
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;any>** 

### getDeliveryByProductId

-   **See: <http://service-delivery.dev/api/v1/deliveries/orders/:order_id>**

DeliveryService - Get delivery by order and product ID

**Parameters**

-   `params` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
    -   `params.orderId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** ID of order.
    -   `params.productId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** ID of product.

**Examples**

```javascript
(async () => {
  const service = new DeliveryService(url, token);
  const request = await service.getDeliveryByProductId(params);
})();
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;any>**
npm package: @plasma-platform/tm-service-discounts
Description: Discounts Service API
Author: Vira Peretiatko
Latest version: 2.1.4

# Discounts Service Api

# Documentation

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

### Table of Contents

-   [DiscountService](#discountservice)
    -   [Parameters](#parameters)
    -   [messages](#messages)
    -   [applyDiscount](#applydiscount)
        -   [Examples](#examples)
    -   [getDiscountApplicability](#getdiscountapplicability)
        -   [Parameters](#parameters-1)
        -   [Examples](#examples-1)

## DiscountService

Discount Micro Service API

### Parameters

-   `url` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** service url

### messages

Object with class service messages

Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)

### applyDiscount

View discount

#### Examples

```javascript
To use
(async () => {
  const DiscountService = new DiscountService(url);
  const result = await DiscountService.viewDiscount();
})();
```

Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** array of posts

### getDiscountApplicability

Get discount applicability

#### Parameters

-   `code` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** promocode
-   `cart` **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** cart info
-   `items` **[array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** product from the cart

#### Examples

```javascript
To use
(async () => {
  const DiscountService = new DiscountService(url);
  const result = await DiscountService.getDiscountApplicability('sddf6gdfg6df', {}, []);
})();
```

Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** discount applicability to products provided with params
npm package: @plasma-platform/tm-service-loyalty
Description: Loyalty Program Service API
Author: Evgenii Latyshev
Latest version: 1.1.14

# Documentation

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

### Table of Contents

-   [LoyaltyProgramService](#loyaltyprogramservice)
    -   [Parameters](#parameters)
    -   [getLevels](#getlevels)
        -   [Examples](#examples)
    -   [getLevelsById](#getlevelsbyid)
        -   [Parameters](#parameters-1)
        -   [Examples](#examples-1)
    -   [getUserProfile](#getuserprofile)
        -   [Examples](#examples-2)

## LoyaltyProgramService

Loyalty Program Micro Service API SDK

### 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 token if available (optional, default `null`)

### getLevels

Get Loyalty Levels

#### Examples

```javascript
To use
(async () => {
  const LoyaltyProgramService = new LoyaltyProgramService(url, token);
  const list = await LoyaltyProgramService.getLevels();
})();
```

Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)** array of loyalty levels

### getLevelsById

Get Loyalty Level by id

#### Parameters

-   `id` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** level id

#### Examples

```javascript
To use
(async () => {
  const LoyaltyProgramService = new LoyaltyProgramService(url, token);
  const list = await LoyaltyProgramService.getLevelsById(id);
})();
```

Returns **[object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** object of loyalty level

### getUserProfile

Get Loyalty Levels

#### Examples

```javascript
To use
(async () => {
  const LoyaltyProgramService = new LoyaltyProgramService(url, token);
  const list = await LoyaltyProgramService.getUserProfile();
})();
```

Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** object of user profile
npm package: @plasma-platform/tm-service-mailer
Description: Mailer Service API
Author: Vira Peretiatko
Latest version: 1.0.3

# Documentation

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

### Table of Contents

-   [MailerService](#mailerservice)
    -   [messages](#messages)
-   [sendMail](#sendmail)

## MailerService

Mailer 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

### messages

Object with class service messages

## sendMail

Send mail

**Parameters**

-   `key` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** emails key
-   `email` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** users mail

**Examples**

_Send mail_

```javascript
(async () => {
  const MailerService = new MailerService(url);
  const result = await MailerService.sendMail('api-empty-checkout-free-ebook', 'test@gmail.com');
})();
```

Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** send email result
npm package: @plasma-platform/tm-service-navigations
Description: Navigastions Service API
Author: Andrii Balaniuk
Latest version: 2.0.1

# Navigations Service API

# Documentation

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

### Table of Contents

-   [NavigationsService](#navigationsservice)
    -   [Parameters](#parameters)
    -   [getNavigations](#getnavigations)
        -   [Parameters](#parameters-1)
        -   [Examples](#examples)
    -   [getNavigationByCode](#getnavigationbycode)
        -   [Parameters](#parameters-2)
        -   [Examples](#examples-1)

## NavigationsService

-   **See: <http://http://api.templatemonster.com/navigations/doc/>**

Navigations Micro Service API

### 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`)

### getNavigations

Get navigations list

#### Parameters

-   `args` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** options
    -   `args.tags` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** navigation tags
    -   `args.locale` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** navigation locale

#### Examples

_Get all navigations_

```javascript
(async () => {
  const Navigations = new NavigationsService('//api.templatemonster.com/navigations/v1/');
  const navigation = await Navigations.getNavigations();
})();
```

### getNavigationByCode

Get specific navigation by code

#### Parameters

-   `args` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** options
    -   `args.code` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** navigation code
    -   `args.locale` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** navigation locale

#### Examples

_Get specific navigation by code_

```javascript
(async () => {
  const Navigations = new NavigationsService('//api.templatemonster.com/navigations/v1/');
  const navigation = await Navigations.getNavigationByCode('header_top');
})();
```
npm package: @plasma-platform/tm-service-notifications
Description: Service Notifications Api
Author: Kyrylo Voronoi
Latest version: 1.1.0

# Documentation

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

### Table of Contents

-   [NotificationsService](#notificationsservice)
    -   [messages](#messages)
    -   [getResourceToken](#getresourcetoken)

## NotificationsService

-   **See: <http://service-notifications.templatemonsterdev.com/doc/>**

### messages

object with class service messages

### getResourceToken

Subscription - Get system centrifugo token based on resource id

**Parameters**

-   `params` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
    -   `params.resourceId` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** Resource ID (orderId for example) (required)
    -   `params.timestamp` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** UNIX Timestamp (required)

**Examples**

_Get membership plan info by ID_

```javascript
(async () => {
  const service = new NotificationsService(url);
  const response = await service.getResourceToken(params);
})();
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)>** Promise object represents info
npm package: @plasma-platform/tm-service-properties
Description: SDK for properties service
Author: Anton Nemtsev
Latest version: 0.0.3

# Documentation

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

### Table of Contents

-   [PropertiesService](#propertiesservice)
    -   [Parameters](#parameters)
    -   [messages](#messages)
    -   [get](#get)
        -   [Examples](#examples)
    -   [details](#details)
        -   [Parameters](#parameters-1)
        -   [Examples](#examples-1)
-   [Array](#array)
    -   [Properties](#properties)
-   [Propertie](#propertie)
    -   [Properties](#properties-1)

## PropertiesService

-   **See: <http://service-properties.templatemonsterdev.com/doc/>**

Properties 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

### messages

Object with class service messages

Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)

### get

Get properties list

#### Examples

_Read properties list_

```javascript
(async () => {
  const propertiesService = new PropertiesService('https://api.templatemonsterdev.com/properties/v1/');
  const list = await propertiesService.get();
})();
```

Returns **PropertiesList** array of properties

### details

Get specific propertie

#### Parameters

-   `name` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** propertie name

#### Examples

_Get propertie_

```javascript
(async () => {
  const propertiesService = new PropertiesService('https://api.templatemonsterdev.com/properties/v1/');
  const details = await propertiesService.details('softwareRequired');
})();
```

Returns **[Propertie](#propertie)** propertie

## Array

Properties list object

Type: PropertiesList

### Properties

-   `null-null` **[Array](#array)&lt;[Propertie](#propertie)>** array of properties

## Propertie

Propertie object

Type: [Propertie](#propertie)

### Properties

-   `id` **[number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)** post id
-   `title` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** post title
-   `body` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** post body