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

OVH API wrapper library for TypeScript

import { OvhcloudconnectKey } from '../models/OvhcloudconnectKey.js';
import { OvhcloudconnectService } from '../models/OvhcloudconnectService.js';
import { OvhcloudconnectTo } from '../models/OvhcloudconnectTo.js';
import { ServicesService } from '../models/ServicesService.js';
import { ServiceTerminationFutureUseEnum } from '../models/ServiceTerminationFutureUseEnum.js';
import { OvhcloudconnectMetrics } from '../models/OvhcloudconnectMetrics.js';
import { OvhcloudconnectInterface } from '../models/OvhcloudconnectInterface.js';
import { OvhcloudconnectDatacenter } from '../models/OvhcloudconnectDatacenter.js';
import { OvhcloudconnectTask } from '../models/OvhcloudconnectTask.js';
import { OvhcloudconnectDiagnostic } from '../models/OvhcloudconnectDiagnostic.js';
import { OvhcloudconnectPopConfig } from '../models/OvhcloudconnectPopConfig.js';
import { OvhcloudconnectDiagnosticConfiguration } from '../models/OvhcloudconnectDiagnosticConfiguration.js';
import { OvhcloudconnectDatacenterExtraConfig } from '../models/OvhcloudconnectDatacenterExtraConfig.js';
import { OvhcloudconnectDatacenterConfig } from '../models/OvhcloudconnectDatacenterConfig.js';
import { ServiceTerminationReasonEnum } from '../models/ServiceTerminationReasonEnum.js';
import { OvhcloudconnectSendKeyAnswer } from '../models/OvhcloudconnectSendKeyAnswer.js';
import { OvhcloudconnectUpdate } from '../models/OvhcloudconnectUpdate.js';
import OVHBase from '../ovh.js';
import '../models/OvhcloudconnectServiceProviderEnum.js';
import '../models/OvhcloudconnectKeyStatusEnum.js';
import '../models/OvhcloudconnectServicePortEnum.js';
import '../models/OvhcloudconnectServiceBandwidthEnum.js';
import '../models/OvhcloudconnectServiceStatusEnum.js';
import '../models/ServiceStateEnum.js';
import '../models/ServiceRenewType.js';
import '../models/ServiceRenewalTypeEnum.js';
import '../models/OvhcloudconnectMetricsValue.js';
import '../models/OvhcloudconnectInterfaceMetricsUnitEnum.js';
import '../models/OvhcloudconnectInterfaceTerminationTypeEnum.js';
import '../models/OvhcloudconnectInterfaceLightStatusEnum.js';
import '../models/OvhcloudconnectInterfaceStatusEnum.js';
import '../models/OvhcloudconnectTaskStatusEnum.js';
import '../models/OvhcloudconnectTaskFunctionEnum.js';
import '../models/OvhcloudconnectDiagnosticResult.js';
import '../models/OvhcloudconnectDiagnosticFunctionEnum.js';
import '../models/OvhcloudconnectPopConfigTypeEnum.js';
import '../models/OvhcloudconnectPopConfigStatusEnum.js';
import '../models/OvhcloudconnectDiagnosticTypeEnum.js';
import '../models/OvhcloudconnectDatacenterExtraConfigTypeEnum.js';
import '../models/OvhcloudconnectMessageCodeEnum.js';
import '../endpoints.js';

declare class OvhCloudConnectHandler {
    ovh: OVHBase;
    constructor(ovh: OVHBase);
    /** List available services */
    list: () => Promise<string[]>;
    /** Get service */
    getByServiceName: (serviceName: string) => Promise<OvhcloudconnectService>;
    /** Modify service */
    putByServiceName: (serviceName: string, body: OvhcloudconnectUpdate) => Promise<void>;
    /** Launch a contact change procedure */
    launchChangeContactByServiceName: (serviceName: string, body: {
        contactAdmin?: string;
        contactBilling?: string;
        contactTech?: string;
    }) => Promise<number[]>;
    /** Get Pop Configuration linked to of a OVHcloud Connect Service */
    getConfigPopByServiceName: (serviceName: string) => Promise<number[]>;
    /** Create a Pop Configuration */
    createConfigPopByServiceName: (serviceName: string, body: OvhcloudconnectPopConfig) => Promise<OvhcloudconnectTask>;
    /** Delete a Pop Configuration */
    deleteConfigPopByServiceNameAndPopId: (popId: number, serviceName: string) => Promise<OvhcloudconnectTask>;
    /** Get Pop Configuration of a OVHcloud Connect Service */
    getConfigPopByServiceNameAndPopId: (popId: number, serviceName: string) => Promise<OvhcloudconnectPopConfig>;
    /** Get Datacenter Configuration linked to of a OVHcloud Connect Service */
    getConfigPopDatacenterByServiceNameAndPopId: (popId: number, serviceName: string) => Promise<number[]>;
    /** Create a Datacenter Configuration */
    createConfigPopDatacenterByServiceNameAndPopId: (popId: number, serviceName: string, body: OvhcloudconnectDatacenterConfig) => Promise<OvhcloudconnectTask>;
    /** Delete a Datacenter Configuration */
    deleteConfigPopDatacenterByServiceNameAndPopIdAndDatacenterId: (datacenterId: number, popId: number, serviceName: string) => Promise<OvhcloudconnectTask>;
    /** Get Datacenter Configuration of a OVHcloud Connect Service */
    getConfigPopDatacenterByServiceNameAndPopIdAndDatacenterId: (datacenterId: number, popId: number, serviceName: string) => Promise<OvhcloudconnectDatacenterConfig>;
    /** Get Datacenter Extra Configuration linked to of a OVHcloud Connect Service */
    getConfigPopDatacenterExtraByServiceNameAndPopIdAndDatacenterId: (datacenterId: number, popId: number, serviceName: string) => Promise<number[]>;
    /** Create a Datacenter Extra Configuration */
    createConfigPopDatacenterExtraByServiceNameAndPopIdAndDatacenterId: (datacenterId: number, popId: number, serviceName: string, body: OvhcloudconnectDatacenterExtraConfig) => Promise<OvhcloudconnectTask>;
    /** Delete a Datacenter Extra Configuration */
    deleteConfigPopDatacenterExtraByServiceNameAndPopIdAndDatacenterIdAndExtraId: (datacenterId: number, extraId: number, popId: number, serviceName: string) => Promise<OvhcloudconnectTask>;
    /** Get Datacenter Extra Configuration of a OVHcloud Connect Service */
    getConfigPopDatacenterExtraByServiceNameAndPopIdAndDatacenterIdAndExtraId: (datacenterId: number, extraId: number, popId: number, serviceName: string) => Promise<OvhcloudconnectDatacenterExtraConfig>;
    /** Confirm termination of your service */
    confirmTerminationByServiceName: (serviceName: string, body: {
        commentary?: string;
        futureUse?: ServiceTerminationFutureUseEnum;
        reason?: ServiceTerminationReasonEnum;
        token: string;
    }) => Promise<string>;
    /** List available Datacenter */
    listDatacenterByServiceName: (serviceName: string) => Promise<number[]>;
    /** Get Datacenter */
    getDatacenterByServiceNameAndId: (id: number, serviceName: string) => Promise<OvhcloudconnectDatacenter>;
    /** Get Diagnostics linked to a OVHcloud Connect Service */
    getDiagnosticByServiceName: (serviceName: string) => Promise<number[]>;
    /** Create a Diagnostic linked to a OVHcloud Connect Service */
    createDiagnosticByServiceName: (serviceName: string, body: OvhcloudconnectDiagnosticConfiguration) => Promise<OvhcloudconnectDiagnostic>;
    /** Get Diagnostic linked to a OVHcloud Connect Service */
    getDiagnosticByServiceNameAndId: (id: number, serviceName: string) => Promise<OvhcloudconnectDiagnostic>;
    /** List interfaces linked to the Service */
    listInterfaceByServiceName: (serviceName: string) => Promise<number[]>;
    /** Get the Interface information */
    getInterfaceByServiceNameAndId: (id: number, serviceName: string) => Promise<OvhcloudconnectInterface>;
    /** Lock the port */
    postInterfaceLockByServiceNameAndId: (id: number, serviceName: string) => Promise<OvhcloudconnectTask>;
    /** Statistics for an OCC interface for a given type */
    getInterfaceStatisticsByServiceNameAndId: (id: number, serviceName: string) => Promise<OvhcloudconnectMetrics[]>;
    /** Unlock the port */
    postInterfaceUnlockByServiceNameAndId: (id: number, serviceName: string) => Promise<OvhcloudconnectTask>;
    /** Generate a loa for a service */
    postLoaByServiceName: (serviceName: string) => Promise<string>;
    /** Get this object properties */
    getServiceInfosByServiceName: (serviceName: string) => Promise<ServicesService>;
    /** Alter this object properties */
    updateServiceInfosByServiceName: (serviceName: string, body: ServicesService) => Promise<void>;
    /** Get Keys linked to a OVHcloud Connect Service */
    getServiceKeyByServiceName: (serviceName: string) => Promise<number[]>;
    /** Get Key linked to a OVHcloud Connect Service */
    getServiceKeyByServiceNameAndServiceKeyId: (serviceKeyId: number, serviceName: string) => Promise<OvhcloudconnectKey>;
    /** Regenerate Service Key linked to a OVHcloud Connect Service */
    postServiceKeyRegenerateByServiceNameAndServiceKeyId: (serviceKeyId: number, serviceName: string) => Promise<OvhcloudconnectKey>;
    /** Send key value to customer */
    sendServiceKeyByServiceNameAndServiceKeyId: (serviceKeyId: number, serviceName: string, body: OvhcloudconnectTo) => Promise<OvhcloudconnectSendKeyAnswer>;
    /** Get Task linked to a OVHcloud Connect Service */
    getTaskByServiceName: (serviceName: string) => Promise<number[]>;
    /** Get Tasks linked to a OVHcloud Connect Service */
    getTaskByServiceNameAndId: (id: number, serviceName: string) => Promise<OvhcloudconnectTask>;
    /** Terminate your service */
    postTerminateByServiceName: (serviceName: string) => Promise<string>;
}

export { OvhCloudConnectHandler };