node-ovh-ts/dist/handlers/LicenseOffice.d.ts

OVH API wrapper library for TypeScript

import { LicenseOfficeOfficeTenant } from '../models/LicenseOfficeOfficeTenant.js';
import { LicenseOfficeStatistics } from '../models/LicenseOfficeStatistics.js';
import { LicenseOfficeOfficeUser } from '../models/LicenseOfficeOfficeUser.js';
import { CoreTypesCountryEnum } from '../models/CoreTypesCountryEnum.js';
import { ServicesService } from '../models/ServicesService.js';
import { LicenseOfficeLicenceEnum } from '../models/LicenseOfficeLicenceEnum.js';
import { LicenseOfficeOfficeTask } from '../models/LicenseOfficeOfficeTask.js';
import { LicenseOfficeOfficeDomain } from '../models/LicenseOfficeOfficeDomain.js';
import OVHBase from '../ovh.js';
import '../models/LicenseOfficeServiceStateEnum.js';
import '../models/LicenseOfficeServiceTypeEnum.js';
import '../models/LicenseOfficeStatisticsLine.js';
import '../models/LicenseOfficeUserStateEnum.js';
import '../models/ServiceStateEnum.js';
import '../models/ServiceRenewType.js';
import '../models/ServiceRenewalTypeEnum.js';
import '../models/LicenseOfficeTaskStatusEnum.js';
import '../models/LicenseOfficeDomainStateEnum.js';
import '../endpoints.js';

declare class LicenseOfficeHandler {
    ovh: OVHBase;
    constructor(ovh: OVHBase);
    /** List available services */
    listOffice: () => Promise<string[]>;
    /** Get this object properties */
    getOfficeByServiceName: (serviceName: string) => Promise<LicenseOfficeOfficeTenant>;
    /** Alter this object properties */
    updateOfficeByServiceName: (serviceName: string, body: LicenseOfficeOfficeTenant) => Promise<void>;
    /** Domain associated to this office tenant */
    getOfficeDomainByServiceName: (serviceName: string) => Promise<string[]>;
    /** Get this object properties */
    getOfficeDomainByServiceNameAndDomainName: (domainName: string, serviceName: string) => Promise<LicenseOfficeOfficeDomain>;
    /** Tasks associated to this office tenant */
    getOfficePendingTaskByServiceName: (serviceName: string) => Promise<number[]>;
    /** Get this object properties */
    getOfficePendingTaskByServiceNameAndId: (id: number, serviceName: string) => Promise<LicenseOfficeOfficeTask>;
    /** Get this object properties */
    getOfficeServiceInfosByServiceName: (serviceName: string) => Promise<ServicesService>;
    /** Alter this object properties */
    updateOfficeServiceInfosByServiceName: (serviceName: string, body: ServicesService) => Promise<void>;
    /** Shows the subscriptions' usage statistics for the given time period */
    getOfficeUsageStatisticsByServiceName: (serviceName: string) => Promise<LicenseOfficeStatistics[]>;
    /** Accounts associated to this office tenant */
    getOfficeUserByServiceName: (serviceName: string) => Promise<string[]>;
    /** Create new office user */
    createOfficeUserByServiceName: (serviceName: string, body: {
        domain: string;
        firstName?: string;
        lastName?: string;
        licence: LicenseOfficeLicenceEnum;
        login: string;
        usageLocation?: CoreTypesCountryEnum;
    }) => Promise<LicenseOfficeOfficeTask>;
    /** Delete existing office user */
    deleteOfficeUserByServiceNameAndActivationEmail: (activationEmail: string, serviceName: string) => Promise<LicenseOfficeOfficeTask>;
    /** Get this object properties */
    getOfficeUserByServiceNameAndActivationEmail: (activationEmail: string, serviceName: string) => Promise<LicenseOfficeOfficeUser>;
    /** Alter this object properties */
    updateOfficeUserByServiceNameAndActivationEmail: (activationEmail: string, serviceName: string, body: LicenseOfficeOfficeUser) => Promise<void>;
    /** Change or reset  user's password */
    updateOfficeUserPasswordByServiceNameAndActivationEmail: (activationEmail: string, serviceName: string, body: {
        notifyEmail?: string;
        password?: string;
        shouldSendMail: boolean;
    }) => Promise<LicenseOfficeOfficeTask>;
}

export { LicenseOfficeHandler };