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

OVH API wrapper library for TypeScript

import { MsServicesTask } from '../models/MsServicesTask.js';
import { MsServicesActiveDirectoryOrganizationalUnit } from '../models/MsServicesActiveDirectoryOrganizationalUnit.js';
import { MsServicesSyncDailyLicense } from '../models/MsServicesSyncDailyLicense.js';
import { ServicesService } from '../models/ServicesService.js';
import { MsServicesExchangeService } from '../models/MsServicesExchangeService.js';
import { MsServicesSharepointDailyLicense } from '../models/MsServicesSharepointDailyLicense.js';
import { MsServicesAccount } from '../models/MsServicesAccount.js';
import { MsServicesSharepointServiceInfo } from '../models/MsServicesSharepointServiceInfo.js';
import { MsServicesSharepointService } from '../models/MsServicesSharepointService.js';
import { MsServicesSharepointTask } from '../models/MsServicesSharepointTask.js';
import { MsServicesExchangeInformation } from '../models/MsServicesExchangeInformation.js';
import { MsServicesSharepointInformation } from '../models/MsServicesSharepointInformation.js';
import { MsServicesSyncInformation } from '../models/MsServicesSyncInformation.js';
import { MsServicesSyncLicenseEnum } from '../models/MsServicesSyncLicenseEnum.js';
import { MsServicesActiveDirectorySyncClientUrl } from '../models/MsServicesActiveDirectorySyncClientUrl.js';
import { MsServicesUpnSuffix } from '../models/MsServicesUpnSuffix.js';
import { MsServicesMfaInformation } from '../models/MsServicesMfaInformation.js';
import { MsServicesSyncService } from '../models/MsServicesSyncService.js';
import { MsServicesExchangeTask } from '../models/MsServicesExchangeTask.js';
import OVHBase from '../ovh.js';
import '../models/MsServicesTaskFunctionEnum.js';
import '../models/MsServicesTaskStatusEnum.js';
import '../models/MsServicesServiceStateEnum.js';
import '../models/MsServicesSyncAccountLicense.js';
import '../models/ServiceStateEnum.js';
import '../models/ServiceRenewType.js';
import '../models/ServiceRenewalTypeEnum.js';
import '../models/MsServicesServiceOfferEnum.js';
import '../models/MsServicesSpamAndVirusConfiguration.js';
import '../models/MsServicesSharepointAccountLicense.js';
import '../models/MsServicesSharepointLicenseEnum.js';
import '../models/MsServicesObjectStateEnum.js';
import '../models/EmailExchangeCountryCodeEnum.js';
import '../models/MsServicesSharepointServiceOfferEnum.js';
import '../models/MsServicesMailingFilterEnum.js';
import '../models/MsServicesRenewPeriodEnum.js';
import '../models/MsServicesExchangeLicenceEnum.js';
import '../models/MsServicesSharepointAccountAccessRightsEnum.js';
import '../models/MsServicesUPNStateEnum.js';
import '../endpoints.js';

declare class MsServicesHandler {
    ovh: OVHBase;
    constructor(ovh: OVHBase);
    /** List available services */
    list: () => Promise<string[]>;
    /** List available services */
    listSharepoint: () => Promise<string[]>;
    /** Get this object properties */
    getSharepointByDomain: (domain: string) => Promise<MsServicesSharepointServiceInfo>;
    /** Get this object properties */
    getSharepointServiceInfosByDomain: (domain: string) => Promise<ServicesService>;
    /** Alter this object properties */
    updateSharepointServiceInfosByDomain: (domain: string, body: ServicesService) => Promise<void>;
    /** Get this object properties */
    getByServiceName: (serviceName: string) => Promise<MsServicesActiveDirectoryOrganizationalUnit>;
    /** Alter this object properties */
    updateByServiceName: (serviceName: string, body: MsServicesActiveDirectoryOrganizationalUnit) => Promise<void>;
    /** Accounts associated to this Active Directory service */
    getAccountByServiceName: (serviceName: string) => Promise<string[]>;
    /** Get this object properties */
    getAccountByServiceNameAndUserPrincipalName: (serviceName: string, userPrincipalName: string) => Promise<MsServicesAccount>;
    /** Alter this object properties */
    updateAccountByServiceNameAndUserPrincipalName: (serviceName: string, userPrincipalName: string, body: MsServicesAccount) => Promise<void>;
    /** Change account password */
    updateAccountPasswordByServiceNameAndUserPrincipalName: (serviceName: string, userPrincipalName: string, body: {
        password: string;
    }) => Promise<MsServicesTask>;
    /** Get this object properties */
    getAccountExchangeByServiceNameAndUserPrincipalName: (serviceName: string, userPrincipalName: string) => Promise<MsServicesExchangeInformation>;
    /** Alter this object properties */
    updateAccountExchangeByServiceNameAndUserPrincipalName: (serviceName: string, userPrincipalName: string, body: MsServicesExchangeInformation) => Promise<void>;
    /** Configure mailbox to be operational */
    postAccountExchangeConfigureByServiceNameAndUserPrincipalName: (serviceName: string, userPrincipalName: string) => Promise<MsServicesExchangeTask>;
    /** Delete Multi Factor Authentication feature for this account */
    deleteAccountMfaByServiceNameAndUserPrincipalName: (serviceName: string, userPrincipalName: string) => Promise<MsServicesTask>;
    /** Get this object properties */
    getAccountMfaByServiceNameAndUserPrincipalName: (serviceName: string, userPrincipalName: string) => Promise<MsServicesMfaInformation>;
    /** Create Multi Factor Authentication for this account */
    createAccountMfaByServiceNameAndUserPrincipalName: (serviceName: string, userPrincipalName: string) => Promise<MsServicesTask>;
    /** Disable Multi Factor Authentication for a period of time */
    disableAccountMfaByServiceNameAndUserPrincipalName: (serviceName: string, userPrincipalName: string, body: {
        period: number;
    }) => Promise<MsServicesTask>;
    /** Enable Mfa (enabled by default when created) */
    enableAccountMfaByServiceNameAndUserPrincipalName: (serviceName: string, userPrincipalName: string) => Promise<MsServicesTask>;
    /** Reset Multi Factor Authentication status for this account */
    postAccountMfaResetByServiceNameAndUserPrincipalName: (serviceName: string, userPrincipalName: string) => Promise<MsServicesTask>;
    /** Get this object properties */
    getAccountSharepointByServiceNameAndUserPrincipalName: (serviceName: string, userPrincipalName: string) => Promise<MsServicesSharepointInformation>;
    /** Alter this object properties */
    updateAccountSharepointByServiceNameAndUserPrincipalName: (serviceName: string, userPrincipalName: string, body: MsServicesSharepointInformation) => Promise<void>;
    /** On-demand MySite clearance */
    postAccountSharepointClearSpaceByServiceNameAndUserPrincipalName: (serviceName: string, userPrincipalName: string) => Promise<MsServicesSharepointTask>;
    /** Configure sharepoint account to be operational */
    postAccountSharepointConfigureByServiceNameAndUserPrincipalName: (serviceName: string, userPrincipalName: string) => Promise<MsServicesSharepointTask>;
    /** Delete sync account */
    deleteAccountSyncByServiceNameAndUserPrincipalName: (serviceName: string, userPrincipalName: string) => Promise<MsServicesTask>;
    /** Get this object properties */
    getAccountSyncByServiceNameAndUserPrincipalName: (serviceName: string, userPrincipalName: string) => Promise<MsServicesSyncInformation>;
    /** Create new sync account */
    createAccountSyncByServiceNameAndUserPrincipalName: (serviceName: string, userPrincipalName: string, body: {
        license: MsServicesSyncLicenseEnum;
    }) => Promise<MsServicesTask>;
    /** Configure sync account to be operational */
    postAccountSyncConfigureByServiceNameAndUserPrincipalName: (serviceName: string, userPrincipalName: string) => Promise<MsServicesTask>;
    /** Launch a contact change procedure */
    launchChangeContactByServiceName: (serviceName: string, body: {
        contactAdmin?: string;
        contactBilling?: string;
        contactTech?: string;
    }) => Promise<number[]>;
    /** Create Mfa on all accounts. */
    createMfaOnAllUsersByServiceName: (serviceName: string) => Promise<MsServicesTask>;
    /** Get this object properties */
    getExchangeByServiceName: (serviceName: string) => Promise<MsServicesExchangeService>;
    /** Alter this object properties */
    updateExchangeByServiceName: (serviceName: string, body: MsServicesExchangeService) => Promise<void>;
    /** Detects billing transition status for the service */
    getExchangeBillingMigratedByServiceName: (serviceName: string) => Promise<boolean>;
    /** Pending actions */
    getExchangeTaskByServiceName: (serviceName: string) => Promise<number[]>;
    /** Get this object properties */
    getExchangeTaskByServiceNameAndId: (id: number, serviceName: string) => Promise<MsServicesExchangeTask>;
    /** Remove Mfa on all accounts. */
    postRemoveMfaOnAllUsersByServiceName: (serviceName: string) => Promise<MsServicesTask>;
    /** Get this object properties */
    getSharepointByServiceName: (serviceName: string) => Promise<MsServicesSharepointService>;
    /** Alter this object properties */
    updateSharepointByServiceName: (serviceName: string, body: MsServicesSharepointService) => Promise<void>;
    /** Detects billing transition status for the service */
    getSharepointBillingMigratedByServiceName: (serviceName: string) => Promise<boolean>;
    /** Get active licenses for specific period of time */
    getSharepointLicenseByServiceName: (serviceName: string) => Promise<MsServicesSharepointDailyLicense[]>;
    /** Restore administrator rights */
    postSharepointRestoreAdminRightsByServiceName: (serviceName: string) => Promise<MsServicesSharepointTask>;
    /** Pending actions */
    getSharepointTaskByServiceName: (serviceName: string) => Promise<number[]>;
    /** Get this object properties */
    getSharepointTaskByServiceNameAndId: (id: number, serviceName: string) => Promise<MsServicesSharepointTask>;
    /** Delete sync service */
    deleteSyncByServiceName: (serviceName: string) => Promise<MsServicesTask>;
    /** Get this object properties */
    getSyncByServiceName: (serviceName: string) => Promise<MsServicesSyncService>;
    /** Change account password */
    updateSyncPasswordByServiceName: (serviceName: string, body: {
        password: string;
    }) => Promise<MsServicesTask>;
    /** Get this object properties */
    getSyncClientSoftwareURLByServiceName: (serviceName: string) => Promise<MsServicesActiveDirectorySyncClientUrl>;
    /** Generate temporary link to ADSync software executable */
    postSyncClientSoftwareURLByServiceName: (serviceName: string) => Promise<MsServicesTask>;
    /** Get active licenses for specific period of time */
    getSyncLicenseByServiceName: (serviceName: string) => Promise<MsServicesSyncDailyLicense[]>;
    /** Pending actions */
    getTaskByServiceName: (serviceName: string) => Promise<number[]>;
    /** Get this object properties */
    getTaskByServiceNameAndId: (id: number, serviceName: string) => Promise<MsServicesTask>;
    /** active directory UPN suffix */
    getUpnSuffixByServiceName: (serviceName: string) => Promise<string[]>;
    /** Create new UPN suffix */
    createUpnSuffixByServiceName: (serviceName: string, body: {
        suffix: string;
    }) => Promise<MsServicesTask>;
    /** Delete existing UPN suffix */
    deleteUpnSuffixByServiceNameAndSuffix: (serviceName: string, suffix: string) => Promise<MsServicesTask>;
    /** Get this object properties */
    getUpnSuffixByServiceNameAndSuffix: (serviceName: string, suffix: string) => Promise<MsServicesUpnSuffix>;
}

export { MsServicesHandler };