@cosmotech/aip-client 0.4.0-dev5 → 1.0.0-dev1

package/docs/PrioritizationOverviewResponse.md

@@ -0,0 +1,57 @@
+# PrioritizationOverviewResponse
+
+Aggregate run-vs-portfolio comparison KPIs displayed on the scenario \"Overview\" tab.  Each metric is exposed as three values: the value computed on the full portfolio (before the run), the value computed on the performed investments only (in the run), and the delta (performed - portfolio; positive = gain).
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**deltaMetricValue** | **number** | performed - portfolio | [default to undefined]
+**deltaNbInvestments** | **number** | performed - portfolio | [default to undefined]
+**deltaNpv** | **number** | performed - portfolio | [default to undefined]
+**deltaTotalCost** | **number** | performed - portfolio | [default to undefined]
+**metricId** | **string** |  | [default to undefined]
+**metricName** | **string** |  | [optional] [default to undefined]
+**metricUnit** | **string** |  | [optional] [default to undefined]
+**metricValuePerformed** | **number** | Quantity of the prioritization metric across performed investments | [default to undefined]
+**metricValuePortfolio** | **number** | Quantity of the prioritization metric across the portfolio | [default to undefined]
+**nbInvestmentsPerformed** | **number** | Number of performed investments in the run | [default to undefined]
+**nbInvestmentsPortfolio** | **number** | Total number of investments in the portfolio | [default to undefined]
+**npvPerformed** | **number** | Total expected NPV of performed investments for the scenario VF | [default to undefined]
+**npvPortfolio** | **number** | Total expected NPV of the portfolio for the scenario VF | [default to undefined]
+**portfolioId** | **string** |  | [default to undefined]
+**scenarioId** | **string** |  | [default to undefined]
+**totalCostPerformed** | **number** | Total CAPEX of all performed investments in the run | [default to undefined]
+**totalCostPortfolio** | **number** | Total CAPEX of all investments in the portfolio | [default to undefined]
+**valueFrameworkId** | **string** |  | [default to undefined]
+**valueFrameworkName** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PrioritizationOverviewResponse } from '@cosmotech/aip-client';
+
+const instance: PrioritizationOverviewResponse = {
+    deltaMetricValue,
+    deltaNbInvestments,
+    deltaNpv,
+    deltaTotalCost,
+    metricId,
+    metricName,
+    metricUnit,
+    metricValuePerformed,
+    metricValuePortfolio,
+    nbInvestmentsPerformed,
+    nbInvestmentsPortfolio,
+    npvPerformed,
+    npvPortfolio,
+    portfolioId,
+    scenarioId,
+    totalCostPerformed,
+    totalCostPortfolio,
+    valueFrameworkId,
+    valueFrameworkName,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PrioritizationResultResponse.md

@@ -0,0 +1,39 @@
+# PrioritizationResultResponse
+
+Schema for PrioritizationResult responses
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**budgetId** | **string** |  | [optional] [default to undefined]
+**cost** | **number** | CAPEX of the preferred option at time of run | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**cumulativeImpact** | **number** | Cumulative metric impact used for ranking | [default to undefined]
+**id** | **string** |  | [default to undefined]
+**investmentId** | **string** | ID of the investment | [default to undefined]
+**performed** | **boolean** | Whether the investment was performed (budget allowed) | [default to undefined]
+**rank** | **number** | Priority rank (1 = highest priority) | [default to undefined]
+**scenarioId** | **string** | ID of the prioritization scenario | [default to undefined]
+**year** | **number** | Start year of the investment\'s preferred option | [default to undefined]
+
+## Example
+
+```typescript
+import { PrioritizationResultResponse } from '@cosmotech/aip-client';
+
+const instance: PrioritizationResultResponse = {
+    budgetId,
+    cost,
+    createdAt,
+    cumulativeImpact,
+    id,
+    investmentId,
+    performed,
+    rank,
+    scenarioId,
+    year,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PrioritizationResultsResponse.md

@@ -0,0 +1,23 @@
+# PrioritizationResultsResponse
+
+Wrapper response for the list of prioritization results.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**results** | [**Array<PrioritizationResultResponse>**](PrioritizationResultResponse.md) |  | [default to undefined]
+**scenarioId** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PrioritizationResultsResponse } from '@cosmotech/aip-client';
+
+const instance: PrioritizationResultsResponse = {
+    results,
+    scenarioId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PrioritizationScenarioResponse.md

@@ -0,0 +1,43 @@
+# PrioritizationScenarioResponse
+
+Schema for PrioritizationScenario responses
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdAt** | **string** |  | [default to undefined]
+**id** | **string** |  | [default to undefined]
+**lastRunAt** | **string** |  | [optional] [default to undefined]
+**lastRunConfigMatches** | **boolean** |  | [default to undefined]
+**metricId** | **string** | ID of the metric used to rank investments | [default to undefined]
+**metricName** | **string** |  | [optional] [default to undefined]
+**ownerName** | **string** |  | [optional] [default to undefined]
+**portfolioId** | **string** | ID of the portfolio | [default to undefined]
+**status** | [**ScenarioStatus**](ScenarioStatus.md) |  | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+**valueFrameworkId** | **string** | ID of the value framework used for prioritization | [default to undefined]
+**valueFrameworkName** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PrioritizationScenarioResponse } from '@cosmotech/aip-client';
+
+const instance: PrioritizationScenarioResponse = {
+    createdAt,
+    id,
+    lastRunAt,
+    lastRunConfigMatches,
+    metricId,
+    metricName,
+    ownerName,
+    portfolioId,
+    status,
+    updatedAt,
+    valueFrameworkId,
+    valueFrameworkName,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PrioritizationScenarioRunRequest.md

@@ -0,0 +1,23 @@
+# PrioritizationScenarioRunRequest
+
+Request body for creating/updating and running a prioritization scenario.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**metricId** | **string** | ID of the metric to prioritize on | [default to undefined]
+**valueFrameworkId** | **string** | ID of the value framework to use | [default to undefined]
+
+## Example
+
+```typescript
+import { PrioritizationScenarioRunRequest } from '@cosmotech/aip-client';
+
+const instance: PrioritizationScenarioRunRequest = {
+    metricId,
+    valueFrameworkId,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/PrioritizationScenarioStatusResponse.md

@@ -0,0 +1,25 @@
+# PrioritizationScenarioStatusResponse
+
+Lightweight status response for polling.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**lastRunAt** | **string** |  | [optional] [default to undefined]
+**lastRunConfigMatches** | **boolean** |  | [default to undefined]
+**status** | [**ScenarioStatus**](ScenarioStatus.md) |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PrioritizationScenarioStatusResponse } from '@cosmotech/aip-client';
+
+const instance: PrioritizationScenarioStatusResponse = {
+    lastRunAt,
+    lastRunConfigMatches,
+    status,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/ScenarioStatus.md

@@ -0,0 +1,16 @@
+# ScenarioStatus
+
+
+## Enum
+
+* `NOT_RUN` (value: `'not_run'`)
+
+* `RUNNING` (value: `'running'`)
+
+* `COMPLETED` (value: `'completed'`)
+
+* `FAILED` (value: `'failed'`)
+
+* `ABORTED` (value: `'aborted'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/index.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/budget-bulk-delete-request.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/budget-create.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/budget-investment-response.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/budget-link-options-request.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/budget-option-response.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/budget-overview-response.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/budget-response.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/budget-update.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/bulk-delete-request.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/evolution-type.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/httpvalidation-error.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/impact-apiresponse.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/impact-bulk-item.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/impact-create.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/impact-update.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/index.ts

@@ -66,6 +66,13 @@ export * from './portfolio-response';
 export * from './portfolio-update';
 export * from './preferred-option-request';
 export * from './preferred-option-response';
+export * from './prioritization-overview-response';
+export * from './prioritization-result-response';
+export * from './prioritization-results-response';
+export * from './prioritization-scenario-response';
+export * from './prioritization-scenario-run-request';
+export * from './prioritization-scenario-status-response';
+export * from './scenario-status';
 export * from './validation-error';
 export * from './value-framework-create';
 export * from './value-framework-response';

package/models/investment-create.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/investment-overview-response.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/investment-response.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/investment-update.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/location-inner.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/measurement-type.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/metric-costs-per-year-create.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/metric-costs-per-year-response.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/metric-costs-per-year-update.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/metric-create.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/metric-performance-response.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/metric-performance-year.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/metric-response.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/metric-type.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/metric-update.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/monetized-impact-detailed-response.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/monetized-impact-detailed-year.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/monetized-impact-metric-value.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -20,6 +20,7 @@
 export interface MonetizedImpactMetricValue {
     'metric_id': string;
     'metric_name': string;
+    'metric_value': number;
     'monetary_value': number;
 }
 

package/models/monetized-impact-response.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/monetized-impact-year.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/objective-create.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/objective-response.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.4.0-dev5
+ * The version of the OpenAPI document: 1.0.0-dev1
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).