npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@plasma-platform/tm-service-orders

v2.1.9

Published

Service Orders Api

Downloads

5

Readme

Documentation

Table of Contents

OrdersService

messages

object with class service messages

changeOrderPhoneNumber

Orders - Change the phone number of the order

Parameters

  • params object
    • params.orderId string ID of order (required).
    • params.phoneNumber string order phone number (required).

Examples

(async () => {
  const service = new Service(url, token);
  const request = await service.changeOrderPhoneNumber(orderId);
})();

Returns Promise<any>

checkOrders

Check orders

Parameters

  • params object params object
    • params.productType string Type of product. Allowed values: 'template', 'offer', 'membership'.
    • params.productIds string ID's of products
    • params.orderIds string ID's of orders
    • params.userId string Customer's ID
    • params.email string Customer's email
    • params.status number Order status
    • params.dateFrom string Date range start
    • params.dateTo string Date range end
    • params.paidOnly boolean Search only paid orders
    • params.strict boolean Strict search mode

Examples

(async () => {
  const service = new Service('http://service-orders.dev/api/v2/');
  const request = await service.checkOrders(params);
})();

Returns Promise<any>

getListOfUserOrders

Get list of users orders

Parameters

  • params object params object
    • params.page number page number to view.
    • params.perPage number records per page.
    • params.productType string type of product. Allowed values: 'template', 'offer', 'membership'.
    • params.productIds string ID's of products.
    • params.orderIds string ID's of orders.
    • params.status number order status
    • params.email number Customer's email
    • params.dateFrom number Date range start
    • params.dateTo number Date range end
    • params.paidOnly number Search only paid orders
    • params.strict number Strict search mode

Examples

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

Returns Promise<any>

getOrderById

Get order by ID

Parameters

Examples

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

Returns Promise<any>

getOrderByIdPublic

Orders - Get order public data

Parameters

  • orderId string ID of order (required).

Examples

(async () => {
  const service = new Service(url);
  const request = await service.getOrderByIdPublic(orderId);
})();

Returns Promise<any>

checkDownloadLinkStatusByToken

Check download link status by access token

Parameters

  • params object params object
    • params.orderId string Order id (required).
    • params.productId number Product id (required).

Examples

(async () => {
  const service = new Service('http://service-orders.dev/api/v1/', token);
  const request = await service.checkDownloadLinkStatusByToken(params);
})();

Returns Promise<any>

restoreDownloadLinkStatusByToken

Restore download link status by access token

Parameters

  • params object params object
    • params.orderId string Order id (required).
    • params.productId number Product id (required).

Examples

(async () => {
  const service = new Service('http://service-orders.dev/api/v1/', token);
  const request = await service.restoreDownloadLinkStatusByToken(params);
})();

Returns Promise<any>