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

package/docs/BudgetApi.md

@@ -0,0 +1,559 @@
+# BudgetApi
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**bulkDeleteBudgets**](#bulkdeletebudgets) | **DELETE** /budget/bulk | Bulk delete budgets|
+|[**deleteBudget**](#deletebudget) | **DELETE** /budget/{budget_id} | Delete a budget|
+|[**getBudgetById**](#getbudgetbyid) | **GET** /budget/{budget_id} | Get a budget by ID|
+|[**getBudgetInvestments**](#getbudgetinvestments) | **GET** /budget/{budget_id}/investments | List investments linked to this budget via options|
+|[**getBudgetOptions**](#getbudgetoptions) | **GET** /budget/{budget_id}/options | List options linked to this budget|
+|[**getBudgetOverview**](#getbudgetoverview) | **GET** /budget/{budget_id}/overview | Get budget overview|
+|[**getBudgets**](#getbudgets) | **GET** /budget/ | List all budgets|
+|[**linkOptionsToBudget**](#linkoptionstobudget) | **POST** /budget/{budget_id}/link-options | Bulk-link options to this budget|
+|[**patchBudget**](#patchbudget) | **PATCH** /budget/{budget_id} | Partially update a budget|
+|[**postBudget**](#postbudget) | **POST** /budget/ | Create a budget|
+
+# **bulkDeleteBudgets**
+> bulkDeleteBudgets(budgetBulkDeleteRequest)
+
+Delete multiple budgets at once. Options linked to deleted budgets will have their budget link removed (set to null).
+
+### Example
+
+```typescript
+import {
+    BudgetApi,
+    Configuration,
+    BudgetBulkDeleteRequest
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new BudgetApi(configuration);
+
+let budgetBulkDeleteRequest: BudgetBulkDeleteRequest; //
+
+const { status, data } = await apiInstance.bulkDeleteBudgets(
+    budgetBulkDeleteRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **budgetBulkDeleteRequest** | **BudgetBulkDeleteRequest**|  | |
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Budgets successfully deleted |  -  |
+|**400** | Invalid request body |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **deleteBudget**
+> deleteBudget()
+
+Delete an existing budget by its ID. Options linked to this budget will have their budget link removed (set to null).
+
+### Example
+
+```typescript
+import {
+    BudgetApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new BudgetApi(configuration);
+
+let budgetId: string; //UUID of the budget (default to undefined)
+
+const { status, data } = await apiInstance.deleteBudget(
+    budgetId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **budgetId** | [**string**] | UUID of the budget | defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Budget successfully deleted |  -  |
+|**404** | Budget not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getBudgetById**
+> BudgetResponse getBudgetById()
+
+Retrieve a single budget by its ID.
+
+### Example
+
+```typescript
+import {
+    BudgetApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new BudgetApi(configuration);
+
+let budgetId: string; //UUID of the budget (default to undefined)
+
+const { status, data } = await apiInstance.getBudgetById(
+    budgetId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **budgetId** | [**string**] | UUID of the budget | defaults to undefined|
+
+
+### Return type
+
+**BudgetResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | The requested budget |  -  |
+|**404** | Budget not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getBudgetInvestments**
+> Array<BudgetInvestmentResponse> getBudgetInvestments()
+
+Return all distinct investments that have at least one option linked to this budget. Each row shows the investment\'s current preferred option data and a flag indicating whether the preferred option is the one linked to the budget. NPV is computed for the preferred option from the v_option_npv view.
+
+### Example
+
+```typescript
+import {
+    BudgetApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new BudgetApi(configuration);
+
+let budgetId: string; //UUID of the budget (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+
+const { status, data } = await apiInstance.getBudgetInvestments(
+    budgetId,
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **budgetId** | [**string**] | UUID of the budget | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**Array<BudgetInvestmentResponse>**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Investments linked to this budget |  -  |
+|**404** | Budget or value framework not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getBudgetOptions**
+> Array<BudgetOptionResponse> getBudgetOptions()
+
+Return all options linked to this budget. Rows are ordered by investment name then option name. NPV is computed from the v_option_npv view for the given value framework.
+
+### Example
+
+```typescript
+import {
+    BudgetApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new BudgetApi(configuration);
+
+let budgetId: string; //UUID of the budget (default to undefined)
+let valueFrameworkId: string; //UUID of the value framework (default to undefined)
+
+const { status, data } = await apiInstance.getBudgetOptions(
+    budgetId,
+    valueFrameworkId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **budgetId** | [**string**] | UUID of the budget | defaults to undefined|
+| **valueFrameworkId** | [**string**] | UUID of the value framework | defaults to undefined|
+
+
+### Return type
+
+**Array<BudgetOptionResponse>**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Options linked to this budget |  -  |
+|**404** | Budget or value framework not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getBudgetOverview**
+> BudgetOverviewResponse getBudgetOverview()
+
+Return aggregated overview data for a budget: annual capacity, number of options linked to it, and number of distinct investments that have at least one option linked to it.
+
+### Example
+
+```typescript
+import {
+    BudgetApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new BudgetApi(configuration);
+
+let budgetId: string; //UUID of the budget (default to undefined)
+
+const { status, data } = await apiInstance.getBudgetOverview(
+    budgetId
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **budgetId** | [**string**] | UUID of the budget | defaults to undefined|
+
+
+### Return type
+
+**BudgetOverviewResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Budget overview |  -  |
+|**404** | Budget not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **getBudgets**
+> Array<BudgetResponse> getBudgets()
+
+Retrieve a paginated list of all budgets, ordered by name.
+
+### Example
+
+```typescript
+import {
+    BudgetApi,
+    Configuration
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new BudgetApi(configuration);
+
+let offset: number; //Number of records to skip (optional) (default to 0)
+let limit: number; //Max number of records to return (optional) (default to 100)
+
+const { status, data } = await apiInstance.getBudgets(
+    offset,
+    limit
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **offset** | [**number**] | Number of records to skip | (optional) defaults to 0|
+| **limit** | [**number**] | Max number of records to return | (optional) defaults to 100|
+
+
+### Return type
+
+**Array<BudgetResponse>**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | List of budgets |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **linkOptionsToBudget**
+> Array<string> linkOptionsToBudget(budgetLinkOptionsRequest)
+
+Link all specified options to this budget. Any previous budget assignment on these options is overwritten. Returns the list of option IDs that were successfully linked.
+
+### Example
+
+```typescript
+import {
+    BudgetApi,
+    Configuration,
+    BudgetLinkOptionsRequest
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new BudgetApi(configuration);
+
+let budgetId: string; //UUID of the budget (default to undefined)
+let budgetLinkOptionsRequest: BudgetLinkOptionsRequest; //
+
+const { status, data } = await apiInstance.linkOptionsToBudget(
+    budgetId,
+    budgetLinkOptionsRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **budgetLinkOptionsRequest** | **BudgetLinkOptionsRequest**|  | |
+| **budgetId** | [**string**] | UUID of the budget | defaults to undefined|
+
+
+### Return type
+
+**Array<string>**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Options linked successfully — returns list of linked option IDs |  -  |
+|**400** | One or more option IDs not found |  -  |
+|**404** | Budget not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **patchBudget**
+> BudgetResponse patchBudget(budgetUpdate)
+
+Update one or more fields of an existing budget. Only the fields included in the request body will be modified; omitted fields remain unchanged.
+
+### Example
+
+```typescript
+import {
+    BudgetApi,
+    Configuration,
+    BudgetUpdate
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new BudgetApi(configuration);
+
+let budgetId: string; //UUID of the budget (default to undefined)
+let budgetUpdate: BudgetUpdate; //
+
+const { status, data } = await apiInstance.patchBudget(
+    budgetId,
+    budgetUpdate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **budgetUpdate** | **BudgetUpdate**|  | |
+| **budgetId** | [**string**] | UUID of the budget | defaults to undefined|
+
+
+### Return type
+
+**BudgetResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Budget updated successfully |  -  |
+|**400** | Validation or constraint error |  -  |
+|**404** | Budget not found |  -  |
+|**409** | A budget with this name already exists |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **postBudget**
+> BudgetResponse postBudget(budgetCreate)
+
+Create a new budget.
+
+### Example
+
+```typescript
+import {
+    BudgetApi,
+    Configuration,
+    BudgetCreate
+} from '@cosmotech/aip-client';
+
+const configuration = new Configuration();
+const apiInstance = new BudgetApi(configuration);
+
+let budgetCreate: BudgetCreate; //
+
+const { status, data } = await apiInstance.postBudget(
+    budgetCreate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **budgetCreate** | **BudgetCreate**|  | |
+
+
+### Return type
+
+**BudgetResponse**
+
+### Authorization
+
+[OAuth2AuthorizationCodeBearer](../README.md#OAuth2AuthorizationCodeBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Budget created successfully |  -  |
+|**400** | Invalid input or constraint violation |  -  |
+|**409** | A budget with this name already exists |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/BudgetBulkDeleteRequest.md

@@ -0,0 +1,21 @@
+# BudgetBulkDeleteRequest
+
+Request body for bulk-deleting budgets.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**budgetIds** | **Array<string>** | List of budget IDs to delete | [default to undefined]
+
+## Example
+
+```typescript
+import { BudgetBulkDeleteRequest } from '@cosmotech/aip-client';
+
+const instance: BudgetBulkDeleteRequest = {
+    budgetIds,
+};
+```
+
+[[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/BudgetCreate.md

@@ -0,0 +1,25 @@
+# BudgetCreate
+
+Schema for creating a new Budget (excludes auto-generated fields)
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**annualBudgetCapacity** | **number** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**name** | **string** | Name of the budget | [default to undefined]
+
+## Example
+
+```typescript
+import { BudgetCreate } from '@cosmotech/aip-client';
+
+const instance: BudgetCreate = {
+    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/BudgetInvestmentResponse.md

@@ -0,0 +1,37 @@
+# BudgetInvestmentResponse
+
+Schema for one row in the \'Investments with options using budget\' tab.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cost** | **number** |  | [optional] [default to undefined]
+**duration** | **number** |  | [optional] [default to undefined]
+**investmentDescription** | **string** |  | [optional] [default to undefined]
+**investmentId** | **string** | ID of the investment | [default to undefined]
+**investmentName** | **string** | Name of the investment | [default to undefined]
+**npv** | **number** |  | [optional] [default to undefined]
+**preferredOptionLinkedToBudget** | **boolean** | True if the preferred option is the one linked to this budget. False triggers a warning: preferred option is NOT the budget-linked one. | [default to undefined]
+**preferredOptionName** | **string** |  | [optional] [default to undefined]
+**startDate** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { BudgetInvestmentResponse } from '@cosmotech/aip-client';
+
+const instance: BudgetInvestmentResponse = {
+    cost,
+    duration,
+    investmentDescription,
+    investmentId,
+    investmentName,
+    npv,
+    preferredOptionLinkedToBudget,
+    preferredOptionName,
+    startDate,
+};
+```
+
+[[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/BudgetLinkOptionsRequest.md

@@ -0,0 +1,21 @@
+# BudgetLinkOptionsRequest
+
+Request body for bulk-linking options to a budget.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**optionIds** | **Array<string>** | List of option IDs to link to this budget | [default to undefined]
+
+## Example
+
+```typescript
+import { BudgetLinkOptionsRequest } from '@cosmotech/aip-client';
+
+const instance: BudgetLinkOptionsRequest = {
+    optionIds,
+};
+```
+
+[[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/BudgetOptionResponse.md

@@ -0,0 +1,39 @@
+# BudgetOptionResponse
+
+Schema for one row in the \'Options using budget\' tab on the budget detail page.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cost** | **number** | Total investment cost of the option | [default to undefined]
+**duration** | **number** | Total duration of the option in weeks | [default to undefined]
+**investmentId** | **string** | ID of the parent investment | [default to undefined]
+**investmentName** | **string** | Name of the parent investment | [default to undefined]
+**isPreferred** | **boolean** | True if this option is the preferred option of its investment | [default to undefined]
+**npv** | **number** |  | [optional] [default to undefined]
+**optionDescription** | **string** |  | [optional] [default to undefined]
+**optionId** | **string** | ID of the option | [default to undefined]
+**optionName** | **string** | Name of the option | [default to undefined]
+**startDate** | **string** | Expected start date of the option (ISO 8601) | [default to undefined]
+
+## Example
+
+```typescript
+import { BudgetOptionResponse } from '@cosmotech/aip-client';
+
+const instance: BudgetOptionResponse = {
+    cost,
+    duration,
+    investmentId,
+    investmentName,
+    isPreferred,
+    npv,
+    optionDescription,
+    optionId,
+    optionName,
+    startDate,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)