@cosmotech/aip-client 0.2.0-dev7 → 0.3.0-dev1

package/docs/BudgetOverviewResponse.md

@@ -0,0 +1,25 @@
+# BudgetOverviewResponse
+
+Schema for the budget overview — aggregated counts and capacity.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**annualBudgetCapacity** | **number** |  | [optional] [default to undefined]
+**numInvestments** | **number** | Number of investments that have at least one option linked to this budget. | [default to undefined]
+**numOptions** | **number** | Number of options linked to this budget. | [default to undefined]
+
+## Example
+
+```typescript
+import { BudgetOverviewResponse } from '@cosmotech/aip-client';
+
+const instance: BudgetOverviewResponse = {
+    annualBudgetCapacity,
+    numInvestments,
+    numOptions,
+};
+```
+
+[[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/BudgetResponse.md

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

@@ -0,0 +1,25 @@
+# BudgetUpdate
+
+Schema for partially updating a Budget. Only provided fields will be updated.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**annualBudgetCapacity** | **number** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**name** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BudgetUpdate } from '@cosmotech/aip-client';
+
+const instance: BudgetUpdate = {
+    annualBudgetCapacity,
+    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/docs/OptionCreate.md

@@ -6,6 +6,7 @@ Schema for creating a new Option (excludes auto-generated fields)
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**budgetId** | **string** |  | [optional] [default to undefined]
 **cost** | **number** | Cost of the option | [optional] [default to 0.0]
 **description** | **string** |  | [optional] [default to undefined]
 **duration** | **number** | Duration of the option in weeks | [optional] [default to 1]
@@ -18,6 +19,7 @@ Name | Type | Description | Notes
 import { OptionCreate } from '@cosmotech/aip-client';
 
 const instance: OptionCreate = {
+    budgetId,
     cost,
     description,
     duration,

package/docs/OptionOverviewResponse.md

@@ -6,6 +6,7 @@ Schema for the option overview table — one row per option within an investment
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**budgetName** | **string** |  | [optional] [default to undefined]
 **cost** | **number** | Cost of the option | [default to undefined]
 **duration** | **number** | Duration of the option in weeks | [default to undefined]
 **npv** | **number** |  | [optional] [default to undefined]
@@ -19,6 +20,7 @@ Name | Type | Description | Notes
 import { OptionOverviewResponse } from '@cosmotech/aip-client';
 
 const instance: OptionOverviewResponse = {
+    budgetName,
     cost,
     duration,
     npv,

package/docs/OptionResponse.md

@@ -6,6 +6,7 @@ Schema for Option responses (includes all fields)
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**budgetId** | **string** |  | [optional] [default to undefined]
 **cost** | **number** |  | [default to undefined]
 **createdAt** | **string** |  | [default to undefined]
 **description** | **string** |  | [optional] [default to undefined]
@@ -23,6 +24,7 @@ Name | Type | Description | Notes
 import { OptionResponse } from '@cosmotech/aip-client';
 
 const instance: OptionResponse = {
+    budgetId,
     cost,
     createdAt,
     description,

package/docs/OptionUpdate.md

@@ -6,6 +6,7 @@ Schema for partially updating an Option. Only provided fields will be updated.
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**budgetId** | **string** |  | [optional] [default to undefined]
 **cost** | **number** |  | [optional] [default to undefined]
 **description** | **string** |  | [optional] [default to undefined]
 **duration** | **number** |  | [optional] [default to undefined]
@@ -18,6 +19,7 @@ Name | Type | Description | Notes
 import { OptionUpdate } from '@cosmotech/aip-client';
 
 const instance: OptionUpdate = {
+    budgetId,
     cost,
     description,
     duration,

package/index.ts

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

package/models/budget-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.3.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 budgets.
+ */
+export interface BudgetBulkDeleteRequest {
+    /**
+     * List of budget IDs to delete
+     */
+    'budget_ids': Array<string>;
+}
+

package/models/budget-create.ts

@@ -0,0 +1,28 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.3.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 Budget (excludes auto-generated fields)
+ */
+export interface BudgetCreate {
+    'annual_budget_capacity'?: number | null;
+    'description'?: string | null;
+    /**
+     * Name of the budget
+     */
+    'name': string;
+}
+

package/models/budget-investment-response.ts

@@ -0,0 +1,40 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.3.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 one row in the \'Investments with options using budget\' tab.
+ */
+export interface BudgetInvestmentResponse {
+    'cost'?: number | null;
+    'duration'?: number | null;
+    'investment_description'?: string | null;
+    /**
+     * ID of the investment
+     */
+    'investment_id': string;
+    /**
+     * Name of the investment
+     */
+    'investment_name': string;
+    'npv'?: number | null;
+    /**
+     * True if the preferred option is the one linked to this budget. False triggers a warning: preferred option is NOT the budget-linked one.
+     */
+    'preferred_option_linked_to_budget': boolean;
+    'preferred_option_name'?: string | null;
+    'start_date'?: string | null;
+}
+

package/models/budget-link-options-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.3.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-linking options to a budget.
+ */
+export interface BudgetLinkOptionsRequest {
+    /**
+     * List of option IDs to link to this budget
+     */
+    'option_ids': Array<string>;
+}
+

package/models/budget-option-response.ts

@@ -0,0 +1,56 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.3.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 one row in the \'Options using budget\' tab on the budget detail page.
+ */
+export interface BudgetOptionResponse {
+    /**
+     * Total investment cost of the option
+     */
+    'cost': number;
+    /**
+     * Total duration of the option in weeks
+     */
+    'duration': number;
+    /**
+     * ID of the parent investment
+     */
+    'investment_id': string;
+    /**
+     * Name of the parent investment
+     */
+    'investment_name': string;
+    /**
+     * True if this option is the preferred option of its investment
+     */
+    'is_preferred': boolean;
+    'npv'?: number | null;
+    'option_description'?: string | null;
+    /**
+     * ID of the option
+     */
+    'option_id': string;
+    /**
+     * Name of the option
+     */
+    'option_name': string;
+    /**
+     * Expected start date of the option (ISO 8601)
+     */
+    'start_date': string;
+}
+

package/models/budget-overview-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.3.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 the budget overview — aggregated counts and capacity.
+ */
+export interface BudgetOverviewResponse {
+    'annual_budget_capacity'?: number | null;
+    /**
+     * Number of investments that have at least one option linked to this budget.
+     */
+    'num_investments': number;
+    /**
+     * Number of options linked to this budget.
+     */
+    'num_options': number;
+}
+

package/models/budget-response.ts

@@ -0,0 +1,32 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.3.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 Budget responses (includes all fields)
+ */
+export interface BudgetResponse {
+    'annual_budget_capacity'?: number | null;
+    'created_at': string;
+    'description'?: string | null;
+    'id': string;
+    /**
+     * Name of the budget
+     */
+    'name': string;
+    'owner_name'?: string | null;
+    'updated_at': string;
+}
+

package/models/budget-update.ts

@@ -0,0 +1,25 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Asset Investment Planning
+ * API for Asset Investment Planning
+ *
+ * The version of the OpenAPI document: 0.3.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 Budget. Only provided fields will be updated.
+ */
+export interface BudgetUpdate {
+    'annual_budget_capacity'?: number | null;
+    'description'?: string | null;
+    'name'?: string | null;
+}
+

package/models/evolution-type.ts

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

package/models/index.ts

@@ -1,3 +1,11 @@
+export * from './budget-bulk-delete-request';
+export * from './budget-create';
+export * from './budget-investment-response';
+export * from './budget-link-options-request';
+export * from './budget-option-response';
+export * from './budget-overview-response';
+export * from './budget-response';
+export * from './budget-update';
 export * from './evolution-type';
 export * from './httpvalidation-error';
 export * from './impact-apiresponse';

package/models/investment-create.ts

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