brightbox

A Node.JS module, which provides an object oriented wrapper for the Brightbox API.

:cloud: Installation

# Using npm
npm install --save brightbox

# Using yarn
yarn add brightbox

:clipboard: Example

var Brightbox = require("brightbox/lib/")
  , Credentials = require(__dirname + "/credentials")
  ;

Brightbox.options({
    auth: new Brightbox.auth(Credentials.clientId, Credentials.clientSecret)
});

// Users
console.log("Fetching users.");
Brightbox.users.list({}, function (err, users) {
    console.log(users);
    console.log("Fetching " + users[0].name);
    Brightbox.users.get({id: users[0].id}, function (err, user) {
        console.log(user);
        console.log("Fetching the server types.");
        Brightbox.server_types.list({}, function (err, server_types) {
            console.log(server_types);
        });
    });
});

:question: Get Help

There are few ways to get help:

1. Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
2. For bug reports and feature requests, open issues. :bug:
3. For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

BrightboxApis(options)

Creates a new Brightbox instance.

Params

• Object options: The options object.

options(opts)

Sets the global options.

Params

• Object opts: The options to set.

Return

• Brightbox The Brightbox instance.

request(opts, callback)

Runs requests to the API urls.

Params

• Object opts: Optional options.
• Function callback: The callback function.

Return

• Brightbox The Brightbox instance.

addAPIs(apis)

Adds the API to the instance.

Params

• Object apis: The APIs to add.

APIs

Below there are the available APIs you can access with this module. For documentation, please consider the Brightbox API Documentation 1.0.0.

For questions, you can always open a new issue.

• accounts

  • list
  • get
  • update
  • resetFtpPass

• api_clients

  • list
  • create
  • get
  • update
  • delete
  • resetSecret

• cloud_ips

  • list
  • create
  • get
  • update
  • delete
  • map
  • unmap

• collaborations

  • list
  • create
  • get
  • delete

• database_servers

  • list
  • create
  • get
  • update
  • delete
  • snapshot
  • reset_password
  • lock_resource

• database_snapshots

  • list
  • get
  • update
  • delete
  • snapshot
  • lock_resource
  • unlock_resource

• database_types

  • list
  • get

• firewall_policies

  • list
  • create
  • get
  • apply_to
  • remove
  • delete

• firewall_rules

  • create
  • get
  • update
  • delete

• images

  • list
  • create
  • get
  • update
  • delete
  • lock_resource
  • unlock_resource

• load_balancers

  • list
  • create
  • get
  • update
  • add_nodes
  • remove_nodes
  • add_listeners
  • remove_listeners
  • lock_resource
  • unlock_resource

• server_groups

  • list
  • create
  • get
  • update
  • add_servers
  • remove_servers
  • move_servers
  • delete

• server_types

  • list
  • get

• servers

  • list
  • create
  • get
  • update
  • delete
  • start
  • stop
  • reset
  • shutdown
  • activate_console
  • snapshot
  • lock_resource
  • unlock_resource

• user_collaborations

  • list
  • get
  • accept
  • reject
  • delete

• users

  • list
  • get
  • update

• zones

  • list
  • get

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like :rocket:

• —I love books! I will remember you after years if you buy me one. :grin: :book:

• —You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! :heart:

:scroll: License

MIT © Ionică Bizău