@openshift-migration-advisor/planner-sdk 0.20.2 → 0.20.3-7b7fa251be69

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (116) hide show
  1. package/.openapi-generator/FILES +22 -0
  2. package/README.md +15 -2
  3. package/dist/apis/AssessmentApi.d.ts +81 -0
  4. package/dist/apis/AssessmentApi.js +84 -0
  5. package/dist/esm/apis/AssessmentApi.d.ts +81 -0
  6. package/dist/esm/apis/AssessmentApi.js +84 -0
  7. package/dist/esm/models/ActiveEnvironmentsInput.d.ts +41 -0
  8. package/dist/esm/models/ActiveEnvironmentsInput.js +51 -0
  9. package/dist/esm/models/Agent.js +4 -4
  10. package/dist/esm/models/AriaAutomationInput.d.ts +51 -0
  11. package/dist/esm/models/AriaAutomationInput.js +61 -0
  12. package/dist/esm/models/AriaOpsInput.d.ts +49 -0
  13. package/dist/esm/models/AriaOpsInput.js +59 -0
  14. package/dist/esm/models/AriaSecureInput.d.ts +41 -0
  15. package/dist/esm/models/AriaSecureInput.js +51 -0
  16. package/dist/esm/models/Assessment.js +2 -2
  17. package/dist/esm/models/AssessmentSubsetInventory.js +2 -2
  18. package/dist/esm/models/CustomerDetailsInput.d.ts +34 -0
  19. package/dist/esm/models/CustomerDetailsInput.js +43 -0
  20. package/dist/esm/models/DeployedEnvironmentInput.d.ts +40 -0
  21. package/dist/esm/models/DeployedEnvironmentInput.js +50 -0
  22. package/dist/esm/models/EnhancementData.d.ts +76 -0
  23. package/dist/esm/models/EnhancementData.js +69 -0
  24. package/dist/esm/models/Group.js +4 -4
  25. package/dist/esm/models/Host.d.ts +8 -0
  26. package/dist/esm/models/Host.js +4 -0
  27. package/dist/esm/models/Inventory.d.ts +4 -0
  28. package/dist/esm/models/Inventory.js +2 -0
  29. package/dist/esm/models/Member.js +2 -2
  30. package/dist/esm/models/NsxInput.d.ts +46 -0
  31. package/dist/esm/models/NsxInput.js +56 -0
  32. package/dist/esm/models/PartnerRequest.js +2 -2
  33. package/dist/esm/models/Snapshot.js +2 -2
  34. package/dist/esm/models/Source.js +4 -4
  35. package/dist/esm/models/VMwareSubscriptionInput.d.ts +42 -0
  36. package/dist/esm/models/VMwareSubscriptionInput.js +52 -0
  37. package/dist/esm/models/VMwareVersionCountsInput.d.ts +42 -0
  38. package/dist/esm/models/VMwareVersionCountsInput.js +47 -0
  39. package/dist/esm/models/VsphereCoreInput.d.ts +38 -0
  40. package/dist/esm/models/VsphereCoreInput.js +45 -0
  41. package/dist/esm/models/index.d.ts +11 -0
  42. package/dist/esm/models/index.js +11 -0
  43. package/dist/models/ActiveEnvironmentsInput.d.ts +41 -0
  44. package/dist/models/ActiveEnvironmentsInput.js +59 -0
  45. package/dist/models/Agent.js +4 -4
  46. package/dist/models/AriaAutomationInput.d.ts +51 -0
  47. package/dist/models/AriaAutomationInput.js +69 -0
  48. package/dist/models/AriaOpsInput.d.ts +49 -0
  49. package/dist/models/AriaOpsInput.js +67 -0
  50. package/dist/models/AriaSecureInput.d.ts +41 -0
  51. package/dist/models/AriaSecureInput.js +59 -0
  52. package/dist/models/Assessment.js +2 -2
  53. package/dist/models/AssessmentSubsetInventory.js +2 -2
  54. package/dist/models/CustomerDetailsInput.d.ts +34 -0
  55. package/dist/models/CustomerDetailsInput.js +50 -0
  56. package/dist/models/DeployedEnvironmentInput.d.ts +40 -0
  57. package/dist/models/DeployedEnvironmentInput.js +58 -0
  58. package/dist/models/EnhancementData.d.ts +76 -0
  59. package/dist/models/EnhancementData.js +76 -0
  60. package/dist/models/Group.js +4 -4
  61. package/dist/models/Host.d.ts +8 -0
  62. package/dist/models/Host.js +4 -0
  63. package/dist/models/Inventory.d.ts +4 -0
  64. package/dist/models/Inventory.js +2 -0
  65. package/dist/models/Member.js +2 -2
  66. package/dist/models/NsxInput.d.ts +46 -0
  67. package/dist/models/NsxInput.js +64 -0
  68. package/dist/models/PartnerRequest.js +2 -2
  69. package/dist/models/Snapshot.js +2 -2
  70. package/dist/models/Source.js +4 -4
  71. package/dist/models/VMwareSubscriptionInput.d.ts +42 -0
  72. package/dist/models/VMwareSubscriptionInput.js +60 -0
  73. package/dist/models/VMwareVersionCountsInput.d.ts +42 -0
  74. package/dist/models/VMwareVersionCountsInput.js +54 -0
  75. package/dist/models/VsphereCoreInput.d.ts +38 -0
  76. package/dist/models/VsphereCoreInput.js +52 -0
  77. package/dist/models/index.d.ts +11 -0
  78. package/dist/models/index.js +11 -0
  79. package/docs/ActiveEnvironmentsInput.md +34 -0
  80. package/docs/AriaAutomationInput.md +34 -0
  81. package/docs/AriaOpsInput.md +34 -0
  82. package/docs/AriaSecureInput.md +34 -0
  83. package/docs/AssessmentApi.md +148 -0
  84. package/docs/CustomerDetailsInput.md +36 -0
  85. package/docs/DeployedEnvironmentInput.md +34 -0
  86. package/docs/EnhancementData.md +53 -0
  87. package/docs/Host.md +4 -0
  88. package/docs/Inventory.md +2 -0
  89. package/docs/NsxInput.md +34 -0
  90. package/docs/VMwareSubscriptionInput.md +34 -0
  91. package/docs/VMwareVersionCountsInput.md +40 -0
  92. package/docs/VsphereCoreInput.md +38 -0
  93. package/package.json +1 -1
  94. package/src/apis/AssessmentApi.ts +169 -0
  95. package/src/models/ActiveEnvironmentsInput.ts +77 -0
  96. package/src/models/Agent.ts +4 -4
  97. package/src/models/AriaAutomationInput.ts +87 -0
  98. package/src/models/AriaOpsInput.ts +85 -0
  99. package/src/models/AriaSecureInput.ts +77 -0
  100. package/src/models/Assessment.ts +2 -2
  101. package/src/models/AssessmentSubsetInventory.ts +2 -2
  102. package/src/models/CustomerDetailsInput.ts +69 -0
  103. package/src/models/DeployedEnvironmentInput.ts +76 -0
  104. package/src/models/EnhancementData.ts +188 -0
  105. package/src/models/Group.ts +4 -4
  106. package/src/models/Host.ts +12 -0
  107. package/src/models/Inventory.ts +6 -0
  108. package/src/models/Member.ts +2 -2
  109. package/src/models/NsxInput.ts +82 -0
  110. package/src/models/PartnerRequest.ts +2 -2
  111. package/src/models/Snapshot.ts +2 -2
  112. package/src/models/Source.ts +4 -4
  113. package/src/models/VMwareSubscriptionInput.ts +78 -0
  114. package/src/models/VMwareVersionCountsInput.ts +81 -0
  115. package/src/models/VsphereCoreInput.ts +75 -0
  116. package/src/models/index.ts +11 -0
@@ -0,0 +1,54 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * OpenShift Migration Advisor API
6
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+ *
8
+ * The version of the OpenAPI document: v1alpha1
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfVMwareVersionCountsInput = instanceOfVMwareVersionCountsInput;
17
+ exports.VMwareVersionCountsInputFromJSON = VMwareVersionCountsInputFromJSON;
18
+ exports.VMwareVersionCountsInputFromJSONTyped = VMwareVersionCountsInputFromJSONTyped;
19
+ exports.VMwareVersionCountsInputToJSON = VMwareVersionCountsInputToJSON;
20
+ exports.VMwareVersionCountsInputToJSONTyped = VMwareVersionCountsInputToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the VMwareVersionCountsInput interface.
23
+ */
24
+ function instanceOfVMwareVersionCountsInput(value) {
25
+ return true;
26
+ }
27
+ function VMwareVersionCountsInputFromJSON(json) {
28
+ return VMwareVersionCountsInputFromJSONTyped(json, false);
29
+ }
30
+ function VMwareVersionCountsInputFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'perpetualLicensesCount': json['perpetualLicensesCount'] == null ? undefined : json['perpetualLicensesCount'],
36
+ 'coresLicensingCount': json['coresLicensingCount'] == null ? undefined : json['coresLicensingCount'],
37
+ 'environmentCount': json['environmentCount'] == null ? undefined : json['environmentCount'],
38
+ 'otherNodesCount': json['otherNodesCount'] == null ? undefined : json['otherNodesCount'],
39
+ };
40
+ }
41
+ function VMwareVersionCountsInputToJSON(json) {
42
+ return VMwareVersionCountsInputToJSONTyped(json, false);
43
+ }
44
+ function VMwareVersionCountsInputToJSONTyped(value, ignoreDiscriminator = false) {
45
+ if (value == null) {
46
+ return value;
47
+ }
48
+ return {
49
+ 'perpetualLicensesCount': value['perpetualLicensesCount'],
50
+ 'coresLicensingCount': value['coresLicensingCount'],
51
+ 'environmentCount': value['environmentCount'],
52
+ 'otherNodesCount': value['otherNodesCount'],
53
+ };
54
+ }
@@ -0,0 +1,38 @@
1
+ /**
2
+ * OpenShift Migration Advisor API
3
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
4
+ *
5
+ * The version of the OpenAPI document: v1alpha1
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface VsphereCoreInput
16
+ */
17
+ export interface VsphereCoreInput {
18
+ /**
19
+ *
20
+ */
21
+ vmEncryptionEnabled?: boolean;
22
+ /**
23
+ *
24
+ */
25
+ vmEncryptionPolicy?: string;
26
+ /**
27
+ *
28
+ */
29
+ srmEnabled?: boolean;
30
+ }
31
+ /**
32
+ * Check if a given object implements the VsphereCoreInput interface.
33
+ */
34
+ export declare function instanceOfVsphereCoreInput(value: object): value is VsphereCoreInput;
35
+ export declare function VsphereCoreInputFromJSON(json: any): VsphereCoreInput;
36
+ export declare function VsphereCoreInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): VsphereCoreInput;
37
+ export declare function VsphereCoreInputToJSON(json: any): VsphereCoreInput;
38
+ export declare function VsphereCoreInputToJSONTyped(value?: VsphereCoreInput | null, ignoreDiscriminator?: boolean): any;
@@ -0,0 +1,52 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * OpenShift Migration Advisor API
6
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
7
+ *
8
+ * The version of the OpenAPI document: v1alpha1
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
16
+ exports.instanceOfVsphereCoreInput = instanceOfVsphereCoreInput;
17
+ exports.VsphereCoreInputFromJSON = VsphereCoreInputFromJSON;
18
+ exports.VsphereCoreInputFromJSONTyped = VsphereCoreInputFromJSONTyped;
19
+ exports.VsphereCoreInputToJSON = VsphereCoreInputToJSON;
20
+ exports.VsphereCoreInputToJSONTyped = VsphereCoreInputToJSONTyped;
21
+ /**
22
+ * Check if a given object implements the VsphereCoreInput interface.
23
+ */
24
+ function instanceOfVsphereCoreInput(value) {
25
+ return true;
26
+ }
27
+ function VsphereCoreInputFromJSON(json) {
28
+ return VsphereCoreInputFromJSONTyped(json, false);
29
+ }
30
+ function VsphereCoreInputFromJSONTyped(json, ignoreDiscriminator) {
31
+ if (json == null) {
32
+ return json;
33
+ }
34
+ return {
35
+ 'vmEncryptionEnabled': json['vmEncryptionEnabled'] == null ? undefined : json['vmEncryptionEnabled'],
36
+ 'vmEncryptionPolicy': json['vmEncryptionPolicy'] == null ? undefined : json['vmEncryptionPolicy'],
37
+ 'srmEnabled': json['srmEnabled'] == null ? undefined : json['srmEnabled'],
38
+ };
39
+ }
40
+ function VsphereCoreInputToJSON(json) {
41
+ return VsphereCoreInputToJSONTyped(json, false);
42
+ }
43
+ function VsphereCoreInputToJSONTyped(value, ignoreDiscriminator = false) {
44
+ if (value == null) {
45
+ return value;
46
+ }
47
+ return {
48
+ 'vmEncryptionEnabled': value['vmEncryptionEnabled'],
49
+ 'vmEncryptionPolicy': value['vmEncryptionPolicy'],
50
+ 'srmEnabled': value['srmEnabled'],
51
+ };
52
+ }
@@ -1,5 +1,9 @@
1
+ export * from './ActiveEnvironmentsInput.js';
1
2
  export * from './Agent.js';
2
3
  export * from './AgentProxy.js';
4
+ export * from './AriaAutomationInput.js';
5
+ export * from './AriaOpsInput.js';
6
+ export * from './AriaSecureInput.js';
3
7
  export * from './Assessment.js';
4
8
  export * from './AssessmentForm.js';
5
9
  export * from './AssessmentSharing.js';
@@ -16,9 +20,12 @@ export * from './ComplexityOSNameEntry.js';
16
20
  export * from './ComplexityOSScoreEntry.js';
17
21
  export * from './CpuOverCommitRatio.js';
18
22
  export * from './Customer.js';
23
+ export * from './CustomerDetailsInput.js';
19
24
  export * from './Datastore.js';
25
+ export * from './DeployedEnvironmentInput.js';
20
26
  export * from './DiskSizeTierSummary.js';
21
27
  export * from './DiskTypeSummary.js';
28
+ export * from './EnhancementData.js';
22
29
  export * from './EstimationContext.js';
23
30
  export * from './EstimationDetail.js';
24
31
  export * from './Group.js';
@@ -49,6 +56,7 @@ export * from './MigrationEstimationResponse.js';
49
56
  export * from './MigrationIssue.js';
50
57
  export * from './ModelError.js';
51
58
  export * from './Network.js';
59
+ export * from './NsxInput.js';
52
60
  export * from './OptimizationStatus.js';
53
61
  export * from './OsDiskEstimationEntry.js';
54
62
  export * from './OsInfo.js';
@@ -77,4 +85,7 @@ export * from './UpdateInventory.js';
77
85
  export * from './VCenter.js';
78
86
  export * from './VMResourceBreakdown.js';
79
87
  export * from './VMs.js';
88
+ export * from './VMwareSubscriptionInput.js';
89
+ export * from './VMwareVersionCountsInput.js';
80
90
  export * from './VmNetwork.js';
91
+ export * from './VsphereCoreInput.js';
@@ -16,8 +16,12 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
16
16
  Object.defineProperty(exports, "__esModule", { value: true });
17
17
  /* tslint:disable */
18
18
  /* eslint-disable */
19
+ __exportStar(require("./ActiveEnvironmentsInput.js"), exports);
19
20
  __exportStar(require("./Agent.js"), exports);
20
21
  __exportStar(require("./AgentProxy.js"), exports);
22
+ __exportStar(require("./AriaAutomationInput.js"), exports);
23
+ __exportStar(require("./AriaOpsInput.js"), exports);
24
+ __exportStar(require("./AriaSecureInput.js"), exports);
21
25
  __exportStar(require("./Assessment.js"), exports);
22
26
  __exportStar(require("./AssessmentForm.js"), exports);
23
27
  __exportStar(require("./AssessmentSharing.js"), exports);
@@ -34,9 +38,12 @@ __exportStar(require("./ComplexityOSNameEntry.js"), exports);
34
38
  __exportStar(require("./ComplexityOSScoreEntry.js"), exports);
35
39
  __exportStar(require("./CpuOverCommitRatio.js"), exports);
36
40
  __exportStar(require("./Customer.js"), exports);
41
+ __exportStar(require("./CustomerDetailsInput.js"), exports);
37
42
  __exportStar(require("./Datastore.js"), exports);
43
+ __exportStar(require("./DeployedEnvironmentInput.js"), exports);
38
44
  __exportStar(require("./DiskSizeTierSummary.js"), exports);
39
45
  __exportStar(require("./DiskTypeSummary.js"), exports);
46
+ __exportStar(require("./EnhancementData.js"), exports);
40
47
  __exportStar(require("./EstimationContext.js"), exports);
41
48
  __exportStar(require("./EstimationDetail.js"), exports);
42
49
  __exportStar(require("./Group.js"), exports);
@@ -67,6 +74,7 @@ __exportStar(require("./MigrationEstimationResponse.js"), exports);
67
74
  __exportStar(require("./MigrationIssue.js"), exports);
68
75
  __exportStar(require("./ModelError.js"), exports);
69
76
  __exportStar(require("./Network.js"), exports);
77
+ __exportStar(require("./NsxInput.js"), exports);
70
78
  __exportStar(require("./OptimizationStatus.js"), exports);
71
79
  __exportStar(require("./OsDiskEstimationEntry.js"), exports);
72
80
  __exportStar(require("./OsInfo.js"), exports);
@@ -95,4 +103,7 @@ __exportStar(require("./UpdateInventory.js"), exports);
95
103
  __exportStar(require("./VCenter.js"), exports);
96
104
  __exportStar(require("./VMResourceBreakdown.js"), exports);
97
105
  __exportStar(require("./VMs.js"), exports);
106
+ __exportStar(require("./VMwareSubscriptionInput.js"), exports);
107
+ __exportStar(require("./VMwareVersionCountsInput.js"), exports);
98
108
  __exportStar(require("./VmNetwork.js"), exports);
109
+ __exportStar(require("./VsphereCoreInput.js"), exports);
@@ -0,0 +1,34 @@
1
+
2
+ # ActiveEnvironmentsInput
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `environments` | Set<string>
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { ActiveEnvironmentsInput } from '@openshift-migration-advisor/planner-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "environments": null,
19
+ } satisfies ActiveEnvironmentsInput
20
+
21
+ console.log(example)
22
+
23
+ // Convert the instance to a JSON string
24
+ const exampleJSON: string = JSON.stringify(example)
25
+ console.log(exampleJSON)
26
+
27
+ // Parse the JSON string back to an object
28
+ const exampleParsed = JSON.parse(exampleJSON) as ActiveEnvironmentsInput
29
+ console.log(exampleParsed)
30
+ ```
31
+
32
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
33
+
34
+
@@ -0,0 +1,34 @@
1
+
2
+ # AriaAutomationInput
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `features` | Set<string>
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { AriaAutomationInput } from '@openshift-migration-advisor/planner-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "features": null,
19
+ } satisfies AriaAutomationInput
20
+
21
+ console.log(example)
22
+
23
+ // Convert the instance to a JSON string
24
+ const exampleJSON: string = JSON.stringify(example)
25
+ console.log(exampleJSON)
26
+
27
+ // Parse the JSON string back to an object
28
+ const exampleParsed = JSON.parse(exampleJSON) as AriaAutomationInput
29
+ console.log(exampleParsed)
30
+ ```
31
+
32
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
33
+
34
+
@@ -0,0 +1,34 @@
1
+
2
+ # AriaOpsInput
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `features` | Set<string>
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { AriaOpsInput } from '@openshift-migration-advisor/planner-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "features": null,
19
+ } satisfies AriaOpsInput
20
+
21
+ console.log(example)
22
+
23
+ // Convert the instance to a JSON string
24
+ const exampleJSON: string = JSON.stringify(example)
25
+ console.log(exampleJSON)
26
+
27
+ // Parse the JSON string back to an object
28
+ const exampleParsed = JSON.parse(exampleJSON) as AriaOpsInput
29
+ console.log(exampleParsed)
30
+ ```
31
+
32
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
33
+
34
+
@@ -0,0 +1,34 @@
1
+
2
+ # AriaSecureInput
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `features` | Set<string>
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { AriaSecureInput } from '@openshift-migration-advisor/planner-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "features": null,
19
+ } satisfies AriaSecureInput
20
+
21
+ console.log(example)
22
+
23
+ // Convert the instance to a JSON string
24
+ const exampleJSON: string = JSON.stringify(example)
25
+ console.log(exampleJSON)
26
+
27
+ // Parse the JSON string back to an object
28
+ const exampleParsed = JSON.parse(exampleJSON) as AriaSecureInput
29
+ console.log(exampleParsed)
30
+ ```
31
+
32
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
33
+
34
+
@@ -12,7 +12,9 @@ All URIs are relative to *https://raw.githubusercontent.com*
12
12
  | [**deleteAssessment**](AssessmentApi.md#deleteassessment) | **DELETE** /api/v1/assessments/{id} | |
13
13
  | [**getAssessment**](AssessmentApi.md#getassessment) | **GET** /api/v1/assessments/{id} | |
14
14
  | [**getAssessmentClusterRequirementsStoredInput**](AssessmentApi.md#getassessmentclusterrequirementsstoredinput) | **GET** /api/v1/assessments/{id}/cluster-requirements/stored-input | |
15
+ | [**getAssessmentEnhancementData**](AssessmentApi.md#getassessmentenhancementdata) | **GET** /api/v1/assessments/{id}/enhancement-data | |
15
16
  | [**listAssessments**](AssessmentApi.md#listassessments) | **GET** /api/v1/assessments | |
17
+ | [**saveAssessmentEnhancementData**](AssessmentApi.md#saveassessmentenhancementdata) | **POST** /api/v1/assessments/{id}/enhancement-data | |
16
18
  | [**shareAssessment**](AssessmentApi.md#shareassessment) | **POST** /api/v1/assessments/{id}/share | |
17
19
  | [**unshareAssessment**](AssessmentApi.md#unshareassessment) | **DELETE** /api/v1/assessments/{id}/share | |
18
20
  | [**updateAssessment**](AssessmentApi.md#updateassessment) | **PUT** /api/v1/assessments/{id} | |
@@ -609,6 +611,77 @@ No authorization required
609
611
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
610
612
 
611
613
 
614
+ ## getAssessmentEnhancementData
615
+
616
+ > EnhancementData getAssessmentEnhancementData(id)
617
+
618
+
619
+
620
+ Get stored enhancement data for an assessment
621
+
622
+ ### Example
623
+
624
+ ```ts
625
+ import {
626
+ Configuration,
627
+ AssessmentApi,
628
+ } from '@openshift-migration-advisor/planner-sdk';
629
+ import type { GetAssessmentEnhancementDataRequest } from '@openshift-migration-advisor/planner-sdk';
630
+
631
+ async function example() {
632
+ console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
633
+ const api = new AssessmentApi();
634
+
635
+ const body = {
636
+ // string | ID of the assessment
637
+ id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
638
+ } satisfies GetAssessmentEnhancementDataRequest;
639
+
640
+ try {
641
+ const data = await api.getAssessmentEnhancementData(body);
642
+ console.log(data);
643
+ } catch (error) {
644
+ console.error(error);
645
+ }
646
+ }
647
+
648
+ // Run the test
649
+ example().catch(console.error);
650
+ ```
651
+
652
+ ### Parameters
653
+
654
+
655
+ | Name | Type | Description | Notes |
656
+ |------------- | ------------- | ------------- | -------------|
657
+ | **id** | `string` | ID of the assessment | [Defaults to `undefined`] |
658
+
659
+ ### Return type
660
+
661
+ [**EnhancementData**](EnhancementData.md)
662
+
663
+ ### Authorization
664
+
665
+ No authorization required
666
+
667
+ ### HTTP request headers
668
+
669
+ - **Content-Type**: Not defined
670
+ - **Accept**: `application/json`
671
+
672
+
673
+ ### HTTP response details
674
+ | Status code | Description | Response headers |
675
+ |-------------|-------------|------------------|
676
+ | **200** | User inputs found | - |
677
+ | **401** | Unauthorized | - |
678
+ | **403** | Forbidden | - |
679
+ | **404** | Assessment not found | - |
680
+ | **500** | Internal error | - |
681
+
682
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
683
+
684
+
612
685
  ## listAssessments
613
686
 
614
687
  > Array<Assessment> listAssessments(sourceId)
@@ -678,6 +751,81 @@ No authorization required
678
751
  [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
679
752
 
680
753
 
754
+ ## saveAssessmentEnhancementData
755
+
756
+ > EnhancementData saveAssessmentEnhancementData(id, enhancementData)
757
+
758
+
759
+
760
+ Save enhancement data for an assessment
761
+
762
+ ### Example
763
+
764
+ ```ts
765
+ import {
766
+ Configuration,
767
+ AssessmentApi,
768
+ } from '@openshift-migration-advisor/planner-sdk';
769
+ import type { SaveAssessmentEnhancementDataRequest } from '@openshift-migration-advisor/planner-sdk';
770
+
771
+ async function example() {
772
+ console.log("🚀 Testing @openshift-migration-advisor/planner-sdk SDK...");
773
+ const api = new AssessmentApi();
774
+
775
+ const body = {
776
+ // string | ID of the assessment
777
+ id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
778
+ // EnhancementData
779
+ enhancementData: ...,
780
+ } satisfies SaveAssessmentEnhancementDataRequest;
781
+
782
+ try {
783
+ const data = await api.saveAssessmentEnhancementData(body);
784
+ console.log(data);
785
+ } catch (error) {
786
+ console.error(error);
787
+ }
788
+ }
789
+
790
+ // Run the test
791
+ example().catch(console.error);
792
+ ```
793
+
794
+ ### Parameters
795
+
796
+
797
+ | Name | Type | Description | Notes |
798
+ |------------- | ------------- | ------------- | -------------|
799
+ | **id** | `string` | ID of the assessment | [Defaults to `undefined`] |
800
+ | **enhancementData** | [EnhancementData](EnhancementData.md) | | |
801
+
802
+ ### Return type
803
+
804
+ [**EnhancementData**](EnhancementData.md)
805
+
806
+ ### Authorization
807
+
808
+ No authorization required
809
+
810
+ ### HTTP request headers
811
+
812
+ - **Content-Type**: `application/json`
813
+ - **Accept**: `application/json`
814
+
815
+
816
+ ### HTTP response details
817
+ | Status code | Description | Response headers |
818
+ |-------------|-------------|------------------|
819
+ | **200** | User inputs saved successfully | - |
820
+ | **400** | Bad Request | - |
821
+ | **401** | Unauthorized | - |
822
+ | **403** | Forbidden | - |
823
+ | **404** | Assessment not found | - |
824
+ | **500** | Internal error | - |
825
+
826
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
827
+
828
+
681
829
  ## shareAssessment
682
830
 
683
831
  > Status shareAssessment(id)
@@ -0,0 +1,36 @@
1
+
2
+ # CustomerDetailsInput
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `physicalLocationsCount` | number
10
+ `targetHardware` | string
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import type { CustomerDetailsInput } from '@openshift-migration-advisor/planner-sdk'
16
+
17
+ // TODO: Update the object below with actual values
18
+ const example = {
19
+ "physicalLocationsCount": null,
20
+ "targetHardware": null,
21
+ } satisfies CustomerDetailsInput
22
+
23
+ console.log(example)
24
+
25
+ // Convert the instance to a JSON string
26
+ const exampleJSON: string = JSON.stringify(example)
27
+ console.log(exampleJSON)
28
+
29
+ // Parse the JSON string back to an object
30
+ const exampleParsed = JSON.parse(exampleJSON) as CustomerDetailsInput
31
+ console.log(exampleParsed)
32
+ ```
33
+
34
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
35
+
36
+
@@ -0,0 +1,34 @@
1
+
2
+ # DeployedEnvironmentInput
3
+
4
+
5
+ ## Properties
6
+
7
+ Name | Type
8
+ ------------ | -------------
9
+ `environment` | string
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import type { DeployedEnvironmentInput } from '@openshift-migration-advisor/planner-sdk'
15
+
16
+ // TODO: Update the object below with actual values
17
+ const example = {
18
+ "environment": null,
19
+ } satisfies DeployedEnvironmentInput
20
+
21
+ console.log(example)
22
+
23
+ // Convert the instance to a JSON string
24
+ const exampleJSON: string = JSON.stringify(example)
25
+ console.log(exampleJSON)
26
+
27
+ // Parse the JSON string back to an object
28
+ const exampleParsed = JSON.parse(exampleJSON) as DeployedEnvironmentInput
29
+ console.log(exampleParsed)
30
+ ```
31
+
32
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
33
+
34
+
@@ -0,0 +1,53 @@
1
+
2
+ # EnhancementData
3
+
4
+ VMA enhancement data — fields that cannot be auto-collected by Agent or RVTools
5
+
6
+ ## Properties
7
+
8
+ Name | Type
9
+ ------------ | -------------
10
+ `deployedEnvironment` | [DeployedEnvironmentInput](DeployedEnvironmentInput.md)
11
+ `vmwareVersionCounts` | [VMwareVersionCountsInput](VMwareVersionCountsInput.md)
12
+ `activeEnvironments` | [ActiveEnvironmentsInput](ActiveEnvironmentsInput.md)
13
+ `vmwareSubscription` | [VMwareSubscriptionInput](VMwareSubscriptionInput.md)
14
+ `vsphereCore` | [VsphereCoreInput](VsphereCoreInput.md)
15
+ `nsx` | [NsxInput](NsxInput.md)
16
+ `ariaOps` | [AriaOpsInput](AriaOpsInput.md)
17
+ `ariaAutomation` | [AriaAutomationInput](AriaAutomationInput.md)
18
+ `ariaSecure` | [AriaSecureInput](AriaSecureInput.md)
19
+ `customerDetails` | [CustomerDetailsInput](CustomerDetailsInput.md)
20
+
21
+ ## Example
22
+
23
+ ```typescript
24
+ import type { EnhancementData } from '@openshift-migration-advisor/planner-sdk'
25
+
26
+ // TODO: Update the object below with actual values
27
+ const example = {
28
+ "deployedEnvironment": null,
29
+ "vmwareVersionCounts": null,
30
+ "activeEnvironments": null,
31
+ "vmwareSubscription": null,
32
+ "vsphereCore": null,
33
+ "nsx": null,
34
+ "ariaOps": null,
35
+ "ariaAutomation": null,
36
+ "ariaSecure": null,
37
+ "customerDetails": null,
38
+ } satisfies EnhancementData
39
+
40
+ console.log(example)
41
+
42
+ // Convert the instance to a JSON string
43
+ const exampleJSON: string = JSON.stringify(example)
44
+ console.log(exampleJSON)
45
+
46
+ // Parse the JSON string back to an object
47
+ const exampleParsed = JSON.parse(exampleJSON) as EnhancementData
48
+ console.log(exampleParsed)
49
+ ```
50
+
51
+ [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
52
+
53
+
package/docs/Host.md CHANGED
@@ -12,6 +12,8 @@ Name | Type
12
12
  `cpuCores` | number
13
13
  `cpuSockets` | number
14
14
  `memoryMB` | number
15
+ `vmotionSupported` | boolean
16
+ `storageVmotionSupported` | boolean
15
17
 
16
18
  ## Example
17
19
 
@@ -26,6 +28,8 @@ const example = {
26
28
  "cpuCores": null,
27
29
  "cpuSockets": null,
28
30
  "memoryMB": null,
31
+ "vmotionSupported": null,
32
+ "storageVmotionSupported": null,
29
33
  } satisfies Host
30
34
 
31
35
  console.log(example)