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

package/models/portfolio-budget-expenditure-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-dev1
+ * 
+ *
+ * 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 { PortfolioBudgetExpenditureYear } from './portfolio-budget-expenditure-year';
+
+/**
+ * Response for the budget expenditure over time endpoint.
+ */
+export interface PortfolioBudgetExpenditureResponse {
+    'budget_id': string;
+    'budget_name': string;
+    'expenditure': Array<PortfolioBudgetExpenditureYear>;
+    'max_capacity'?: number | null;
+}
+

package/models/portfolio-budget-expenditure-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-dev1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Expenditure amount for one year.
+ */
+export interface PortfolioBudgetExpenditureYear {
+    'amount': number;
+    'year': number;
+}
+

package/models/portfolio-budget-usage-item.ts

@@ -0,0 +1,34 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.4.0-dev1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * One row in the portfolio Budget Usage table.
+ */
+export interface PortfolioBudgetUsageItem {
+    'budget_id': string;
+    'budget_name': string;
+    'first_overrun_year'?: number | null;
+    /**
+     * Number of preferred options in the portfolio linked to this budget
+     */
+    'nb_options': number;
+    'nb_overruns': number;
+    /**
+     * \'Within\' or \'Exceeded\'
+     */
+    'status': string;
+}
+

package/models/portfolio-bulk-delete-request.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-dev1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Request body for bulk-deleting portfolios by their IDs.
+ */
+export interface PortfolioBulkDeleteRequest {
+    /**
+     * List of portfolio IDs to delete (must be non-empty)
+     */
+    'ids': Array<string>;
+}
+

package/models/portfolio-create.ts

@@ -0,0 +1,27 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.4.0-dev1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Schema for creating a new Portfolio (excludes auto-generated fields)
+ */
+export interface PortfolioCreate {
+    'description'?: string | null;
+    /**
+     * Name of the portfolio
+     */
+    'name': string;
+}
+

package/models/portfolio-investment-bulk-add-request.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-dev1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Request body for adding multiple investments to a portfolio at once.
+ */
+export interface PortfolioInvestmentBulkAddRequest {
+    /**
+     * List of investment IDs to add (must be non-empty)
+     */
+    'investment_ids': Array<string>;
+}
+

package/models/portfolio-investment-bulk-add-response.ts

@@ -0,0 +1,30 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.4.0-dev1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Response for bulk-add investments: reports added vs already-present links.
+ */
+export interface PortfolioInvestmentBulkAddResponse {
+    /**
+     * Investment IDs that were newly linked to the portfolio
+     */
+    'added': Array<string>;
+    /**
+     * Investment IDs that were already in the portfolio (skipped)
+     */
+    'already_present': Array<string>;
+}
+

package/models/portfolio-investment-bulk-delete-request.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-dev1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Request body for removing multiple investments from a portfolio at once.
+ */
+export interface PortfolioInvestmentBulkDeleteRequest {
+    /**
+     * List of investment IDs to remove (must be non-empty)
+     */
+    'ids': Array<string>;
+}
+

package/models/portfolio-investment-response.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.4.0-dev1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Schema for PortfolioInvestment responses
+ */
+export interface PortfolioInvestmentResponse {
+    /**
+     * ID of the investment
+     */
+    'investment_id': string;
+    'owner_name'?: string | null;
+    /**
+     * ID of the portfolio
+     */
+    'portfolio_id': string;
+}
+

package/models/portfolio-kpidistribution-budget-item.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-dev1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Per-budget overrun flag for one year (True = budget exceeded, False = within capacity).
+ */
+export interface PortfolioKPIDistributionBudgetItem {
+    'budget_id': string;
+    'budget_name': string;
+    'overrun': boolean;
+}
+

package/models/portfolio-kpidistribution-response.ts

@@ -0,0 +1,28 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.4.0-dev1
+ * 
+ *
+ * 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 { PortfolioKPIDistributionYearValue } from './portfolio-kpidistribution-year-value';
+
+/**
+ * Response for the KPI distribution endpoint (investments / capex / npv).
+ */
+export interface PortfolioKPIDistributionResponse {
+    'data': Array<PortfolioKPIDistributionYearValue>;
+    'kpi': string;
+    'unit'?: string | null;
+}
+

package/models/portfolio-kpidistribution-year-overrun.ts

@@ -0,0 +1,27 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.4.0-dev1
+ * 
+ *
+ * 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 { PortfolioKPIDistributionBudgetItem } from './portfolio-kpidistribution-budget-item';
+
+/**
+ * Year + per-budget breakdown for the budget_overrun distribution.
+ */
+export interface PortfolioKPIDistributionYearOverrun {
+    'budgets': Array<PortfolioKPIDistributionBudgetItem>;
+    'year': number;
+}
+

package/models/portfolio-kpidistribution-year-value.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-dev1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Year + scalar value for investments / capex / npv distributions.
+ */
+export interface PortfolioKPIDistributionYearValue {
+    'value': number;
+    'year': number;
+}
+

package/models/portfolio-kpioverrun-distribution-response.ts

@@ -0,0 +1,27 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.4.0-dev1
+ * 
+ *
+ * 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 { PortfolioKPIDistributionYearOverrun } from './portfolio-kpidistribution-year-overrun';
+
+/**
+ * Response for the budget_overrun KPI distribution endpoint.
+ */
+export interface PortfolioKPIOverrunDistributionResponse {
+    'data': Array<PortfolioKPIDistributionYearOverrun>;
+    'kpi': string;
+}
+

package/models/portfolio-kpiresponse.ts

@@ -0,0 +1,37 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.4.0-dev1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Computed KPI values for one portfolio (framework-independent fields only when no VF given).
+ */
+export interface PortfolioKPIResponse {
+    /**
+     * Count of budget-overrun years across all budgets in this portfolio
+     */
+    'budget_overrun': number;
+    'earliest_start_date'?: string | null;
+    'latest_start_date'?: string | null;
+    /**
+     * Number of investments in the portfolio
+     */
+    'nb_investments': number;
+    'npv'?: number | null;
+    /**
+     * Sum of preferred options\' costs (CAPEX)
+     */
+    'total_cost': number;
+}
+

package/models/portfolio-overview-item-response.ts

@@ -0,0 +1,46 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.4.0-dev1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * One row in the portfolio listing overview — base fields plus computed KPIs.
+ */
+export interface PortfolioOverviewItemResponse {
+    /**
+     * Count of budget-overrun years across all budgets in this portfolio
+     */
+    'budget_overrun': number;
+    'created_at': string;
+    'description'?: string | null;
+    'earliest_start_date'?: string | null;
+    'id': string;
+    'latest_start_date'?: string | null;
+    /**
+     * Name of the portfolio
+     */
+    'name': string;
+    /**
+     * Number of investments in the portfolio
+     */
+    'nb_investments': number;
+    'npv'?: number | null;
+    'owner_name'?: string | null;
+    /**
+     * Sum of preferred options\' costs (CAPEX)
+     */
+    'total_cost': number;
+    'updated_at': string;
+}
+

package/models/portfolio-response.ts

@@ -0,0 +1,31 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.4.0-dev1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Schema for Portfolio responses (includes all fields)
+ */
+export interface PortfolioResponse {
+    'created_at': string;
+    'description'?: string | null;
+    'id': string;
+    /**
+     * Name of the portfolio
+     */
+    'name': string;
+    'owner_name'?: string | null;
+    'updated_at': string;
+}
+

package/models/portfolio-update.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-dev1
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * Schema for partially updating a Portfolio. Only provided fields will be updated.
+ */
+export interface PortfolioUpdate {
+    'description'?: string | null;
+    'name'?: string | null;
+}
+

package/models/preferred-option-request.ts

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

package/models/preferred-option-response.ts

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

package/models/validation-error.ts

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

package/models/value-framework-create.ts

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

package/models/value-framework-response.ts

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

package/models/value-framework-update.ts

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cosmotech/aip-client",
-  "version": "0.3.0-dev2",
+  "version": "0.4.0-dev1",
   "description": "OpenAPI client for @cosmotech/aip-client",
   "author": "OpenAPI-Generator Contributors",
   "repository": {