# tm-service-orders

> TM service api

Latest version **1.1.1** (published 2017-11-22) · CC-BY-4.0 license · 0 weekly downloads

## Install

```sh
npm install tm-service-orders
pnpm add tm-service-orders
yarn add tm-service-orders
bun add tm-service-orders
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2017-11-22 |
| First published | 2017-11-21 |
| Weekly downloads | 0 |
| License | CC-BY-4.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 15 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Kyrylo Voronoi |
| Maintainers | shaggrath |
| Keywords | TM Micro Service, Template Monster, API |

## Links

- npm: https://www.npmjs.com/package/tm-service-orders
- Repository: git@gitlab.com:TemplateMonster/PlasmaPlatform/Frontend/Services/tm-service-orders
- npm.io page: https://npm.io/package/tm-service-orders

## Dependencies (15)

- [husky](https://npm.io/package/husky.md) ^0.14.3
- [rimraf](https://npm.io/package/rimraf.md) ^2.6.2
- [babel-cli](https://npm.io/package/babel-cli.md) ^6.26.0
- [urlencode](https://npm.io/package/urlencode.md) ^1.1.0
- [babel-core](https://npm.io/package/babel-core.md) ^6.26.0
- [joi-browser](https://npm.io/package/joi-browser.md) ^10.6.1
- [npm-run-all](https://npm.io/package/npm-run-all.md) ^4.1.1
- [babel-minify](https://npm.io/package/babel-minify.md) ^0.2.0
- [babel-polyfill](https://npm.io/package/babel-polyfill.md) ^6.26.0
- [tm-service-api](https://npm.io/package/tm-service-api.md) ^2.0.4
- [babel-preset-env](https://npm.io/package/babel-preset-env.md) ^1.6.1
- [isomorphic-fetch](https://npm.io/package/isomorphic-fetch.md) ^2.2.1
- [babel-preset-stage-0](https://npm.io/package/babel-preset-stage-0.md) ^6.24.1
- [babel-plugin-es6-promise](https://npm.io/package/babel-plugin-es6-promise.md) ^1.1.1
- [@plasma-platform/tm-message-hook](https://npm.io/package/@plasma-platform/tm-message-hook.md) ^1.0.3

## Recent versions

- 1.1.1 (latest) — 2017-11-22
- 1.1.0 — 2017-11-21

## README

# Documentation

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

## OrdersService

-   **See: <http://service-orders.dev/doc/>**

### messages

object with class service messages

### checkDownloadLinkStatus

-   **See: <http://service-orders.dev/api/v1/orders/:orderId/:productId/download-link>**

Download link status (check)

**Parameters**

-   `orderId`  {string} - Order id (required).
-   `productId`  {number} - Product id (required).

**Examples**

```javascript
(async () => {
  const service = new Service('http://service-orders.dev/api/v1/', token);
  const request = await service.checkDownloadLinkStatus('NDrMh3S3XvSt0LfbHoWh', 222);
})();
```

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

### restoreDownloadLinkStatus

-   **See: <http://service-orders.dev/api/v1/orders/:orderId/:productId/download-link>**

Download link status (restore)

**Parameters**

-   `orderId`  {string} - Order id (required).
-   `productId`  {number} - Product id (required).

**Examples**

```javascript
(async () => {
  const service = new Service('http://service-orders.dev/api/v1/', token);
  const request = await service.restoreDownloadLinkStatus('NDrMh3S3XvSt0LfbHoWh', 222);
})();
```

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

### getListOfUserOrders

-   **See: <http://service-orders.dev/api/v2/orders>**

Get list of users orders

**Parameters**

-   `props` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
-   `page` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** page number to view.
-   `perPage` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** records per page.
-   `productType` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** type of product. Allowed values: 'template', 'offer', 'membership', 'weblium', 'subscription'.
-   `productIds` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ID's of products.
-   `orderIds` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ID's of orders.
-   `status` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** order status

**Examples**

```javascript
(async () => {
  const service = new Service('http://service-orders.dev/api/v2/', token);
  const request = await service.getListOfUserOrders({ page: 1, ids: 'NDrMh3S3XvSt0LfbHoWh' });
})();
```

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

### getOrderById

-   **See: <http://service-orders.dev/api/v2/orders/:id>**

Get order by ID

**Parameters**

-   `orderId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ID of order.

**Examples**

```javascript
(async () => {
  const service = new Service('http://service-orders.dev/api/v2/', token);
  const request = await service.getOrderById('NDrMh3S3XvSt0LfbHoWh');
})();
```

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

### getOrderInfo

-   **See: <http://service-orders.dev/api/v2/orders>**

Get order info

**Parameters**

-   `args` **[object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** Arguments for payments
    -   `args.page` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Page number to view
    -   `args.perPage` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Records per page
    -   `args.productType` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Type of product
    -   `args.productIds` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ID's of products
    -   `args.ids` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** ID's of orders
    -   `args.userId` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Customer's ID
    -   `args.email` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Customer's email
    -   `args.status` **[number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number)** Order status
    -   `args.dateFrom` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Date range start
    -   `args.dateTo` **[string](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** Date range end

**Examples**

```javascript
(async () => {
  const service = new Service('http://service-orders.dev/api/v2/', token);
  const request = await service.getOrderById('NDrMh3S3XvSt0LfbHoWh');
})();
```

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

---
_Source: https://npm.io/package/tm-service-orders · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
