@openshift-migration-advisor/planner-sdk 0.4.0-2926c334319d

package/dist/esm/models/VMs.d.ts

@@ -0,0 +1,162 @@
+/**
+ * Migration Planner API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: undefined
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { MigrationIssue } from './MigrationIssue.js';
+import type { OsInfo } from './OsInfo.js';
+import type { DiskSizeTierSummary } from './DiskSizeTierSummary.js';
+import type { DiskTypeSummary } from './DiskTypeSummary.js';
+import type { VMResourceBreakdown } from './VMResourceBreakdown.js';
+/**
+ *
+ * @export
+ * @interface VMs
+ */
+export interface VMs {
+    /**
+     *
+     * @type {number}
+     * @memberof VMs
+     */
+    total: number;
+    /**
+     *
+     * @type {number}
+     * @memberof VMs
+     */
+    totalMigratable: number;
+    /**
+     *
+     * @type {number}
+     * @memberof VMs
+     */
+    totalMigratableWithWarnings?: number;
+    /**
+     * Number of VMs that have at least one shared disk
+     * @type {number}
+     * @memberof VMs
+     */
+    totalWithSharedDisks?: number;
+    /**
+     *
+     * @type {VMResourceBreakdown}
+     * @memberof VMs
+     */
+    cpuCores: VMResourceBreakdown;
+    /**
+     *
+     * @type {{ [key: string]: DiskSizeTierSummary; }}
+     * @memberof VMs
+     */
+    diskSizeTier?: {
+        [key: string]: DiskSizeTierSummary;
+    };
+    /**
+     *
+     * @type {{ [key: string]: DiskTypeSummary; }}
+     * @memberof VMs
+     */
+    diskTypes?: {
+        [key: string]: DiskTypeSummary;
+    };
+    /**
+     * Distribution of VMs across CPU tier buckets (e.g., "0-4", "5-8", "9-16", "17-32", "32+")
+     * @type {{ [key: string]: number; }}
+     * @memberof VMs
+     */
+    distributionByCpuTier?: {
+        [key: string]: number;
+    };
+    /**
+     * Distribution of VMs across Memory tier buckets (e.g., "0-4", "5-16", "17-32", "33-64", "65-128", "129-256", "256+")
+     * @type {{ [key: string]: number; }}
+     * @memberof VMs
+     */
+    distributionByMemoryTier?: {
+        [key: string]: number;
+    };
+    /**
+     * Distribution of VMs by NIC count (e.g., "0", "1", "2", "3", "4+")
+     * @type {{ [key: string]: number; }}
+     * @memberof VMs
+     */
+    distributionByNicCount?: {
+        [key: string]: number;
+    };
+    /**
+     *
+     * @type {VMResourceBreakdown}
+     * @memberof VMs
+     */
+    ramGB: VMResourceBreakdown;
+    /**
+     *
+     * @type {VMResourceBreakdown}
+     * @memberof VMs
+     */
+    diskGB: VMResourceBreakdown;
+    /**
+     *
+     * @type {VMResourceBreakdown}
+     * @memberof VMs
+     */
+    diskCount: VMResourceBreakdown;
+    /**
+     *
+     * @type {VMResourceBreakdown}
+     * @memberof VMs
+     */
+    nicCount?: VMResourceBreakdown;
+    /**
+     *
+     * @type {{ [key: string]: number; }}
+     * @memberof VMs
+     */
+    powerStates: {
+        [key: string]: number;
+    };
+    /**
+     *
+     * @type {{ [key: string]: number; }}
+     * @memberof VMs
+     * @deprecated
+     */
+    os?: {
+        [key: string]: number;
+    };
+    /**
+     *
+     * @type {{ [key: string]: OsInfo; }}
+     * @memberof VMs
+     */
+    osInfo?: {
+        [key: string]: OsInfo;
+    };
+    /**
+     *
+     * @type {Array<MigrationIssue>}
+     * @memberof VMs
+     */
+    notMigratableReasons: Array<MigrationIssue>;
+    /**
+     *
+     * @type {Array<MigrationIssue>}
+     * @memberof VMs
+     */
+    migrationWarnings: Array<MigrationIssue>;
+}
+/**
+ * Check if a given object implements the VMs interface.
+ */
+export declare function instanceOfVMs(value: object): value is VMs;
+export declare function VMsFromJSON(json: any): VMs;
+export declare function VMsFromJSONTyped(json: any, ignoreDiscriminator: boolean): VMs;
+export declare function VMsToJSON(json: any): VMs;
+export declare function VMsToJSONTyped(value?: VMs | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/VMs.js

@@ -0,0 +1,101 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Migration Planner API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: undefined
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { mapValues } from '../runtime.js';
+import { MigrationIssueFromJSON, MigrationIssueToJSON, } from './MigrationIssue.js';
+import { OsInfoFromJSON, OsInfoToJSON, } from './OsInfo.js';
+import { DiskSizeTierSummaryFromJSON, DiskSizeTierSummaryToJSON, } from './DiskSizeTierSummary.js';
+import { DiskTypeSummaryFromJSON, DiskTypeSummaryToJSON, } from './DiskTypeSummary.js';
+import { VMResourceBreakdownFromJSON, VMResourceBreakdownToJSON, } from './VMResourceBreakdown.js';
+/**
+ * Check if a given object implements the VMs interface.
+ */
+export function instanceOfVMs(value) {
+    if (!('total' in value) || value['total'] === undefined)
+        return false;
+    if (!('totalMigratable' in value) || value['totalMigratable'] === undefined)
+        return false;
+    if (!('cpuCores' in value) || value['cpuCores'] === undefined)
+        return false;
+    if (!('ramGB' in value) || value['ramGB'] === undefined)
+        return false;
+    if (!('diskGB' in value) || value['diskGB'] === undefined)
+        return false;
+    if (!('diskCount' in value) || value['diskCount'] === undefined)
+        return false;
+    if (!('powerStates' in value) || value['powerStates'] === undefined)
+        return false;
+    if (!('notMigratableReasons' in value) || value['notMigratableReasons'] === undefined)
+        return false;
+    if (!('migrationWarnings' in value) || value['migrationWarnings'] === undefined)
+        return false;
+    return true;
+}
+export function VMsFromJSON(json) {
+    return VMsFromJSONTyped(json, false);
+}
+export function VMsFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'total': json['total'],
+        'totalMigratable': json['totalMigratable'],
+        'totalMigratableWithWarnings': json['totalMigratableWithWarnings'] == null ? undefined : json['totalMigratableWithWarnings'],
+        'totalWithSharedDisks': json['totalWithSharedDisks'] == null ? undefined : json['totalWithSharedDisks'],
+        'cpuCores': VMResourceBreakdownFromJSON(json['cpuCores']),
+        'diskSizeTier': json['diskSizeTier'] == null ? undefined : (mapValues(json['diskSizeTier'], DiskSizeTierSummaryFromJSON)),
+        'diskTypes': json['diskTypes'] == null ? undefined : (mapValues(json['diskTypes'], DiskTypeSummaryFromJSON)),
+        'distributionByCpuTier': json['distributionByCpuTier'] == null ? undefined : json['distributionByCpuTier'],
+        'distributionByMemoryTier': json['distributionByMemoryTier'] == null ? undefined : json['distributionByMemoryTier'],
+        'distributionByNicCount': json['distributionByNicCount'] == null ? undefined : json['distributionByNicCount'],
+        'ramGB': VMResourceBreakdownFromJSON(json['ramGB']),
+        'diskGB': VMResourceBreakdownFromJSON(json['diskGB']),
+        'diskCount': VMResourceBreakdownFromJSON(json['diskCount']),
+        'nicCount': json['nicCount'] == null ? undefined : VMResourceBreakdownFromJSON(json['nicCount']),
+        'powerStates': json['powerStates'],
+        'os': json['os'] == null ? undefined : json['os'],
+        'osInfo': json['osInfo'] == null ? undefined : (mapValues(json['osInfo'], OsInfoFromJSON)),
+        'notMigratableReasons': (json['notMigratableReasons'].map(MigrationIssueFromJSON)),
+        'migrationWarnings': (json['migrationWarnings'].map(MigrationIssueFromJSON)),
+    };
+}
+export function VMsToJSON(json) {
+    return VMsToJSONTyped(json, false);
+}
+export function VMsToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'total': value['total'],
+        'totalMigratable': value['totalMigratable'],
+        'totalMigratableWithWarnings': value['totalMigratableWithWarnings'],
+        'totalWithSharedDisks': value['totalWithSharedDisks'],
+        'cpuCores': VMResourceBreakdownToJSON(value['cpuCores']),
+        'diskSizeTier': value['diskSizeTier'] == null ? undefined : (mapValues(value['diskSizeTier'], DiskSizeTierSummaryToJSON)),
+        'diskTypes': value['diskTypes'] == null ? undefined : (mapValues(value['diskTypes'], DiskTypeSummaryToJSON)),
+        'distributionByCpuTier': value['distributionByCpuTier'],
+        'distributionByMemoryTier': value['distributionByMemoryTier'],
+        'distributionByNicCount': value['distributionByNicCount'],
+        'ramGB': VMResourceBreakdownToJSON(value['ramGB']),
+        'diskGB': VMResourceBreakdownToJSON(value['diskGB']),
+        'diskCount': VMResourceBreakdownToJSON(value['diskCount']),
+        'nicCount': VMResourceBreakdownToJSON(value['nicCount']),
+        'powerStates': value['powerStates'],
+        'os': value['os'],
+        'osInfo': value['osInfo'] == null ? undefined : (mapValues(value['osInfo'], OsInfoToJSON)),
+        'notMigratableReasons': (value['notMigratableReasons'].map(MigrationIssueToJSON)),
+        'migrationWarnings': (value['migrationWarnings'].map(MigrationIssueToJSON)),
+    };
+}

package/dist/esm/models/VmNetwork.d.ts

@@ -0,0 +1,33 @@
+/**
+ * Migration Planner API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: undefined
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Ipv4Config } from './Ipv4Config.js';
+/**
+ *
+ * @export
+ * @interface VmNetwork
+ */
+export interface VmNetwork {
+    /**
+     *
+     * @type {Ipv4Config}
+     * @memberof VmNetwork
+     */
+    ipv4?: Ipv4Config;
+}
+/**
+ * Check if a given object implements the VmNetwork interface.
+ */
+export declare function instanceOfVmNetwork(value: object): value is VmNetwork;
+export declare function VmNetworkFromJSON(json: any): VmNetwork;
+export declare function VmNetworkFromJSONTyped(json: any, ignoreDiscriminator: boolean): VmNetwork;
+export declare function VmNetworkToJSON(json: any): VmNetwork;
+export declare function VmNetworkToJSONTyped(value?: VmNetwork | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/VmNetwork.js

@@ -0,0 +1,42 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Migration Planner API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: undefined
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { Ipv4ConfigFromJSON, Ipv4ConfigToJSON, } from './Ipv4Config.js';
+/**
+ * Check if a given object implements the VmNetwork interface.
+ */
+export function instanceOfVmNetwork(value) {
+    return true;
+}
+export function VmNetworkFromJSON(json) {
+    return VmNetworkFromJSONTyped(json, false);
+}
+export function VmNetworkFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'ipv4': json['ipv4'] == null ? undefined : Ipv4ConfigFromJSON(json['ipv4']),
+    };
+}
+export function VmNetworkToJSON(json) {
+    return VmNetworkToJSONTyped(json, false);
+}
+export function VmNetworkToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'ipv4': Ipv4ConfigToJSON(value['ipv4']),
+    };
+}

package/dist/esm/models/index.d.ts

@@ -0,0 +1,41 @@
+export * from './Agent.js';
+export * from './AgentProxy.js';
+export * from './Assessment.js';
+export * from './AssessmentForm.js';
+export * from './AssessmentUpdate.js';
+export * from './ClusterRequirementsRequest.js';
+export * from './ClusterRequirementsResponse.js';
+export * from './ClusterSizing.js';
+export * from './Datastore.js';
+export * from './DiskSizeTierSummary.js';
+export * from './DiskTypeSummary.js';
+export * from './Histogram.js';
+export * from './Host.js';
+export * from './Info.js';
+export * from './Infra.js';
+export * from './Inventory.js';
+export * from './InventoryData.js';
+export * from './InventoryTotals.js';
+export * from './Ipv4Config.js';
+export * from './Job.js';
+export * from './JobStatus.js';
+export * from './Label.js';
+export * from './MigrationIssue.js';
+export * from './ModelError.js';
+export * from './Network.js';
+export * from './OsInfo.js';
+export * from './PresignedUrl.js';
+export * from './SizingOverCommitRatio.js';
+export * from './SizingResourceConsumption.js';
+export * from './SizingResourceLimits.js';
+export * from './Snapshot.js';
+export * from './Source.js';
+export * from './SourceCreate.js';
+export * from './SourceInfra.js';
+export * from './SourceUpdate.js';
+export * from './Status.js';
+export * from './UpdateInventory.js';
+export * from './VCenter.js';
+export * from './VMResourceBreakdown.js';
+export * from './VMs.js';
+export * from './VmNetwork.js';

package/dist/esm/models/index.js

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+export * from './Agent.js';
+export * from './AgentProxy.js';
+export * from './Assessment.js';
+export * from './AssessmentForm.js';
+export * from './AssessmentUpdate.js';
+export * from './ClusterRequirementsRequest.js';
+export * from './ClusterRequirementsResponse.js';
+export * from './ClusterSizing.js';
+export * from './Datastore.js';
+export * from './DiskSizeTierSummary.js';
+export * from './DiskTypeSummary.js';
+export * from './Histogram.js';
+export * from './Host.js';
+export * from './Info.js';
+export * from './Infra.js';
+export * from './Inventory.js';
+export * from './InventoryData.js';
+export * from './InventoryTotals.js';
+export * from './Ipv4Config.js';
+export * from './Job.js';
+export * from './JobStatus.js';
+export * from './Label.js';
+export * from './MigrationIssue.js';
+export * from './ModelError.js';
+export * from './Network.js';
+export * from './OsInfo.js';
+export * from './PresignedUrl.js';
+export * from './SizingOverCommitRatio.js';
+export * from './SizingResourceConsumption.js';
+export * from './SizingResourceLimits.js';
+export * from './Snapshot.js';
+export * from './Source.js';
+export * from './SourceCreate.js';
+export * from './SourceInfra.js';
+export * from './SourceUpdate.js';
+export * from './Status.js';
+export * from './UpdateInventory.js';
+export * from './VCenter.js';
+export * from './VMResourceBreakdown.js';
+export * from './VMs.js';
+export * from './VmNetwork.js';

package/dist/esm/runtime.d.ts

@@ -0,0 +1,184 @@
+/**
+ * Migration Planner API
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: undefined
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+export declare const BASE_PATH: string;
+export interface ConfigurationParameters {
+    basePath?: string;
+    fetchApi?: FetchAPI;
+    middleware?: Middleware[];
+    queryParamsStringify?: (params: HTTPQuery) => string;
+    username?: string;
+    password?: string;
+    apiKey?: string | Promise<string> | ((name: string) => string | Promise<string>);
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string | Promise<string>);
+    headers?: HTTPHeaders;
+    credentials?: RequestCredentials;
+}
+export declare class Configuration {
+    private configuration;
+    constructor(configuration?: ConfigurationParameters);
+    set config(configuration: Configuration);
+    get basePath(): string;
+    get fetchApi(): FetchAPI | undefined;
+    get middleware(): Middleware[];
+    get queryParamsStringify(): (params: HTTPQuery) => string;
+    get username(): string | undefined;
+    get password(): string | undefined;
+    get apiKey(): ((name: string) => string | Promise<string>) | undefined;
+    get accessToken(): ((name?: string, scopes?: string[]) => string | Promise<string>) | undefined;
+    get headers(): HTTPHeaders | undefined;
+    get credentials(): RequestCredentials | undefined;
+}
+export declare const DefaultConfig: Configuration;
+/**
+ * This is the base class for all generated API classes.
+ */
+export declare class BaseAPI {
+    protected configuration: Configuration;
+    private static readonly jsonRegex;
+    private middleware;
+    constructor(configuration?: Configuration);
+    withMiddleware<T extends BaseAPI>(this: T, ...middlewares: Middleware[]): T;
+    withPreMiddleware<T extends BaseAPI>(this: T, ...preMiddlewares: Array<Middleware['pre']>): T;
+    withPostMiddleware<T extends BaseAPI>(this: T, ...postMiddlewares: Array<Middleware['post']>): T;
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    protected isJsonMime(mime: string | null | undefined): boolean;
+    protected request(context: RequestOpts, initOverrides?: RequestInit | InitOverrideFunction): Promise<Response>;
+    private createFetchParams;
+    private fetchApi;
+    /**
+     * Create a shallow clone of `this` by constructing a new instance
+     * and then shallow cloning data members.
+     */
+    private clone;
+}
+export declare class ResponseError extends Error {
+    response: Response;
+    name: "ResponseError";
+    constructor(response: Response, msg?: string);
+}
+export declare class FetchError extends Error {
+    cause: Error;
+    name: "FetchError";
+    constructor(cause: Error, msg?: string);
+}
+export declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+export type FetchAPI = WindowOrWorkerGlobalScope['fetch'];
+export type Json = any;
+export type HTTPMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
+export type HTTPHeaders = {
+    [key: string]: string;
+};
+export type HTTPQuery = {
+    [key: string]: string | number | null | boolean | Array<string | number | null | boolean> | Set<string | number | null | boolean> | HTTPQuery;
+};
+export type HTTPBody = Json | FormData | URLSearchParams;
+export type HTTPRequestInit = {
+    headers?: HTTPHeaders;
+    method: HTTPMethod;
+    credentials?: RequestCredentials;
+    body?: HTTPBody;
+};
+export type ModelPropertyNaming = 'camelCase' | 'snake_case' | 'PascalCase' | 'original';
+export type InitOverrideFunction = (requestContext: {
+    init: HTTPRequestInit;
+    context: RequestOpts;
+}) => Promise<RequestInit>;
+export interface FetchParams {
+    url: string;
+    init: RequestInit;
+}
+export interface RequestOpts {
+    path: string;
+    method: HTTPMethod;
+    headers: HTTPHeaders;
+    query?: HTTPQuery;
+    body?: HTTPBody;
+}
+export declare function querystring(params: HTTPQuery, prefix?: string): string;
+export declare function exists(json: any, key: string): boolean;
+export declare function mapValues(data: any, fn: (item: any) => any): {
+    [key: string]: any;
+};
+export declare function canConsumeForm(consumes: Consume[]): boolean;
+export interface Consume {
+    contentType: string;
+}
+export interface RequestContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+}
+export interface ResponseContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    response: Response;
+}
+export interface ErrorContext {
+    fetch: FetchAPI;
+    url: string;
+    init: RequestInit;
+    error: unknown;
+    response?: Response;
+}
+export interface Middleware {
+    pre?(context: RequestContext): Promise<FetchParams | void>;
+    post?(context: ResponseContext): Promise<Response | void>;
+    onError?(context: ErrorContext): Promise<Response | void>;
+}
+export interface ApiResponse<T> {
+    raw: Response;
+    value(): Promise<T>;
+}
+export interface ResponseTransformer<T> {
+    (json: any): T;
+}
+export declare class JSONApiResponse<T> {
+    raw: Response;
+    private transformer;
+    constructor(raw: Response, transformer?: ResponseTransformer<T>);
+    value(): Promise<T>;
+}
+export declare class VoidApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<void>;
+}
+export declare class BlobApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<Blob>;
+}
+export declare class TextApiResponse {
+    raw: Response;
+    constructor(raw: Response);
+    value(): Promise<string>;
+}