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

OVH API wrapper library for TypeScript

import { SaasCsp2SubscriptionChangeQuantityCreation } from '../models/SaasCsp2SubscriptionChangeQuantityCreation.js';
import { SaasCsp2OfficeLicence } from '../models/SaasCsp2OfficeLicence.js';
import { SaasCsp2OfficeTask } from '../models/SaasCsp2OfficeTask.js';
import { SaasCsp2OfficeSubscription } from '../models/SaasCsp2OfficeSubscription.js';
import { SaasCsp2SubscriptionCreation } from '../models/SaasCsp2SubscriptionCreation.js';
import { ServicesService } from '../models/ServicesService.js';
import { SaasCsp2OfficeTenant } from '../models/SaasCsp2OfficeTenant.js';
import { SaasCsp2Statistics } from '../models/SaasCsp2Statistics.js';
import { SaasCsp2BillingStatistics } from '../models/SaasCsp2BillingStatistics.js';
import { SaasCsp2SupportedServiceEnum } from '../models/SaasCsp2SupportedServiceEnum.js';
import { SaasCsp2SubscriptionOrderAddonCreation } from '../models/SaasCsp2SubscriptionOrderAddonCreation.js';
import OVHBase from '../ovh.js';
import '../models/SaasCsp2LicenseTypeEnum.js';
import '../models/SaasCsp2TaskStatusEnum.js';
import '../models/ServiceStateEnum.js';
import '../models/ServiceRenewType.js';
import '../models/ServiceRenewalTypeEnum.js';
import '../models/SaasCsp2ServiceStateEnum.js';
import '../models/SaasCsp2StatisticsLine.js';
import '../models/SaasCsp2BillingStatisticsLine.js';
import '../endpoints.js';

declare class SaasCsp2Handler {
    ovh: OVHBase;
    constructor(ovh: OVHBase);
    /** List available services */
    listCsp2: () => Promise<string[]>;
    /** Get this object properties */
    getCsp2ByServiceName: (serviceName: string) => Promise<SaasCsp2OfficeTenant>;
    /** Alter this object properties */
    updateCsp2ByServiceName: (serviceName: string, body: SaasCsp2OfficeTenant) => Promise<void>;
    /** Get the current billing period's usage peak for each subscription */
    getCsp2BillingPeriodPeaksByServiceName: (serviceName: string) => Promise<SaasCsp2BillingStatistics>;
    /** Changes the tenant administrator's password */
    updateCsp2AdministratorPasswordByServiceName: (serviceName: string, body: {
        newPassword: string;
    }) => Promise<SaasCsp2OfficeTask>;
    /** Automatically sets up an OVH-hosted domain of yours for your office365 services. Note, this requires the domain to not have any interfering MX/SRV/TXT records */
    postCsp2ConfigureDomainByServiceName: (serviceName: string, body: {
        domain: string;
        supportedServices: SaasCsp2SupportedServiceEnum[];
    }) => Promise<SaasCsp2OfficeTask>;
    /** Licenses available for order */
    getCsp2OrderableLicensesByServiceName: (serviceName: string) => Promise<number[]>;
    /** Get this object properties */
    getCsp2OrderableLicensesByServiceNameAndId: (serviceName: string, id: number) => Promise<SaasCsp2OfficeLicence>;
    /** Get this object properties */
    getCsp2ServiceInfosByServiceName: (serviceName: string) => Promise<ServicesService>;
    /** Alter this object properties */
    updateCsp2ServiceInfosByServiceName: (serviceName: string, body: ServicesService) => Promise<void>;
    /** Subscriptions associated to this office tenant */
    getCsp2SubscriptionByServiceName: (serviceName: string) => Promise<number[]>;
    /** Add a subscription to this tenant */
    addCsp2SubscriptionByServiceName: (serviceName: string, body: SaasCsp2SubscriptionCreation) => Promise<SaasCsp2OfficeTask>;
    /** Delete a subscription from this tenant */
    deleteCsp2SubscriptionByServiceNameAndId: (serviceName: string, id: number) => Promise<SaasCsp2OfficeTask>;
    /** Get this object properties */
    getCsp2SubscriptionByServiceNameAndId: (serviceName: string, id: number) => Promise<SaasCsp2OfficeSubscription>;
    /** Addon subscriptions associated to this office subscription */
    addCsp2SubscriptiononsSubscriptionIdsByServiceNameAndId: (serviceName: string, id: number) => Promise<number[]>;
    /** Gives a list of licenses ids that can be ordered as an addon for this subscription */
    getCsp2SubscriptionAvailableAddonLicensesByServiceNameAndId: (serviceName: string, id: number) => Promise<number[]>;
    /** Change the quantity of seats in the subscription */
    updateCsp2SubscriptionQuantityByServiceNameAndId: (serviceName: string, id: number, body: SaasCsp2SubscriptionChangeQuantityCreation) => Promise<SaasCsp2OfficeTask>;
    /** Creates a new subscription as an addon for this subscription */
    createCsp2SubscriptionOrderAddonByServiceNameAndId: (serviceName: string, id: number, body: SaasCsp2SubscriptionOrderAddonCreation) => Promise<SaasCsp2OfficeTask>;
    /** Pending tasks of this tenant */
    getCsp2TaskByServiceName: (serviceName: string) => Promise<number[]>;
    /** Get this object properties */
    getCsp2TaskByServiceNameAndId: (serviceName: string, id: number) => Promise<SaasCsp2OfficeTask>;
    /** Get the usage statistics over the chosen period */
    getCsp2UsageStatisticsByServiceName: (serviceName: string) => Promise<SaasCsp2Statistics[]>;
}

export { SaasCsp2Handler };