Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@ovh-soyoustart/email-domain

UrielCh36MIT3.1.11TypeScript support: included

Add typing to to ovh api email-domain

ovh, ovhCloud, api, typing, typescript

readme

OVHCloud API client for email-domain region Europe

This module contains all typing needed to use OvhCloud email-domain APIs, with hi-level IntelliSense / Code Completion

NPM Version

Setup

With npm:

npm install --save @ovh-api/api
npm install --save @ovh-soyoustart/me
npm install --save @ovh-soyoustart/email-domain
... Add all APIs you needs

Usage

import OvhEngine from '@ovh-api/api';
import apiMe from '@ovh-soyoustart/me';
import apiEmailDomain from '@ovh-soyoustart/email-domain';

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

const api = {
    me: apiMe(ovhEngine),
    emailDomain: apiEmailDomain(ovhEngine),
}

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