Productdelivery-api NPM

ProductDelivery API

About

ProductDelivery-API is a simple wrapper for the ProductDelivery API.

Installation

Use the package manager npm to install productdelivery-api:

npm install productdelivery-api

Usage

To use this package, you first need to create a client.

const pdAPI = require('productdelivery-api');
const client = new pdAPI('APIUrl', 'Default Token (Optional)');

(async () => {
    try {
        let request = await client.checkWhitelist('GuildID', 'RobloxID', 'Product Name');
        console.log(request); // Returns false
    }
    catch (error) {
        console.log(error);
    }
})();

Functions

Get Default Values

Name: getDefaultValues

Params:

value: apiURL, token

Example:

(async () => {
    try {
        let request = client.getDefaultValues(value);
        console.log(request);
    }
    catch (error) {
        console.log(error);
    }
})();

Check Whitelist

Name: checkWhitelist

Params:

guildid
robloxid
productname

Example:

(async () => {
    try {
        let request = await client.checkWhitelist('GuildID', 'RobloxID', 'Product Name');
        console.log(request);
    }
    catch (error) {
        console.log(error);
    }
})();

Get Guild Products

Name: getGuildProducts

Params:

guildid
overwriteToken: (optional)

Example:

(async () => {
    try {
        let request = await client.getGuildProducts('GuildID', 'Overwrite Token');
        console.log(request);
    }
    catch (error) {
        console.log(error);
    }
})();

Get User Products

Name: getUserProducts

Params:

guildid
robloxid
overwriteToken: (optional)

Example:

(async () => {
    try {
        let request = await client.getUserProducts('GuildID', 'RobloxID', 'Overwrite Token');
        console.log(request);
    }
    catch (error) {
        console.log(error);
    }
})();

Create Purchase

Name: createPurchase

Params:

guildid
robloxid
productname
overwriteToken: (optional)

Example:

(async () => {
    try {
        let request = await client.createPurchase('GuildID', 'RobloxID', 'Product Name', 'Overwrite Token');
        console.log(request);
    }
    catch (error) {
        console.log(error);
    }
})();