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

OVH API wrapper library for TypeScript

import { StorageNetAppShareUpdate } from '../models/StorageNetAppShareUpdate.js';
import { StorageNetAppShareSnapshotPolicyUpdate } from '../models/StorageNetAppShareSnapshotPolicyUpdate.js';
import { StorageNetAppShareSnapshotReserveUpdate } from '../models/StorageNetAppShareSnapshotReserveUpdate.js';
import { StorageNetAppShareSnapshotUpdate } from '../models/StorageNetAppShareSnapshotUpdate.js';
import { StorageNetAppShareSnapshotReserve } from '../models/StorageNetAppShareSnapshotReserve.js';
import { StorageNetAppShareAccessPath } from '../models/StorageNetAppShareAccessPath.js';
import { ServiceTerminationReasonEnum } from '../models/ServiceTerminationReasonEnum.js';
import { StorageNetAppShareSnapshot } from '../models/StorageNetAppShareSnapshot.js';
import { StorageNetAppService } from '../models/StorageNetAppService.js';
import { StorageNetAppShareExtendOrShrink } from '../models/StorageNetAppShareExtendOrShrink.js';
import { ServicesService } from '../models/ServicesService.js';
import { StorageNetAppShareSnapshotPolicy } from '../models/StorageNetAppShareSnapshotPolicy.js';
import { ServiceTerminationFutureUseEnum } from '../models/ServiceTerminationFutureUseEnum.js';
import { StorageNetAppSnapshotPolicyUpdate } from '../models/StorageNetAppSnapshotPolicyUpdate.js';
import { StorageNetAppShareACLRule } from '../models/StorageNetAppShareACLRule.js';
import { StorageNetAppShare } from '../models/StorageNetAppShare.js';
import { StorageNetAppSnapshotPolicy } from '../models/StorageNetAppSnapshotPolicy.js';
import { StorageNetAppServiceUpdate } from '../models/StorageNetAppServiceUpdate.js';
import OVHBase from '../ovh.js';
import '../models/StorageNetAppShareSnapshotReserveStatusEnum.js';
import '../models/StorageNetAppSnapshotStatusEnum.js';
import '../models/StorageNetAppSnapshotTypeEnum.js';
import '../models/StorageNetAppServicePerformanceLevelEnum.js';
import '../models/StorageNetAppServiceStatusEnum.js';
import '../models/StorageRegionEnum.js';
import '../models/ServiceStateEnum.js';
import '../models/ServiceRenewType.js';
import '../models/ServiceRenewalTypeEnum.js';
import '../models/StorageNetAppShareSnapshotPolicyStatusEnum.js';
import '../models/StorageNetAppShareACLStatusEnum.js';
import '../models/StorageNetAppShareACLPermissionEnum.js';
import '../models/StorageNetAppShareACLTypeEnum.js';
import '../models/StorageNetAppShareStatusEnum.js';
import '../models/StorageProtocolEnum.js';
import '../models/StorageNetAppSnapshotPolicyStatusEnum.js';
import '../models/StorageNetAppSnapshotPolicyRule.js';
import '../models/StorageNetAppSnapshotPolicySchedule.js';
import '../endpoints.js';

declare class StorageHandler {
    ovh: OVHBase;
    constructor(ovh: OVHBase);
    /** List available services */
    listNetapp: () => Promise<StorageNetAppService[]>;
    /** Get service details */
    getNetappByServiceName: (serviceName: string) => Promise<StorageNetAppService>;
    /** Update service */
    updateNetappByServiceName: (serviceName: string, body: StorageNetAppServiceUpdate) => Promise<StorageNetAppService>;
    /** Launch a contact change procedure */
    launchNetappChangeContactByServiceName: (serviceName: string, body: {
        contactAdmin?: string;
        contactBilling?: string;
        contactTech?: string;
    }) => Promise<number[]>;
    /** Confirm termination of your service */
    confirmNetappTerminationByServiceName: (serviceName: string, body: {
        commentary?: string;
        futureUse?: ServiceTerminationFutureUseEnum;
        reason?: ServiceTerminationReasonEnum;
        token: string;
    }) => Promise<string>;
    /** Get this object properties */
    getNetappServiceInfosByServiceName: (serviceName: string) => Promise<ServicesService>;
    /** Alter this object properties */
    updateNetappServiceInfosByServiceName: (serviceName: string, body: ServicesService) => Promise<void>;
    /** List available shares */
    listNetappShareByServiceName: (serviceName: string) => Promise<StorageNetAppShare[]>;
    /** Create a share */
    createNetappShareByServiceName: (serviceName: string, body: StorageNetAppShare) => Promise<StorageNetAppShare>;
    /** Delete a share */
    deleteNetappShareByServiceNameAndShareId: (serviceName: string, shareId: string) => Promise<void>;
    /** Get share details */
    getNetappShareByServiceNameAndShareId: (serviceName: string, shareId: string) => Promise<StorageNetAppShare>;
    /** Update a share */
    updateNetappShareByServiceNameAndShareId: (serviceName: string, shareId: string, body: StorageNetAppShareUpdate) => Promise<StorageNetAppShare>;
    /** List available access paths */
    listNetappShareAccessPathByServiceNameAndShareId: (serviceName: string, shareId: string) => Promise<StorageNetAppShareAccessPath[]>;
    /** Get access path details */
    getNetappShareAccessPathByServiceNameAndShareIdAndAccessPathId: (accessPathId: string, serviceName: string, shareId: string) => Promise<StorageNetAppShareAccessPath>;
    /** List available ACLs */
    listNetappShareAclByServiceNameAndShareId: (serviceName: string, shareId: string) => Promise<StorageNetAppShareACLRule[]>;
    /** Create an ACL */
    createNetappShareAclByServiceNameAndShareId: (serviceName: string, shareId: string, body: StorageNetAppShareACLRule) => Promise<StorageNetAppShareACLRule>;
    /** Delete an ACL */
    deleteNetappShareAclByServiceNameAndShareIdAndAclRuleId: (aclRuleId: string, serviceName: string, shareId: string) => Promise<void>;
    /** Get ACL details */
    getNetappShareAclByServiceNameAndShareIdAndAclRuleId: (aclRuleId: string, serviceName: string, shareId: string) => Promise<StorageNetAppShareACLRule>;
    /** Extend share size */
    postNetappShareExtendByServiceNameAndShareId: (serviceName: string, shareId: string, body: StorageNetAppShareExtendOrShrink) => Promise<void>;
    /** Shrink share size */
    postNetappShareShrinkByServiceNameAndShareId: (serviceName: string, shareId: string, body: StorageNetAppShareExtendOrShrink) => Promise<void>;
    /** List available snapshots */
    listNetappShareSnapshotByServiceNameAndShareId: (serviceName: string, shareId: string) => Promise<StorageNetAppShareSnapshot[]>;
    /** Create a snapshot */
    createNetappShareSnapshotByServiceNameAndShareId: (serviceName: string, shareId: string, body: StorageNetAppShareSnapshot) => Promise<StorageNetAppShareSnapshot>;
    /** Delete a snapshot */
    deleteNetappShareSnapshotByServiceNameAndShareIdAndSnapshotId: (serviceName: string, shareId: string, snapshotId: string) => Promise<void>;
    /** Get snapshot details */
    getNetappShareSnapshotByServiceNameAndShareIdAndSnapshotId: (serviceName: string, shareId: string, snapshotId: string) => Promise<StorageNetAppShareSnapshot>;
    /** Update a snapshot */
    updateNetappShareSnapshotByServiceNameAndShareIdAndSnapshotId: (serviceName: string, shareId: string, snapshotId: string, body: StorageNetAppShareSnapshotUpdate) => Promise<StorageNetAppShareSnapshot>;
    /** Hold an automatic share snapshot */
    postNetappShareSnapshotHoldByServiceNameAndShareIdAndSnapshotId: (serviceName: string, shareId: string, snapshotId: string) => Promise<StorageNetAppShareSnapshot>;
    /** Get snapshot policy used by a share */
    getNetappShareSnapshotPolicyByServiceNameAndShareId: (serviceName: string, shareId: string) => Promise<StorageNetAppShareSnapshotPolicy>;
    /** Update snapshot policy used by a share */
    updateNetappShareSnapshotPolicyByServiceNameAndShareId: (serviceName: string, shareId: string, body: StorageNetAppShareSnapshotPolicyUpdate) => Promise<void>;
    /** Get snapshot reserve properties of a share */
    getNetappShareSnapshotReserveByServiceNameAndShareId: (serviceName: string, shareId: string) => Promise<StorageNetAppShareSnapshotReserve>;
    /** Update snapshot reserve properties of a share */
    updateNetappShareSnapshotReserveByServiceNameAndShareId: (serviceName: string, shareId: string, body: StorageNetAppShareSnapshotReserveUpdate) => Promise<void>;
    /** Get a list of snapshot policies */
    getNetappSnapshotPolicyByServiceName: (serviceName: string) => Promise<StorageNetAppSnapshotPolicy[]>;
    /** Create a snapshot policy */
    createNetappSnapshotPolicyByServiceName: (serviceName: string, body: StorageNetAppSnapshotPolicy) => Promise<StorageNetAppSnapshotPolicy>;
    /** Delete a snapshot policy */
    deleteNetappSnapshotPolicyByServiceNameAndSnapshotPolicyId: (serviceName: string, snapshotPolicyId: string) => Promise<void>;
    /** Get snapshot policy details */
    getNetappSnapshotPolicyByServiceNameAndSnapshotPolicyId: (serviceName: string, snapshotPolicyId: string) => Promise<StorageNetAppSnapshotPolicy>;
    /** Update a snapshot policy */
    updateNetappSnapshotPolicyByServiceNameAndSnapshotPolicyId: (serviceName: string, snapshotPolicyId: string, body: StorageNetAppSnapshotPolicyUpdate) => Promise<void>;
    /** Terminate your service */
    postNetappTerminateByServiceName: (serviceName: string) => Promise<string>;
}

export { StorageHandler };