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

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)