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

OVH API wrapper library for TypeScript

import { WebPaaSSubscriptionProjectAddCustomer } from '../models/WebPaaSSubscriptionProjectAddCustomer.js';
import { WebPaaSCapabilities } from '../models/WebPaaSCapabilities.js';
import { WebPaaSSubscription } from '../models/WebPaaSSubscription.js';
import { ServiceTerminationReasonEnum } from '../models/ServiceTerminationReasonEnum.js';
import { ServicesService } from '../models/ServicesService.js';
import { WebPaaSSubscriptionCustomer } from '../models/WebPaaSSubscriptionCustomer.js';
import { ServiceTerminationFutureUseEnum } from '../models/ServiceTerminationFutureUseEnum.js';
import OVHBase from '../ovh.js';
import '../models/WebPaaSTemplate.js';
import '../models/WebPaaSRegionEnum.js';
import '../models/WebPaaSOfferEnum.js';
import '../models/WebPaaSSubscriptionMetadata.js';
import '../models/WebPaaSSubscriptionMetadataProject.js';
import '../models/WebPaaSStorageUnitEnum.js';
import '../models/WebPaaSStatusEnum.js';
import '../models/WebPaaSSubscriptionAddon.js';
import '../models/WebPaaSAddonStatusEnum.js';
import '../models/WebPaaSAddonFamilyEnum.js';
import '../models/WebPaaSAddonProductNameEnum.js';
import '../models/ServiceStateEnum.js';
import '../models/ServiceRenewType.js';
import '../models/ServiceRenewalTypeEnum.js';
import '../models/WebPaaSCustomerTypeEnum.js';
import '../endpoints.js';

declare class WebPaaSHandler {
    ovh: OVHBase;
    constructor(ovh: OVHBase);
    /** List available regions and templates */
    listCapabilities: () => Promise<WebPaaSCapabilities>;
    /** List your subscriptions */
    listSubscription: () => Promise<string[]>;
    /** Get information about your subscription */
    getSubscriptionByServiceName: (serviceName: string) => Promise<WebPaaSSubscription>;
    /** Confirm termination of your service */
    confirmSubscriptionTerminationByServiceName: (serviceName: string, body: {
        commentary?: string;
        futureUse?: ServiceTerminationFutureUseEnum;
        reason?: ServiceTerminationReasonEnum;
        token: string;
    }) => Promise<string>;
    /** List customers added to a project */
    listSubscriptionCustomerByServiceName: (serviceName: string) => Promise<WebPaaSSubscriptionCustomer[]>;
    /** Add customer to the project */
    addSubscriptionCustomerByServiceName: (serviceName: string, body: WebPaaSSubscriptionProjectAddCustomer) => Promise<WebPaaSSubscriptionCustomer>;
    /** Remove customer from the project */
    deleteSubscriptionCustomerByServiceNameAndCustomerId: (customerId: string, serviceName: string) => Promise<WebPaaSSubscriptionCustomer>;
    /** Get the customer details */
    getSubscriptionCustomerByServiceNameAndCustomerId: (customerId: string, serviceName: string) => Promise<WebPaaSSubscriptionCustomer>;
    /** Get this object properties */
    getSubscriptionServiceInfosByServiceName: (serviceName: string) => Promise<ServicesService>;
    /** Alter this object properties */
    updateSubscriptionServiceInfosByServiceName: (serviceName: string, body: ServicesService) => Promise<void>;
    /** Terminate your service */
    postSubscriptionTerminateByServiceName: (serviceName: string) => Promise<string>;
}

export { WebPaaSHandler };