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

OVH API wrapper library for TypeScript

import { DedicatedServerBackupFtp } from '../models/DedicatedServerBackupFtp.js';
import { DedicatedHousingTask } from '../models/DedicatedHousingTask.js';
import { DedicatedServerBackupFtpAcl } from '../models/DedicatedServerBackupFtpAcl.js';
import { DedicatedHousingApcOrderable } from '../models/DedicatedHousingApcOrderable.js';
import { DedicatedHousingHousing } from '../models/DedicatedHousingHousing.js';
import { DedicatedServerTask } from '../models/DedicatedServerTask.js';
import { ServicesService } from '../models/ServicesService.js';
import OVHBase from '../ovh.js';
import '../models/DedicatedServerBackupStorageTypeEnum.js';
import '../models/DedicatedTaskStatusEnum.js';
import '../models/DedicatedHousingTaskFunctionEnum.js';
import '../models/DedicatedHousingDatacenterEnum.js';
import '../models/DedicatedHousingNetworkInfo.js';
import '../models/DedicatedHousingIpInfo.js';
import '../models/DedicatedHousingLinkInfo.js';
import '../models/DedicatedHousingOptions.js';
import '../models/DedicatedTaskFunctionEnum.js';
import '../models/ServiceStateEnum.js';
import '../models/ServiceRenewType.js';
import '../models/ServiceRenewalTypeEnum.js';
import '../endpoints.js';

declare class DedicatedHousingHandler {
    ovh: OVHBase;
    constructor(ovh: OVHBase);
    /** List available services */
    listHousing: () => Promise<string[]>;
    /** Get this object properties */
    getHousingByServiceName: (serviceName: string) => Promise<DedicatedHousingHousing>;
    /** Terminate your Backup FTP service, ALL DATA WILL BE PERMANENTLY DELETED */
    deleteHousingFeaturesBackupFTPByServiceName: (serviceName: string) => Promise<DedicatedServerTask>;
    /** Get this object properties */
    getHousingFeaturesBackupFTPByServiceName: (serviceName: string) => Promise<DedicatedServerBackupFtp>;
    /** Create a new Backup FTP space */
    createHousingFeaturesBackupFTPByServiceName: (serviceName: string) => Promise<DedicatedServerTask>;
    /** List of IP blocks (and protocols to allow on these blocks) authorized on your backup FTP */
    listHousingFeaturesBackupFTPAccessByServiceName: (serviceName: string) => Promise<string[]>;
    /** Create a new Backup FTP ACL */
    createHousingFeaturesBackupFTPAccessByServiceName: (serviceName: string, body: {
        cifs: boolean;
        ftp?: boolean;
        ipBlock: string;
        nfs: boolean;
    }) => Promise<DedicatedServerTask>;
    /** Revoke this ACL */
    deleteHousingFeaturesBackupFTPAccessByServiceNameAndIpBlock: (ipBlock: string, serviceName: string) => Promise<DedicatedServerTask>;
    /** Get this object properties */
    getHousingFeaturesBackupFTPAccessByServiceNameAndIpBlock: (ipBlock: string, serviceName: string) => Promise<DedicatedServerBackupFtpAcl>;
    /** Alter this object properties */
    updateHousingFeaturesBackupFTPAccessByServiceNameAndIpBlock: (ipBlock: string, serviceName: string, body: DedicatedServerBackupFtpAcl) => Promise<void>;
    /** Get all IP blocks that can be used in the ACL */
    getHousingFeaturesBackupFTPAuthorizableBlocksByServiceName: (serviceName: string) => Promise<string[]>;
    /** Change your Backup FTP password */
    updateHousingFeaturesBackupFTPPasswordByServiceName: (serviceName: string) => Promise<DedicatedServerTask>;
    /** Is an APC orderable for this housing bay */
    getHousingOrderableAPCByServiceName: (serviceName: string) => Promise<DedicatedHousingApcOrderable>;
    /** Get this object properties */
    getHousingServiceInfosByServiceName: (serviceName: string) => Promise<ServicesService>;
    /** Alter this object properties */
    updateHousingServiceInfosByServiceName: (serviceName: string, body: ServicesService) => Promise<void>;
    /** View task list */
    getHousingTaskByServiceName: (serviceName: string) => Promise<number[]>;
    /** Get this object properties */
    getHousingTaskByServiceNameAndTaskId: (serviceName: string, taskId: number) => Promise<DedicatedHousingTask>;
    /** this action stop the task progression if it's possible */
    postHousingTaskCancelByServiceNameAndTaskId: (serviceName: string, taskId: number) => Promise<void>;
}

export { DedicatedHousingHandler };