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

OVH API wrapper library for TypeScript

import { LicenseOptionLabel } from '../models/LicenseOptionLabel.js';
import { LicenseOption } from '../models/LicenseOption.js';
import { LicensePleskOrderConfiguration } from '../models/LicensePleskOrderConfiguration.js';
import { ServiceTerminationReasonEnum } from '../models/ServiceTerminationReasonEnum.js';
import { LicensePleskPlesk } from '../models/LicensePleskPlesk.js';
import { LicenseTask } from '../models/LicenseTask.js';
import { ServicesService } from '../models/ServicesService.js';
import { ServiceTerminationFutureUseEnum } from '../models/ServiceTerminationFutureUseEnum.js';
import { LicenseChangeIpStatus } from '../models/LicenseChangeIpStatus.js';
import OVHBase from '../ovh.js';
import '../models/LicenseLicenseTypeEnum.js';
import '../models/LicenseOrderablePleskCompatibilityInfos.js';
import '../models/LicensePleskApplicationSetEnum.js';
import '../models/LicensePotentialProblemPleskEnum.js';
import '../models/LicenseOrderablePleskDomainNumberEnum.js';
import '../models/LicensePleskVersionEnum.js';
import '../models/LicenseOrderableAntivirusEnum.js';
import '../models/LicenseOrderablePleskLanguagePackEnum.js';
import '../models/LicenseStateEnum.js';
import '../models/LicenseDomainNumberEnum.js';
import '../models/LicenseActionType.js';
import '../models/LicenseTaskStateEnum.js';
import '../models/ServiceStateEnum.js';
import '../models/ServiceRenewType.js';
import '../models/ServiceRenewalTypeEnum.js';
import '../models/LicenseChangeIpMessageEnum.js';
import '../endpoints.js';

declare class LicensePleskHandler {
    ovh: OVHBase;
    constructor(ovh: OVHBase);
    /** List available services */
    listPlesk: () => Promise<string[]>;
    /** Get the orderable Plesk versions and their associated compatibilities */
    getPleskOrderableVersions: () => Promise<LicensePleskOrderConfiguration[]>;
    /** Get this object properties */
    getPleskByServiceName: (serviceName: string) => Promise<LicensePleskPlesk>;
    /** Alter this object properties */
    updatePleskByServiceName: (serviceName: string, body: LicensePleskPlesk) => Promise<void>;
    /** Returns an array of ips where the license can be moved to */
    getPleskAllowedDestinationIpByServiceName: (serviceName: string) => Promise<string[]>;
    /** Will tell if the ip can accept the license */
    getPleskCanLicenseBeMovedToByServiceName: (serviceName: string) => Promise<LicenseChangeIpStatus>;
    /** Move this license to another Ip */
    postPleskChangeIpByServiceName: (serviceName: string, body: {
        destinationIp: string;
    }) => Promise<LicenseTask>;
    /** Confirm termination of your service */
    confirmPleskTerminationByServiceName: (serviceName: string, body: {
        commentary?: string;
        futureUse?: ServiceTerminationFutureUseEnum;
        reason?: ServiceTerminationReasonEnum;
        token: string;
    }) => Promise<string>;
    /** options attached to this license */
    getPleskOptionByServiceName: (serviceName: string) => Promise<LicenseOptionLabel[]>;
    /** release this Option */
    deletePleskOptionByServiceNameAndLabel: (label: LicenseOptionLabel, serviceName: string) => Promise<LicenseTask>;
    /** Get this object properties */
    getPleskOptionByServiceNameAndLabel: (label: LicenseOptionLabel, serviceName: string) => Promise<LicenseOption>;
    /** Get this object properties */
    getPleskServiceInfosByServiceName: (serviceName: string) => Promise<ServicesService>;
    /** Alter this object properties */
    updatePleskServiceInfosByServiceName: (serviceName: string, body: ServicesService) => Promise<void>;
    /** tasks linked to this license */
    getPleskTasksByServiceName: (serviceName: string) => Promise<number[]>;
    /** Get this object properties */
    getPleskTasksByServiceNameAndTaskId: (serviceName: string, taskId: number) => Promise<LicenseTask>;
    /** Terminate your service */
    postPleskTerminateByServiceName: (serviceName: string) => Promise<string>;
}

export { LicensePleskHandler };