squarecloud-api v1.0.4

Installation

$ npm install squarecloud-api

Setting Up

First create an instance for the API:

const { SquareCloudAPI } = require('squarecloud-api')

const api = new SquareCloudAPI('Your API Token')

Get your token at My Account in the SquareCloud Dashboard.

Getting user's informations

// If the ID is not provided it will get your own informations
const user = await api.getUser('User Discord ID') 

// To get private properties you have to check if you have access:
if (user.hasAccess()) {
  console.log(user.applications)
}

Using Applications

There are two ways for getting applications.

First

const user = await api.getUser()

// Through the array from the user (Only available if you have access to it)
const application = user.applications[0]

Second

// Using the Application ID
const application = await api.getApplication('ID')

Getting Applications Information

Status

const application = await api.getApplication('ID')

// Returns a bunch of info about the current status of the app
console.log(await application.getStatus())

Logs

const application = await api.getApplication('ID')

// If `true` it will get the full logs url
// If `false` or blank it will get only the recent logs string
console.log(await application.getLogs(true))

Managing Applications

Start, Stop & Restart

const application = await api.getApplication('ID')

// Every single method will return `true` if it is successfuly executed

await application.start()

await application.stop() 

await application.restart()

Backup

const application = await api.getApplication('ID')

// Generates a backup and returns its download url
console.log(await application.backup())