@plasma-platform/service-support

0.0.7 • Public • Published

version nextVersion downloads license dependency


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

Short documentation

Table of Contents

SupportService

Support Micro Service API

Parameters

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

getHeaders

Get response headers

Parameters

  • response {Object} response data

Returns Object

getSupportByOrderId

Support - Get support by id + orderId

Parameters

  • params {Object} request parameters
    • params.supportId {Number} support id
    • params.orderId {String} order id
    • params.locale {String} locale. default: 'en'
    • params.checkAvailability {Number} Check availability paid support. default: 1

Returns Promise<any>

getSupportById

Support - Get support by id

Parameters

  • params {Object} request parameters
    • params.supportId {Number} support id
    • params.locale {String} locale. default: 'en'
    • params.checkAvailability {Number} Check availability paid support. default: 1

Returns Promise<any>

searchPaidSupportByPayments

Support - Search paid support by payments

Parameters

  • params {Object} request parameters
    • params.productType {String} Product type
    • params.productIds {String} Array of product id divided by comma (e.g. "55555,62222")
    • params.ordersIds {String} Array of order id divided by comma (e.g. "xxx1,az22")
    • params.productTypes {String} Array of product type divided by comma (e.g. "template,offer"), default: template
    • params.locale {String} 2 char locale (en, ru de, etc.). default: en
    • params.perPage {Number} Max items per one page (50 is max size)
    • params.page {Number} Page number to view

Returns Promise<any>

searchPaidSupportByProduct

Support - Search paid supports by product

Parameters

  • params {Object} request parameters
    • params.locale {String} 2 char locale (en, ru de, etc.). default: en
    • params.productIds {String} Array of product id divided by comma (e.g. "55555,62222")
    • params.ids {String} Array of support ids divided by comma (e.g. "2530,2531")
    • params.productTypes {String} Array of product type divided by comma (e.g. "template,offer"), default: template
    • params.perPage {Number} Max items per one page (50 is max size)
    • params.page {Number} Page number to view
    • params.checkAvailability {Number} Check availability paid support. default: 1

Returns Promise<any>

Package Sidebar

Install

npm i @plasma-platform/service-support

Weekly Downloads

1

Version

0.0.7

License

CC-BY-4.0

Unpacked Size

32.6 kB

Total Files

6

Last publish

Collaborators

  • alienmonster
  • ch-tm
  • viram