plasma-order-api-client-js

    1.0.9 • Public • Published

    Orders

    Kind: global class

    new Orders()

    Orders API JS client.

    In order to use Orders API you should create an instance of this class.

    import Orders from "tm-orders-api-client-js";
    const products = new Orders ('http://service-orders.dev/api/v2', 'en');
    

    orders.getListOfUsersOrders(token, params) ⇒ Array

    Get list of users orders

    Kind: instance method of Orders
    Returns: Array -

    [
    {
    "affiliate_id": "TM",
    "order_id": "NDrMh3S3XvSt0LfbHoWh",
    "user_id": "124088",
    "date": 1481166873,
    "status": 1,
    "amount": "138",
    "locale": "EN",
    "project_id": "0",
    "merchantTransactionId": "",
    "merchantSystem": "PayPal",
    "products": [
    {
    "id": "52995",
    "class": "template",
    "price": "89",
    "license": "single site",
    "products": []
    },
    {
    "id": "53001",
    "class": "template",
    "price": "75",
    "license": "single site",
    "products": []
    },
    {
    "id": "55932",
    "class": "template",
    "price": "11",
    "license": "single site",
    "products": [],
    "name": "PRO Industry PSD Template",
    "url": "/psd-templates/pro-industry-psd-template-55932.html",
    "type": "PSD Template",
    "image": "55932-original.jpg"
    }
    ]
    }, ...]

    Param Type Description
    token String User token
    params Object list of orders parameters
       {    page: Number,    per-page: Number,    product-type: String,    product-ids: String,    ids: String   } 

    orders.getOrderById(token, ID) ⇒ Object

    Get Order By ID

    Kind: instance method of Orders
    Returns: Object -

    {
    "affiliate_id": "TM",
    "order_id": "NDrMh3S3XvSt0LfbHoWh",
    "user_id": "124088",
    "date": 1481166873,
    "status": 1,
    "amount": "138",
    "locale": "EN",
    "project_id": "0",
    "merchantTransactionId": "",
    "merchantSystem": "PayPal",
    "products": [
    {
    "id": "52995",
    "class": "template",
    "price": "89",
    "license": "single site",
    "products": []
    },
    {
    "id": "53001",
    "class": "template",
    "price": "75",
    "license": "single site",
    "products": []
    },
    {
    "id": "55932",
    "class": "template",
    "price": "11",
    "license": "single site",
    "products": [],
    "name": "PRO Industry PSD Template",
    "url": "/psd-templates/pro-industry-psd-template-55932.html",
    "type": "PSD Template",
    "image": "55932-original.jpg"
    }
    ]
    }

    Param Type Description
    token String User token
    ID Number Order ID

    orders.restoreDownloadLink(token, orderID, productID) ⇒ Object

    Restore Download Link

    Kind: instance method of Orders
    Returns: Object -

    {
    "orderId": "xdtGS1apwbLKmv9ZXOlV",
    "productId": 123,
    "link": "http://dddd.ccc/dgdfgdfg",
    "downloadStatus": "inZipper",
    "isExpired": false,
    "rate": 1,
    "zipperTime": 1
    }
    

    Param Type Description
    token String User token
    orderID Number Order ID
    productID Number Product ID

    orders.checkDownloadLink(token, orderID, productID) ⇒ Object

    Check Download Link

    Kind: instance method of Orders
    Returns: Object -

    {
    "orderId": "xdtGS1apwbLKmv9ZXOlV",
    "productId": 123,
    "link": "http://dddd.ccc/dgdfgdfg",
    "downloadStatus": "inZipper",
    "isExpired": false,
    "rate": 1,
    "zipperTime": 1
    }
    

    Param Type Description
    token String User token
    orderID Number Order ID
    productID Number Product ID

    orders._isValidId(id) ⇒ Bool

    Return Correct id or not

    Kind: instance method of Orders

    Param Type Description
    id Number Product id

    orders._fetchRequest(url, token) ⇒ Promise

    Return Fetch Promise

    Kind: instance method of Orders

    Param Type Description
    url String Where request go
    token String auth user token

    Keywords

    none

    Install

    npm i plasma-order-api-client-js

    DownloadsWeekly Downloads

    8

    Version

    1.0.9

    License

    MIT

    Last publish

    Collaborators

    • soulwish
    • tmrdowner
    • ch-tm
    • viram
    • kyrylovoronoi
    • stevenreed