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

OVH API wrapper library for TypeScript

import { ConnectivityEligibilityLine } from '../models/ConnectivityEligibilityLine.js';
import { ConnectivityEligibilityLineStatusEnum } from '../models/ConnectivityEligibilityLineStatusEnum.js';
import { ConnectivityMaintenanceWorkPlanned } from '../models/ConnectivityMaintenanceWorkPlanned.js';
import { ConnectivityEligibilityBuilding } from '../models/ConnectivityEligibilityBuilding.js';
import { ConnectivityEligibilityEligibilityTest } from '../models/ConnectivityEligibilityEligibilityTest.js';
import { ConnectivityEligibilityCity } from '../models/ConnectivityEligibilityCity.js';
import { ConnectivityEligibilityMeetings } from '../models/ConnectivityEligibilityMeetings.js';
import { ConnectivityEligibilityOfferProductTypeEnum } from '../models/ConnectivityEligibilityOfferProductTypeEnum.js';
import { ConnectivityEligibilityStreet } from '../models/ConnectivityEligibilityStreet.js';
import { ConnectivityMonitoringGenericIncident } from '../models/ConnectivityMonitoringGenericIncident.js';
import { ConnectivityEligibilityOfferProductUnbundlingTypeEnum } from '../models/ConnectivityEligibilityOfferProductUnbundlingTypeEnum.js';
import OVHBase from '../ovh.js';
import '../models/ConnectivityEligibilityCopperInfo.js';
import '../models/ConnectivityEligibilitySectionLength.js';
import '../models/ConnectivityEligibilityAddress.js';
import '../models/ConnectivityMaintenanceInterventionTypeEnum.js';
import '../models/ConnectivityOperatorEnum.js';
import '../models/ConnectivityEligibilityBuildingTypeEnum.js';
import '../models/ConnectivityEligibilityBuildingStair.js';
import '../models/ConnectivityEligibilityEndpoint.js';
import '../models/ConnectivityEligibilityPortability.js';
import '../models/ConnectivityEligibilityPortabilityEligibility.js';
import '../models/ConnectivityEligibilityMessage.js';
import '../models/ConnectivityEligibilityMessageCodeEnum.js';
import '../models/ConnectivityEligibilityPortabilityTypeEnum.js';
import '../models/ConnectivityEligibilityFiberInfo.js';
import '../models/ConnectivityEligibilityEndpointReferenceTypeEnum.js';
import '../models/ConnectivityEligibilityOffer.js';
import '../models/ConnectivityEligibilityOfferProduct.js';
import '../models/ConnectivityEligibilityOfferProductProviderEnum.js';
import '../models/ConnectivityEligibilityOfferEligibility.js';
import '../models/ConnectivityEligibilityActivationTypeEnum.js';
import '../models/ConnectivityEligibilityMeetingSlot.js';
import '../models/ConnectivityMonitoringGenericIncidentStatusEnum.js';
import '../endpoints.js';

declare class ConnectivityHandler {
    ovh: OVHBase;
    constructor(ovh: OVHBase);
    /** Get the details for a building */
    postEligibilitySearchBuildingDetails: (body: {
        building: string;
    }) => Promise<ConnectivityEligibilityBuilding>;
    /** Get all buildings for a specific address */
    postEligibilitySearchBuildings: (body: {
        streetCode: string;
        streetNumber: string;
    }) => Promise<ConnectivityEligibilityBuilding>;
    /** Get building references from a given line number */
    postEligibilitySearchBuildingsByLine: (body: {
        lineNumber: string;
        status: ConnectivityEligibilityLineStatusEnum;
    }) => Promise<ConnectivityEligibilityBuilding>;
    /** Get all localities linked to a zip code */
    postEligibilitySearchCities: (body: {
        zipCode: string;
    }) => Promise<ConnectivityEligibilityCity>;
    /** Search for active and inactive lines at an address. It will search for active lines only if the owner name is specified */
    postEligibilitySearchLines: (body: {
        ownerName?: string;
        streetCode: string;
        streetNumber: string;
    }) => Promise<ConnectivityEligibilityLine>;
    /** Search for available copper line creation or fiber installation meeting time slots */
    postEligibilitySearchMeetings: (body: {
        eligibilityReference: string;
        planCode?: string;
        productCode?: string;
        type?: ConnectivityEligibilityOfferProductTypeEnum;
        unbundlingType?: ConnectivityEligibilityOfferProductUnbundlingTypeEnum;
    }) => Promise<ConnectivityEligibilityMeetings>;
    /** Get the available street numbers for a given street code (unique identifier of a street you can get with the method POST /connectivity/eligibility/search/streets) */
    postEligibilitySearchStreetNumbers: (body: {
        streetCode: string;
    }) => Promise<string>;
    /** Get all street linked to a locality */
    postEligibilitySearchStreets: (body: {
        inseeCode: string;
    }) => Promise<ConnectivityEligibilityStreet>;
    /** Get an eligibility by its reference */
    getEligibilityTest: () => Promise<ConnectivityEligibilityEligibilityTest>;
    /** Do an eligibility for an address, if no line exist */
    postEligibilityTestAddress: (body: {
        streetCode: string;
        streetNumber: string;
    }) => Promise<ConnectivityEligibilityEligibilityTest>;
    /** Do an eligibility for an address, if no line exist. Partners only. */
    postEligibilityTestAddressPartners: (body: {
        streetCode: string;
        streetNumber: string;
    }) => Promise<ConnectivityEligibilityEligibilityTest>;
    /** Do an eligibility test on a building, for fiber only */
    postEligibilityTestBuilding: (body: {
        building: string;
    }) => Promise<ConnectivityEligibilityEligibilityTest>;
    /** Do an eligibility test on a line number, for copper only */
    postEligibilityTestLine: (body: {
        lineNumber: string;
        status: ConnectivityEligibilityLineStatusEnum;
        streetCode?: string;
        streetNumber?: string;
    }) => Promise<ConnectivityEligibilityEligibilityTest>;
    /** Do an eligibility test on a line number, for copper only. Partners only. */
    postEligibilityTestLinePartners: (body: {
        lineNumber: string;
        status: ConnectivityEligibilityLineStatusEnum;
        streetCode?: string;
        streetNumber?: string;
    }) => Promise<ConnectivityEligibilityEligibilityTest>;
    /** Do an eligibility test on an OTP (Optical Termination Panel), for fiber only */
    postEligibilityTestOtp: (body: {
        otp: string;
    }) => Promise<ConnectivityEligibilityEligibilityTest>;
    /** List work planned by operators. For partners only */
    listMaintenanceWorkPlannedPartners: () => Promise<ConnectivityMaintenanceWorkPlanned[]>;
    /** List work planned by operators */
    listMaintenanceWorkPlannedPublic: () => Promise<ConnectivityMaintenanceWorkPlanned[]>;
    /** List detected, validated and recently closed generic incidents. For partners only */
    listMonitoringGenericIncidentPartners: () => Promise<ConnectivityMonitoringGenericIncident[]>;
    /** List validated and recently closed generic incidents */
    listMonitoringGenericIncidentPublic: () => Promise<ConnectivityMonitoringGenericIncident[]>;
}

export { ConnectivityHandler };