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

OVH API wrapper library for TypeScript

import { MetricsApiConsumption } from '../models/MetricsApiConsumption.js';
import { MetricsUpdate } from '../models/MetricsUpdate.js';
import { MetricsQuotaUpdate } from '../models/MetricsQuotaUpdate.js';
import { MetricsLookupTokenCreation } from '../models/MetricsLookupTokenCreation.js';
import { ServiceTerminationReasonEnum } from '../models/ServiceTerminationReasonEnum.js';
import { MetricsApiService } from '../models/MetricsApiService.js';
import { MetricsApiToken } from '../models/MetricsApiToken.js';
import { ServicesService } from '../models/ServicesService.js';
import { ServiceTerminationFutureUseEnum } from '../models/ServiceTerminationFutureUseEnum.js';
import { MetricsTokenUpdate } from '../models/MetricsTokenUpdate.js';
import { MetricsTokenCreation } from '../models/MetricsTokenCreation.js';
import OVHBase from '../ovh.js';
import '../models/MetricsApiOption.js';
import '../models/MetricsApiOfferTypeEnum.js';
import '../models/MetricsApiRegion.js';
import '../models/MetricsApiServiceStatusEnum.js';
import '../models/MetricsApiLabel.js';
import '../models/MetricsApiPermissionEnum.js';
import '../models/ServiceStateEnum.js';
import '../models/ServiceRenewType.js';
import '../models/ServiceRenewalTypeEnum.js';
import '../endpoints.js';

declare class MetricsHandler {
    ovh: OVHBase;
    constructor(ovh: OVHBase);
    /** List available services */
    list: () => Promise<string[]>;
    /** Get service */
    getByServiceName: (serviceName: string) => Promise<MetricsApiService>;
    /** Modify service */
    putByServiceName: (serviceName: string, body: MetricsUpdate) => Promise<MetricsApiService>;
    /** 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>;
    /** Get consumption for your service */
    getConsumptionByServiceName: (serviceName: string) => Promise<MetricsApiConsumption>;
    /** Find TokenID for a specific token */
    postLookupTokenByServiceName: (serviceName: string, body: MetricsLookupTokenCreation) => Promise<string[]>;
    /** Set overquota */
    putQuotaByServiceName: (serviceName: string, body: MetricsQuotaUpdate) => Promise<string>;
    /** Get this object properties */
    getServiceInfosByServiceName: (serviceName: string) => Promise<ServicesService>;
    /** Alter this object properties */
    updateServiceInfosByServiceName: (serviceName: string, body: ServicesService) => Promise<void>;
    /** Terminate your service */
    postTerminateByServiceName: (serviceName: string) => Promise<string>;
    /** Get list of tokens */
    getTokenByServiceName: (serviceName: string) => Promise<string[]>;
    /** Create a token */
    createTokenByServiceName: (serviceName: string, body: MetricsTokenCreation) => Promise<MetricsApiToken>;
    /** Revoke a token */
    deleteTokenByServiceNameAndTokenId: (serviceName: string, tokenId: string) => Promise<void>;
    /** Get a specific token */
    getTokenByServiceNameAndTokenId: (serviceName: string, tokenId: string) => Promise<MetricsApiToken>;
    /** Modify a token */
    putTokenByServiceNameAndTokenId: (serviceName: string, tokenId: string, body: MetricsTokenUpdate) => Promise<MetricsApiToken>;
}

export { MetricsHandler };