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

OVH API wrapper library for TypeScript

import { LicenseCpanelOrderConfiguration } from '../models/LicenseCpanelOrderConfiguration.js';
import { ServiceTerminationReasonEnum } from '../models/ServiceTerminationReasonEnum.js';
import { LicenseTask } from '../models/LicenseTask.js';
import { ServicesService } from '../models/ServicesService.js';
import { ServiceTerminationFutureUseEnum } from '../models/ServiceTerminationFutureUseEnum.js';
import { LicenseCpanelCpanel } from '../models/LicenseCpanelCpanel.js';
import { LicenseChangeIpStatus } from '../models/LicenseChangeIpStatus.js';
import OVHBase from '../ovh.js';
import '../models/LicenseOrderableCpanelCompatibilityInfos.js';
import '../models/LicenseOrderableCpanelVersionEnum.js';
import '../models/LicenseLicenseTypeEnum.js';
import '../models/LicenseActionType.js';
import '../models/LicenseTaskStateEnum.js';
import '../models/ServiceStateEnum.js';
import '../models/ServiceRenewType.js';
import '../models/ServiceRenewalTypeEnum.js';
import '../models/LicenseStateEnum.js';
import '../models/LicenseCpanelVersionEnum.js';
import '../models/LicenseChangeIpMessageEnum.js';
import '../endpoints.js';

declare class LicenseCpanelHandler {
    ovh: OVHBase;
    constructor(ovh: OVHBase);
    /** List available services */
    listCpanel: () => Promise<string[]>;
    /** Get the orderable CPanel versions */
    getCpanelOrderableVersions: () => Promise<LicenseCpanelOrderConfiguration[]>;
    /** Get this object properties */
    getCpanelByServiceName: (serviceName: string) => Promise<LicenseCpanelCpanel>;
    /** Alter this object properties */
    updateCpanelByServiceName: (serviceName: string, body: LicenseCpanelCpanel) => Promise<void>;
    /** Returns an array of ips where the license can be moved to */
    getCpanelAllowedDestinationIpByServiceName: (serviceName: string) => Promise<string[]>;
    /** Will tell if the ip can accept the license */
    getCpanelCanLicenseBeMovedToByServiceName: (serviceName: string) => Promise<LicenseChangeIpStatus>;
    /** Move this license to another Ip */
    postCpanelChangeIpByServiceName: (serviceName: string, body: {
        destinationIp: string;
    }) => Promise<LicenseTask>;
    /** Confirm termination of your service */
    confirmCpanelTerminationByServiceName: (serviceName: string, body: {
        commentary?: string;
        futureUse?: ServiceTerminationFutureUseEnum;
        reason?: ServiceTerminationReasonEnum;
        token: string;
    }) => Promise<string>;
    /** Get this object properties */
    getCpanelServiceInfosByServiceName: (serviceName: string) => Promise<ServicesService>;
    /** Alter this object properties */
    updateCpanelServiceInfosByServiceName: (serviceName: string, body: ServicesService) => Promise<void>;
    /** tasks linked to this license */
    getCpanelTasksByServiceName: (serviceName: string) => Promise<number[]>;
    /** Get this object properties */
    getCpanelTasksByServiceNameAndTaskId: (serviceName: string, taskId: number) => Promise<LicenseTask>;
    /** Terminate your service */
    postCpanelTerminateByServiceName: (serviceName: string) => Promise<string>;
}

export { LicenseCpanelHandler };