@ovh-api/over-the-box

Add typing to to ovh api over-the-box

Usage no npm install needed!

<script type="module">
  import ovhApiOverTheBox from 'https://cdn.skypack.dev/@ovh-api/over-the-box';
</script>

README

OVHCloud API client for over-the-box region Europe

This module contains all typing needed to use OvhCloud over-the-box APIs, with hi-level IntelliSense / Code Completion

NPM Version

Setup

With npm:

npm install --save @ovh-api/api
npm install --save @ovh-api/me
npm install --save @ovh-api/over-the-box
... Add all APIs you needs

Usage

import OvhEngine from '@ovh-api/api';
import apiMe from '@ovh-api/me';
import apiOverTheBox from '@ovh-api/over-the-box';

const ovhEngine = new OvhEngine({ 
    certCache: './cert-cache.json', // optional cache certificat on disk.
    accessRules: 'GET /overTheBox, GET /overTheBox/*, GET /me', // optional limit the requested privileges.
});

const api = {
    me: apiMe(ovhEngine),
    overTheBox: apiOverTheBox(ovhEngine),
}

const test = async () => {
    const { nichandle } = await api.me.$get();
    const data = await api.overTheBox.$get();
    console.log(`${nichandle} have the following services:`);
    console.log(data);
}