https://github.com/datejer/shoppy.gg

📦 A simple shoppy.gg wrapper to access the Shoppy API.
https://github.com/datejer/shoppy.gg

api npm package shoppy

Last synced: 8 days ago
JSON representation

📦 A simple shoppy.gg wrapper to access the Shoppy API.

• Host: GitHub
• URL: https://github.com/datejer/shoppy.gg
• Owner: datejer
• Created: 2018-12-31T18:08:14.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-03-02T09:07:53.000Z (over 5 years ago)
• Last Synced: 2024-10-12T23:43:30.748Z (25 days ago)
• Topics: api, npm, package, shoppy
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/shoppy.gg
• Size: 11.7 KB
• Stars: 12
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Shoppy.gg

[![author](https://img.shields.io/badge/author-ejer-success.svg)](http://ejer.ga/) ![version](https://img.shields.io/npm/v/shoppy.gg.svg?color=success&label=version) ![downloads](https://img.shields.io/npm/dt/shoppy.gg.svg)

[![NPM](https://nodei.co/npm/shoppy.gg.png?compact=true)](https://nodei.co/npm/shoppy.gg/)

A simple Shoppy.gg wrapper to access the Shoppy API.

This package has a lot more API endpoints than `shoppy` and unlike `shoppy` IS actually working.

```js

const Shoppy = require('Shoppy.gg');

const API = new Shoppy.API(apiKey)

```

# Installation

```javascript

$ npm install shoppy.gg

```

# API

To make Shoppy.gg API calls you need to initate the Shoppy.API class by passing it your Shoppy.gg API Key.

All calls return a promise with the data from the response. If there is an error making the request or the status of the request from Shoppy is not "success" the promise will be rejected.

# Example usage

```javascript

const Shoppy = require('Shoppy.gg');

const API = new Shoppy.API(apiKey)

// This function returns information about a specific order based on it's ID.

API.getSpecificOrder(ID)

  .then(data => {})

  .catch(items => {

	console.log(items);

  });

// This funtion returns all feedback left on your profile.

API.getFeedback()

  .then(data => {})

  .catch(items => {

	console.log(items);

  });

```

# Available Functions (API Endpoints)

### getOrders()

Retrieves all orders.

### getSpecificOrder(ID)

Retrieves a specific order.

### getProducts()

Retrieves all products.

### getSpecificProduct(ID)

Retrieves a specific product.

### updateProduct(ID, {})

Updates a specific product.

### getCoupons()

Retrieves all coupons.

### getSpecificCoupon(ID)

Retrieves a specific coupon

### getQueries()

Retrieves all queries.

### getSpecificQuery(ID)

Retrieves a specific query.

### getWebhooks()

Retrieves all webhooks.

### getSpecificWebhook(ID)

Retrieves a specific webhook.

### getFeedback()

Retrieves all feedback.

### getSpecificFeedback(ID)

Retrieves a specific feedback.

### getTickets()

Retrieves all tickets.

### getSpecificTicket(ID)

Retrieves a specific ticket.

### getNotifications()

Retrieves all notifications.

### markAllNotificationsAsRead()

Marks all notifications as read.

### markNotificationAsRead(ID)

Marks a specific notification as read.

### getUser()

Retrieves your user info.

### getSettings()

Retrieves your settings.

### updateSettings({})

Updates your settings.