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

package/.openapi-generator/FILES

@@ -0,0 +1,105 @@
+.gitignore
+.npmignore
+.openapi-generator-ignore
+README.md
+docs/Agent.md
+docs/AgentProxy.md
+docs/Assessment.md
+docs/AssessmentApi.md
+docs/AssessmentForm.md
+docs/AssessmentUpdate.md
+docs/ClusterRequirementsRequest.md
+docs/ClusterRequirementsResponse.md
+docs/ClusterSizing.md
+docs/Datastore.md
+docs/DiskSizeTierSummary.md
+docs/DiskTypeSummary.md
+docs/HealthApi.md
+docs/Histogram.md
+docs/Host.md
+docs/ImageApi.md
+docs/Info.md
+docs/InfoApi.md
+docs/Infra.md
+docs/Inventory.md
+docs/InventoryData.md
+docs/InventoryTotals.md
+docs/Ipv4Config.md
+docs/Job.md
+docs/JobApi.md
+docs/JobStatus.md
+docs/Label.md
+docs/MigrationIssue.md
+docs/ModelError.md
+docs/Network.md
+docs/OsInfo.md
+docs/PresignedUrl.md
+docs/SizingOverCommitRatio.md
+docs/SizingResourceConsumption.md
+docs/SizingResourceLimits.md
+docs/Snapshot.md
+docs/Source.md
+docs/SourceApi.md
+docs/SourceCreate.md
+docs/SourceInfra.md
+docs/SourceUpdate.md
+docs/Status.md
+docs/UpdateInventory.md
+docs/VCenter.md
+docs/VMResourceBreakdown.md
+docs/VMs.md
+docs/VmNetwork.md
+package.json
+src/apis/AssessmentApi.ts
+src/apis/HealthApi.ts
+src/apis/ImageApi.ts
+src/apis/InfoApi.ts
+src/apis/JobApi.ts
+src/apis/SourceApi.ts
+src/apis/index.ts
+src/index.ts
+src/models/Agent.ts
+src/models/AgentProxy.ts
+src/models/Assessment.ts
+src/models/AssessmentForm.ts
+src/models/AssessmentUpdate.ts
+src/models/ClusterRequirementsRequest.ts
+src/models/ClusterRequirementsResponse.ts
+src/models/ClusterSizing.ts
+src/models/Datastore.ts
+src/models/DiskSizeTierSummary.ts
+src/models/DiskTypeSummary.ts
+src/models/Histogram.ts
+src/models/Host.ts
+src/models/Info.ts
+src/models/Infra.ts
+src/models/Inventory.ts
+src/models/InventoryData.ts
+src/models/InventoryTotals.ts
+src/models/Ipv4Config.ts
+src/models/Job.ts
+src/models/JobStatus.ts
+src/models/Label.ts
+src/models/MigrationIssue.ts
+src/models/ModelError.ts
+src/models/Network.ts
+src/models/OsInfo.ts
+src/models/PresignedUrl.ts
+src/models/SizingOverCommitRatio.ts
+src/models/SizingResourceConsumption.ts
+src/models/SizingResourceLimits.ts
+src/models/Snapshot.ts
+src/models/Source.ts
+src/models/SourceCreate.ts
+src/models/SourceInfra.ts
+src/models/SourceUpdate.ts
+src/models/Status.ts
+src/models/UpdateInventory.ts
+src/models/VCenter.ts
+src/models/VMResourceBreakdown.ts
+src/models/VMs.ts
+src/models/VmNetwork.ts
+src/models/index.ts
+src/runtime.ts
+tsconfig.esm.json
+tsconfig.json

package/.openapi-generator/VERSION

@@ -0,0 +1 @@
+7.21.0-SNAPSHOT

package/.openapi-generator-ignore

@@ -0,0 +1,23 @@
+# OpenAPI Generator Ignore
+# Generated by openapi-generator https://github.com/openapitools/openapi-generator
+
+# Use this file to prevent files from being overwritten by the generator.
+# The patterns follow closely to .gitignore or .dockerignore.
+
+# As an example, the C# client generator defines ApiClient.cs.
+# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
+#ApiClient.cs
+
+# You can match any string of characters against a directory, file or extension with a single asterisk (*):
+#foo/*/qux
+# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
+
+# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
+#foo/**/qux
+# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
+
+# You can also negate patterns with an exclamation (!).
+# For example, you can ignore all files in a docs folder with the file extension .md:
+#docs/*.md
+# Then explicitly reverse the ignore rule for a single file:
+#!docs/README.md

package/README.md

@@ -0,0 +1,173 @@
+# @openshift-migration-advisor/planner-sdk@0.4.0-2926c334319d
+
+A TypeScript SDK client for the raw.githubusercontent.com API.
+
+## Usage
+
+First, install the SDK from npm.
+
+```bash
+npm install @openshift-migration-advisor/planner-sdk --save
+```
+
+Next, try it out.
+
+
+```ts
+import {
+  Configuration,
+  AssessmentApi,
+} from '@openshift-migration-advisor/planner-sdk';
+import type { CalculateAssessmentClusterRequirementsRequest } from '@openshift-migration-advisor/planner-sdk';
+
+async function example() {
+  console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
+  const api = new AssessmentApi();
+
+  const body = {
+    // string | ID of the assessment
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // ClusterRequirementsRequest
+    clusterRequirementsRequest: ...,
+  } satisfies CalculateAssessmentClusterRequirementsRequest;
+
+  try {
+    const data = await api.calculateAssessmentClusterRequirements(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+
+## Documentation
+
+### API Endpoints
+
+All URIs are relative to *https://raw.githubusercontent.com*
+
+| Class | Method | HTTP request | Description
+| ----- | ------ | ------------ | -------------
+*AssessmentApi* | [**calculateAssessmentClusterRequirements**](docs/AssessmentApi.md#calculateassessmentclusterrequirements) | **POST** /api/v1/assessments/{id}/cluster-requirements | 
+*AssessmentApi* | [**createAssessment**](docs/AssessmentApi.md#createassessment) | **POST** /api/v1/assessments | 
+*AssessmentApi* | [**deleteAssessment**](docs/AssessmentApi.md#deleteassessment) | **DELETE** /api/v1/assessments/{id} | 
+*AssessmentApi* | [**getAssessment**](docs/AssessmentApi.md#getassessment) | **GET** /api/v1/assessments/{id} | 
+*AssessmentApi* | [**listAssessments**](docs/AssessmentApi.md#listassessments) | **GET** /api/v1/assessments | 
+*AssessmentApi* | [**updateAssessment**](docs/AssessmentApi.md#updateassessment) | **PUT** /api/v1/assessments/{id} | 
+*HealthApi* | [**health**](docs/HealthApi.md#health) | **GET** /health | 
+*ImageApi* | [**getSourceDownloadURL**](docs/ImageApi.md#getsourcedownloadurl) | **GET** /api/v1/sources/{id}/image-url | 
+*ImageApi* | [**headImage**](docs/ImageApi.md#headimage) | **HEAD** /api/v1/sources/{id}/image | 
+*InfoApi* | [**getInfo**](docs/InfoApi.md#getinfo) | **GET** /api/v1/info | 
+*JobApi* | [**cancelJob**](docs/JobApi.md#canceljob) | **DELETE** /api/v1/assessments/jobs/{id} | 
+*JobApi* | [**createRVToolsAssessment**](docs/JobApi.md#creatervtoolsassessment) | **POST** /api/v1/assessments/rvtools | 
+*JobApi* | [**getJob**](docs/JobApi.md#getjob) | **GET** /api/v1/assessments/jobs/{id} | 
+*SourceApi* | [**createSource**](docs/SourceApi.md#createsource) | **POST** /api/v1/sources | 
+*SourceApi* | [**deleteSource**](docs/SourceApi.md#deletesource) | **DELETE** /api/v1/sources/{id} | 
+*SourceApi* | [**deleteSources**](docs/SourceApi.md#deletesources) | **DELETE** /api/v1/sources | 
+*SourceApi* | [**getSource**](docs/SourceApi.md#getsource) | **GET** /api/v1/sources/{id} | 
+*SourceApi* | [**listSources**](docs/SourceApi.md#listsources) | **GET** /api/v1/sources | 
+*SourceApi* | [**updateInventory**](docs/SourceApi.md#updateinventory) | **PUT** /api/v1/sources/{id}/inventory | 
+*SourceApi* | [**updateSource**](docs/SourceApi.md#updatesource) | **PUT** /api/v1/sources/{id} | 
+
+
+### Models
+
+- [Agent](docs/Agent.md)
+- [AgentProxy](docs/AgentProxy.md)
+- [Assessment](docs/Assessment.md)
+- [AssessmentForm](docs/AssessmentForm.md)
+- [AssessmentUpdate](docs/AssessmentUpdate.md)
+- [ClusterRequirementsRequest](docs/ClusterRequirementsRequest.md)
+- [ClusterRequirementsResponse](docs/ClusterRequirementsResponse.md)
+- [ClusterSizing](docs/ClusterSizing.md)
+- [Datastore](docs/Datastore.md)
+- [DiskSizeTierSummary](docs/DiskSizeTierSummary.md)
+- [DiskTypeSummary](docs/DiskTypeSummary.md)
+- [Histogram](docs/Histogram.md)
+- [Host](docs/Host.md)
+- [Info](docs/Info.md)
+- [Infra](docs/Infra.md)
+- [Inventory](docs/Inventory.md)
+- [InventoryData](docs/InventoryData.md)
+- [InventoryTotals](docs/InventoryTotals.md)
+- [Ipv4Config](docs/Ipv4Config.md)
+- [Job](docs/Job.md)
+- [JobStatus](docs/JobStatus.md)
+- [Label](docs/Label.md)
+- [MigrationIssue](docs/MigrationIssue.md)
+- [ModelError](docs/ModelError.md)
+- [Network](docs/Network.md)
+- [OsInfo](docs/OsInfo.md)
+- [PresignedUrl](docs/PresignedUrl.md)
+- [SizingOverCommitRatio](docs/SizingOverCommitRatio.md)
+- [SizingResourceConsumption](docs/SizingResourceConsumption.md)
+- [SizingResourceLimits](docs/SizingResourceLimits.md)
+- [Snapshot](docs/Snapshot.md)
+- [Source](docs/Source.md)
+- [SourceCreate](docs/SourceCreate.md)
+- [SourceInfra](docs/SourceInfra.md)
+- [SourceUpdate](docs/SourceUpdate.md)
+- [Status](docs/Status.md)
+- [UpdateInventory](docs/UpdateInventory.md)
+- [VCenter](docs/VCenter.md)
+- [VMResourceBreakdown](docs/VMResourceBreakdown.md)
+- [VMs](docs/VMs.md)
+- [VmNetwork](docs/VmNetwork.md)
+
+### Authorization
+
+Endpoints do not require authorization.
+
+
+## About
+
+This TypeScript SDK client supports the [Fetch API](https://fetch.spec.whatwg.org/)
+and is automatically generated by the
+[OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: `undefined`
+- Package version: `0.4.0-2926c334319d`
+- Generator version: `7.21.0-SNAPSHOT`
+- Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
+
+The generated npm module supports the following:
+
+- Environments
+  * Node.js
+  * Webpack
+  * Browserify
+- Language levels
+  * ES5 - you must have a Promises/A+ library installed
+  * ES6
+- Module systems
+  * CommonJS
+  * ES6 module system
+
+
+## Development
+
+### Building
+
+To build the TypeScript source code, you need to have Node.js and npm installed.
+After cloning the repository, navigate to the project directory and run:
+
+```bash
+npm install
+npm run build
+```
+
+### Publishing
+
+Once you've built the package, you can publish it to npm:
+
+```bash
+npm publish
+```
+
+## License
+
+[Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0.html)

package/dist/apis/AssessmentApi.d.ts

@@ -0,0 +1,236 @@
+/**
+ * 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 * as runtime from '../runtime.js';
+import type { Assessment, AssessmentForm, AssessmentUpdate, ClusterRequirementsRequest, ClusterRequirementsResponse } from '../models/index.js';
+export interface CalculateAssessmentClusterRequirementsRequest {
+    id: string;
+    clusterRequirementsRequest: ClusterRequirementsRequest;
+}
+export interface CreateAssessmentRequest {
+    assessmentForm: AssessmentForm;
+}
+export interface DeleteAssessmentRequest {
+    id: string;
+}
+export interface GetAssessmentRequest {
+    id: string;
+}
+export interface ListAssessmentsRequest {
+    sourceId?: string;
+}
+export interface UpdateAssessmentRequest {
+    id: string;
+    assessmentUpdate: AssessmentUpdate;
+}
+/**
+ * AssessmentApi - interface
+ *
+ * @export
+ * @interface AssessmentApiInterface
+ */
+export interface AssessmentApiInterface {
+    /**
+     * Creates request options for calculateAssessmentClusterRequirements without sending the request
+     * @param {string} id ID of the assessment
+     * @param {ClusterRequirementsRequest} clusterRequirementsRequest
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    calculateAssessmentClusterRequirementsRequestOpts(requestParameters: CalculateAssessmentClusterRequirementsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Calculate cluster requirements for an assessment
+     * @param {string} id ID of the assessment
+     * @param {ClusterRequirementsRequest} clusterRequirementsRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    calculateAssessmentClusterRequirementsRaw(requestParameters: CalculateAssessmentClusterRequirementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClusterRequirementsResponse>>;
+    /**
+     * Calculate cluster requirements for an assessment
+     */
+    calculateAssessmentClusterRequirements(requestParameters: CalculateAssessmentClusterRequirementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClusterRequirementsResponse>;
+    /**
+     * Creates request options for createAssessment without sending the request
+     * @param {AssessmentForm} assessmentForm
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    createAssessmentRequestOpts(requestParameters: CreateAssessmentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create an assessment
+     * @param {AssessmentForm} assessmentForm
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    createAssessmentRaw(requestParameters: CreateAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Assessment>>;
+    /**
+     * Create an assessment
+     */
+    createAssessment(requestParameters: CreateAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Assessment>;
+    /**
+     * Creates request options for deleteAssessment without sending the request
+     * @param {string} id ID of the assessment
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    deleteAssessmentRequestOpts(requestParameters: DeleteAssessmentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Delete an assessment
+     * @param {string} id ID of the assessment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    deleteAssessmentRaw(requestParameters: DeleteAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Assessment>>;
+    /**
+     * Delete an assessment
+     */
+    deleteAssessment(requestParameters: DeleteAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Assessment>;
+    /**
+     * Creates request options for getAssessment without sending the request
+     * @param {string} id ID of the assessment
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    getAssessmentRequestOpts(requestParameters: GetAssessmentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get the specified assessment
+     * @param {string} id ID of the assessment
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    getAssessmentRaw(requestParameters: GetAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Assessment>>;
+    /**
+     * Get the specified assessment
+     */
+    getAssessment(requestParameters: GetAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Assessment>;
+    /**
+     * Creates request options for listAssessments without sending the request
+     * @param {string} [sourceId] Filter assessments by source ID
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    listAssessmentsRequestOpts(requestParameters: ListAssessmentsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List assessments
+     * @param {string} [sourceId] Filter assessments by source ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    listAssessmentsRaw(requestParameters: ListAssessmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Assessment>>>;
+    /**
+     * List assessments
+     */
+    listAssessments(requestParameters: ListAssessmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Assessment>>;
+    /**
+     * Creates request options for updateAssessment without sending the request
+     * @param {string} id ID of the assessment
+     * @param {AssessmentUpdate} assessmentUpdate
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    updateAssessmentRequestOpts(requestParameters: UpdateAssessmentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update an assessment
+     * @param {string} id ID of the assessment
+     * @param {AssessmentUpdate} assessmentUpdate
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssessmentApiInterface
+     */
+    updateAssessmentRaw(requestParameters: UpdateAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Assessment>>;
+    /**
+     * Update an assessment
+     */
+    updateAssessment(requestParameters: UpdateAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Assessment>;
+}
+/**
+ *
+ */
+export declare class AssessmentApi extends runtime.BaseAPI implements AssessmentApiInterface {
+    /**
+     * Creates request options for calculateAssessmentClusterRequirements without sending the request
+     */
+    calculateAssessmentClusterRequirementsRequestOpts(requestParameters: CalculateAssessmentClusterRequirementsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Calculate cluster requirements for an assessment
+     */
+    calculateAssessmentClusterRequirementsRaw(requestParameters: CalculateAssessmentClusterRequirementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClusterRequirementsResponse>>;
+    /**
+     * Calculate cluster requirements for an assessment
+     */
+    calculateAssessmentClusterRequirements(requestParameters: CalculateAssessmentClusterRequirementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClusterRequirementsResponse>;
+    /**
+     * Creates request options for createAssessment without sending the request
+     */
+    createAssessmentRequestOpts(requestParameters: CreateAssessmentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create an assessment
+     */
+    createAssessmentRaw(requestParameters: CreateAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Assessment>>;
+    /**
+     * Create an assessment
+     */
+    createAssessment(requestParameters: CreateAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Assessment>;
+    /**
+     * Creates request options for deleteAssessment without sending the request
+     */
+    deleteAssessmentRequestOpts(requestParameters: DeleteAssessmentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Delete an assessment
+     */
+    deleteAssessmentRaw(requestParameters: DeleteAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Assessment>>;
+    /**
+     * Delete an assessment
+     */
+    deleteAssessment(requestParameters: DeleteAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Assessment>;
+    /**
+     * Creates request options for getAssessment without sending the request
+     */
+    getAssessmentRequestOpts(requestParameters: GetAssessmentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get the specified assessment
+     */
+    getAssessmentRaw(requestParameters: GetAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Assessment>>;
+    /**
+     * Get the specified assessment
+     */
+    getAssessment(requestParameters: GetAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Assessment>;
+    /**
+     * Creates request options for listAssessments without sending the request
+     */
+    listAssessmentsRequestOpts(requestParameters: ListAssessmentsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * List assessments
+     */
+    listAssessmentsRaw(requestParameters: ListAssessmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Assessment>>>;
+    /**
+     * List assessments
+     */
+    listAssessments(requestParameters?: ListAssessmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Assessment>>;
+    /**
+     * Creates request options for updateAssessment without sending the request
+     */
+    updateAssessmentRequestOpts(requestParameters: UpdateAssessmentRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update an assessment
+     */
+    updateAssessmentRaw(requestParameters: UpdateAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Assessment>>;
+    /**
+     * Update an assessment
+     */
+    updateAssessment(requestParameters: UpdateAssessmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Assessment>;
+}