@cosmotech/aip-client 0.3.0-dev3 → 0.4.0-dev2

package/docs/PortfolioOverviewItemResponse.md

@@ -0,0 +1,43 @@
+# PortfolioOverviewItemResponse
+
+One row in the portfolio listing overview — base fields plus computed KPIs.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**budgetOverrun** | **number** | Count of budget-overrun years across all budgets in this portfolio | [default to undefined]
+**createdAt** | **string** |  | [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**earliestStartDate** | **string** |  | [optional] [default to undefined]
+**id** | **string** |  | [default to undefined]
+**latestStartDate** | **string** |  | [optional] [default to undefined]
+**name** | **string** | Name of the portfolio | [default to undefined]
+**nbInvestments** | **number** | Number of investments in the portfolio | [default to undefined]
+**npv** | **number** |  | [optional] [default to undefined]
+**ownerName** | **string** |  | [optional] [default to undefined]
+**totalCost** | **number** | Sum of preferred options\' costs (CAPEX) | [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PortfolioOverviewItemResponse } from '@cosmotech/aip-client';
+
+const instance: PortfolioOverviewItemResponse = {
+    budgetOverrun,
+    createdAt,
+    description,
+    earliestStartDate,
+    id,
+    latestStartDate,
+    name,
+    nbInvestments,
+    npv,
+    ownerName,
+    totalCost,
+    updatedAt,
+};
+```
+
+[[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/PortfolioResponse.md

@@ -0,0 +1,31 @@
+# PortfolioResponse
+
+Schema for Portfolio responses (includes all fields)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**createdAt** | **string** |  | [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**id** | **string** |  | [default to undefined]
+**name** | **string** | Name of the portfolio | [default to undefined]
+**ownerName** | **string** |  | [optional] [default to undefined]
+**updatedAt** | **string** |  | [default to undefined]
+
+## Example
+
+```typescript
+import { PortfolioResponse } from '@cosmotech/aip-client';
+
+const instance: PortfolioResponse = {
+    createdAt,
+    description,
+    id,
+    name,
+    ownerName,
+    updatedAt,
+};
+```
+
+[[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/PortfolioUpdate.md

@@ -0,0 +1,23 @@
+# PortfolioUpdate
+
+Schema for partially updating a Portfolio. Only provided fields will be updated.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**description** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { PortfolioUpdate } from '@cosmotech/aip-client';
+
+const instance: PortfolioUpdate = {
+    description,
+    name,
+};
+```
+
+[[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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -19,8 +19,8 @@
  */
 export interface BudgetBulkDeleteRequest {
     /**
-     * List of budget IDs to delete
+     * List of budget IDs to delete (must be non-empty)
      */
-    'budget_ids': Array<string>;
+    'ids': Array<string>;
 }
 

package/models/budget-create.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -30,7 +30,6 @@ export interface ImpactAPIResponse {
      * ID of the associated metric
      */
     'metric_id': string;
-    'name': string;
     /**
      * ID of the associated option
      */

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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -37,10 +37,6 @@ export interface ImpactBulkItem {
      * ID of the associated metric
      */
     'metric_id': string;
-    /**
-     * Name of the impact
-     */
-    'name': string;
 }
 
 

package/models/impact-create.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -37,10 +37,6 @@ export interface ImpactCreate {
      * ID of the associated metric
      */
     'metric_id': string;
-    /**
-     * Name of the impact
-     */
-    'name': string;
 }
 
 

package/models/impact-update.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -25,7 +25,6 @@ export interface ImpactUpdate {
     'evolution_rate'?: number | null;
     'evolution_type'?: EvolutionType | null;
     'metric_id'?: string | null;
-    'name'?: string | null;
 }
 
 

package/models/index.ts

@@ -23,9 +23,13 @@ export * from './metric-costs-per-year-create';
 export * from './metric-costs-per-year-response';
 export * from './metric-costs-per-year-update';
 export * from './metric-create';
+export * from './metric-performance-response';
+export * from './metric-performance-year';
 export * from './metric-response';
 export * from './metric-type';
 export * from './metric-update';
+export * from './monetized-impact-response';
+export * from './monetized-impact-year';
 export * from './objective-create';
 export * from './objective-response';
 export * from './objective-update';
@@ -38,6 +42,24 @@ export * from './option-create';
 export * from './option-overview-response';
 export * from './option-response';
 export * from './option-update';
+export * from './portfolio-budget-expenditure-response';
+export * from './portfolio-budget-expenditure-year';
+export * from './portfolio-budget-usage-item';
+export * from './portfolio-bulk-delete-request';
+export * from './portfolio-create';
+export * from './portfolio-investment-bulk-add-request';
+export * from './portfolio-investment-bulk-add-response';
+export * from './portfolio-investment-bulk-delete-request';
+export * from './portfolio-investment-response';
+export * from './portfolio-kpidistribution-budget-item';
+export * from './portfolio-kpidistribution-response';
+export * from './portfolio-kpidistribution-year-overrun';
+export * from './portfolio-kpidistribution-year-value';
+export * from './portfolio-kpioverrun-distribution-response';
+export * from './portfolio-kpiresponse';
+export * from './portfolio-overview-item-response';
+export * from './portfolio-response';
+export * from './portfolio-update';
 export * from './preferred-option-request';
 export * from './preferred-option-response';
 export * from './validation-error';

package/models/investment-create.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/metric-performance-response.ts

@@ -0,0 +1,29 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.4.0-dev2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { MetricPerformanceYear } from './metric-performance-year';
+
+/**
+ * Response for the portfolio metric performance over time endpoint.
+ */
+export interface MetricPerformanceResponse {
+    'data': Array<MetricPerformanceYear>;
+    'metric_id': string;
+    'metric_name': string;
+    'unit': string;
+}
+

package/models/metric-performance-year.ts

@@ -0,0 +1,24 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.4.0-dev2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Metric value for one calendar year.
+ */
+export interface MetricPerformanceYear {
+    'value': number;
+    'year': number;
+}
+

package/models/metric-response.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/monetized-impact-response.ts

@@ -0,0 +1,26 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.4.0-dev2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { MonetizedImpactYear } from './monetized-impact-year';
+
+/**
+ * Response for the portfolio monetized impact endpoint.
+ */
+export interface MonetizedImpactResponse {
+    'data': Array<MonetizedImpactYear>;
+}
+

package/models/monetized-impact-year.ts

@@ -0,0 +1,25 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.4.0-dev2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Monetized impact (benefit) and investment cost for one year.
+ */
+export interface MonetizedImpactYear {
+    'investment_cost': number;
+    'monetized_impact': number;
+    'year': number;
+}
+

package/models/objective-create.ts

@@ -4,7 +4,7 @@
  * Asset Investment Planning
  * API for Asset Investment Planning
  *
- * The version of the OpenAPI document: 0.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * 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.3.0-dev3
+ * The version of the OpenAPI document: 0.4.0-dev2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/models/objective-update.ts

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

package/models/objective-weight-create.ts

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

package/models/objective-weight-response.ts

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

package/models/objective-weight-update.ts

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