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

OVH API wrapper library for TypeScript

import { DeskaasPasswordPolicy } from '../models/DeskaasPasswordPolicy.js';
import { ServiceTerminationReasonEnum } from '../models/ServiceTerminationReasonEnum.js';
import { ServicesService } from '../models/ServicesService.js';
import { ServiceTerminationFutureUseEnum } from '../models/ServiceTerminationFutureUseEnum.js';
import { DeskaasUser } from '../models/DeskaasUser.js';
import { DeskaasTask } from '../models/DeskaasTask.js';
import { DeskaasDeskaas } from '../models/DeskaasDeskaas.js';
import OVHBase from '../ovh.js';
import '../models/ServiceStateEnum.js';
import '../models/ServiceRenewType.js';
import '../models/ServiceRenewalTypeEnum.js';
import '../models/DeskaasUserStateEnum.js';
import '../models/DeskaasUserActivationStateEnum.js';
import '../models/DeskaasTaskStateEnum.js';
import '../models/DeskaasStateEnum.js';
import '../endpoints.js';

declare class DeskaasHandler {
    ovh: OVHBase;
    constructor(ovh: OVHBase);
    /** List available services */
    list: () => Promise<string[]>;
    /** Get this object properties */
    getByServiceName: (serviceName: string) => Promise<DeskaasDeskaas>;
    /** Change the Virtual Desktop alias */
    updateAliasByServiceName: (serviceName: string, body: {
        alias: string;
    }) => Promise<DeskaasTask>;
    /** Launch a contact change procedure */
    launchChangeContactByServiceName: (serviceName: string, body: {
        contactAdmin?: string;
        contactBilling?: string;
        contactTech?: string;
    }) => Promise<number[]>;
    /** Confirm termination of your service */
    confirmTerminationByServiceName: (serviceName: string, body: {
        commentary?: string;
        futureUse?: ServiceTerminationFutureUseEnum;
        reason?: ServiceTerminationReasonEnum;
        token: string;
    }) => Promise<string>;
    /** New console access */
    postConsoleByServiceName: (serviceName: string) => Promise<DeskaasTask>;
    /** Get the current password policy for your Desktop As A Service */
    getPasswordPolicyByServiceName: (serviceName: string) => Promise<DeskaasPasswordPolicy>;
    /** Reboot the Operating system of the Cloud Desktop. */
    postRebootByServiceName: (serviceName: string) => Promise<DeskaasTask>;
    /** Refresh the Operating system of the Desktop As A Service. All your personnal data are kept. */
    postRefreshByServiceName: (serviceName: string) => Promise<DeskaasTask>;
    /** Get this object properties */
    getServiceInfosByServiceName: (serviceName: string) => Promise<ServicesService>;
    /** Alter this object properties */
    updateServiceInfosByServiceName: (serviceName: string, body: ServicesService) => Promise<void>;
    /** Tasks associated with this Desktop As A Service */
    getTaskByServiceName: (serviceName: string) => Promise<number[]>;
    /** Get this object properties */
    getTaskByServiceNameAndTaskId: (serviceName: string, taskId: number) => Promise<DeskaasTask>;
    /** Terminate your service */
    postTerminateByServiceName: (serviceName: string) => Promise<string>;
    /** Upgrading the Desktop As A Service to another profile. The Virtual Desktop will not be available during upgrade and has to be restarted. You cannot downgrade a Virtual Desktop */
    postUpgradeByServiceName: (serviceName: string, body: {
        newReference?: string;
        planCode?: string;
    }) => Promise<DeskaasTask>;
    /** Get this object properties */
    getUserByServiceName: (serviceName: string) => Promise<DeskaasUser>;
    /** Change Desktop As A Service user password */
    updateUserPasswordByServiceName: (serviceName: string, body: {
        password?: string;
    }) => Promise<DeskaasTask>;
    /** Change Desktop As A Service user properties */
    updateUserPropertiesByServiceName: (serviceName: string, body: {
        email?: string;
    }) => Promise<DeskaasTask>;
    /** Tasks associated with this User */
    getUserTaskByServiceName: (serviceName: string) => Promise<number[]>;
    /** Get this object properties */
    getUserTaskByServiceNameAndTaskId: (serviceName: string, taskId: number) => Promise<DeskaasTask>;
}

export { DeskaasHandler };