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

OVH API wrapper library for TypeScript

import { LicenseOfficeOfficeTenant } from '../models/LicenseOfficeOfficeTenant.js';
import { LicenseOfficeStatistics } from '../models/LicenseOfficeStatistics.js';
import { ServiceTerminationReasonEnum } from '../models/ServiceTerminationReasonEnum.js';
import { ServicesService } from '../models/ServicesService.js';
import { ServiceTerminationFutureUseEnum } from '../models/ServiceTerminationFutureUseEnum.js';
import { LicenseOfficeOfficeTask } from '../models/LicenseOfficeOfficeTask.js';
import { LicenseOfficePrepaidOfficeUser } from '../models/LicenseOfficePrepaidOfficeUser.js';
import OVHBase from '../ovh.js';
import '../models/LicenseOfficeServiceStateEnum.js';
import '../models/LicenseOfficeServiceTypeEnum.js';
import '../models/LicenseOfficeStatisticsLine.js';
import '../models/LicenseOfficeLicenceEnum.js';
import '../models/ServiceStateEnum.js';
import '../models/ServiceRenewType.js';
import '../models/ServiceRenewalTypeEnum.js';
import '../models/LicenseOfficeTaskStatusEnum.js';
import '../models/LicenseOfficeUserStateEnum.js';
import '../models/CoreTypesCountryEnum.js';
import '../endpoints.js';

declare class LicenseOfficePrepaidHandler {
    ovh: OVHBase;
    constructor(ovh: OVHBase);
    /** List available services */
    listOfficePrepaid: () => Promise<string[]>;
    /** Get this object properties */
    getOfficePrepaidByServiceName: (serviceName: string) => Promise<LicenseOfficePrepaidOfficeUser>;
    /** Alter this object properties */
    updateOfficePrepaidByServiceName: (serviceName: string, body: LicenseOfficePrepaidOfficeUser) => Promise<void>;
    /** Change or reset  user's password */
    updateOfficePrepaidPasswordByServiceName: (serviceName: string, body: {
        notifyEmail?: string;
        password?: string;
        shouldSendMail: boolean;
    }) => Promise<LicenseOfficeOfficeTask>;
    /** Confirm termination of your service */
    confirmOfficePrepaidTerminationByServiceName: (serviceName: string, body: {
        commentary?: string;
        futureUse?: ServiceTerminationFutureUseEnum;
        reason?: ServiceTerminationReasonEnum;
        token: string;
    }) => Promise<string>;
    /** Retrieve the parent tenant of this office user */
    getOfficePrepaidParentTenantByServiceName: (serviceName: string) => Promise<LicenseOfficeOfficeTenant>;
    /** Modify the parent tenant of this office user */
    putOfficePrepaidParentTenantByServiceName: (serviceName: string, body: {
        displayName?: string;
    }) => Promise<void>;
    /** Get this object properties */
    getOfficePrepaidServiceInfosByServiceName: (serviceName: string) => Promise<ServicesService>;
    /** Alter this object properties */
    updateOfficePrepaidServiceInfosByServiceName: (serviceName: string, body: ServicesService) => Promise<void>;
    /** Tasks associated to this user's tenant */
    getOfficePrepaidTenantPendingTaskByServiceName: (serviceName: string) => Promise<number[]>;
    /** Get this object properties */
    getOfficePrepaidTenantPendingTaskByServiceNameAndId: (id: number, serviceName: string) => Promise<LicenseOfficeOfficeTask>;
    /** Shows the subscriptions' usage statistics for the given time period */
    getOfficePrepaidTenantUsageStatisticsByServiceName: (serviceName: string) => Promise<LicenseOfficeStatistics[]>;
    /** Terminate your service */
    postOfficePrepaidTerminateByServiceName: (serviceName: string) => Promise<string>;
    /** Unconfigure the office user */
    postOfficePrepaidUnconfigureByServiceName: (serviceName: string) => Promise<LicenseOfficeOfficeTask>;
}

export { LicenseOfficePrepaidHandler };