@plasma-platform/service-supports v0.0.3

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

Short documentation

Table of Contents

• SupportsService
  • Parameters
  • getHeaders
    • Parameters
  • getSupportByOrderId
    • Parameters
  • getSupportById
    • Parameters
  • searchPaidSupportsByPayments
    • Parameters
  • searchPaidSupportsByProduct
    • Parameters

SupportsService

Supports 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

Returns Promise<any>

getSupportById

Support - Get support by id

Parameters

• params {Object} request parameters
  • params.supportId {Number} support id
  • params.orderId {String} order id

Returns Promise<any>

searchPaidSupportsByPayments

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>

searchPaidSupportsByProduct

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

Returns Promise<any>