neuland-hub-sdk 1.0.3

package/docs/Alert.md

@@ -0,0 +1,416 @@
+# Alert
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**alertsBudgetForecast**](#alertsbudgetforecast) | **GET** /alerts/budgets/forecast | Forecast the tenant\'s month-end spend from its current run rate|
+|[**alertsBudgetSummary**](#alertsbudgetsummary) | **GET** /alerts/budgets/summary | Get the tenant\'s current-month budget summary|
+|[**alertsCancelTopUp**](#alertscanceltopup) | **POST** /alerts/budgets/top-ups/{top_up_id}/cancel | Cancel a budget top-up|
+|[**alertsCreateAlert**](#alertscreatealert) | **POST** /alerts/ | Create a budget alert|
+|[**alertsCreateTopUp**](#alertscreatetopup) | **POST** /alerts/budgets/top-ups | Add a budget top-up for the current month|
+|[**alertsDeleteAlert**](#alertsdeletealert) | **DELETE** /alerts/{alert_id} | Delete a budget alert|
+|[**alertsUpdateAlert**](#alertsupdatealert) | **PATCH** /alerts/{alert_id} | Update a budget alert|
+
+# **alertsBudgetForecast**
+> BudgetForecast alertsBudgetForecast()
+
+Return a run-rate projection of month-end spend (plus the summary it builds on).
+
+### Example
+
+```typescript
+import {
+    Alert,
+    Configuration
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Alert(configuration);
+
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.alertsBudgetForecast(
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**BudgetForecast**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**401** | Missing or invalid authentication. |  -  |
+|**403** | Admin privileges required. |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **alertsBudgetSummary**
+> BudgetSummary alertsBudgetSummary()
+
+Return current-month spend vs the tenant\'s monthly pool budget.  Replaces the three PostgREST reads the dashboard stitches client-side (tenants → tenant_tarifs → usage_costs) with a single server-computed cap.
+
+### Example
+
+```typescript
+import {
+    Alert,
+    Configuration
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Alert(configuration);
+
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.alertsBudgetSummary(
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**BudgetSummary**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**401** | Missing or invalid authentication. |  -  |
+|**403** | Admin privileges required. |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **alertsCancelTopUp**
+> BudgetTopUpOut alertsCancelTopUp()
+
+Stop a top-up adding headroom, keeping what it has already covered.
+
+### Example
+
+```typescript
+import {
+    Alert,
+    Configuration
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Alert(configuration);
+
+let topUpId: string; //Public id of the budget top-up to cancel. (default to undefined)
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.alertsCancelTopUp(
+    topUpId,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **topUpId** | [**string**] | Public id of the budget top-up to cancel. | defaults to undefined|
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**BudgetTopUpOut**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**401** | Missing or invalid authentication. |  -  |
+|**403** | Admin privileges required, or the top-up belongs to another tenant. |  -  |
+|**404** | No budget top-up exists with the given id. |  -  |
+|**422** | The top-up is already cancelled. |  -  |
+
+[[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)
+
+# **alertsCreateAlert**
+> BudgetAlert alertsCreateAlert(budgetAlertRequest)
+
+Create a new budget alert with threshold and current spend.
+
+### Example
+
+```typescript
+import {
+    Alert,
+    Configuration,
+    BudgetAlertRequest
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Alert(configuration);
+
+let budgetAlertRequest: BudgetAlertRequest; //
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.alertsCreateAlert(
+    budgetAlertRequest,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **budgetAlertRequest** | **BudgetAlertRequest**|  | |
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**BudgetAlert**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Successful Response |  -  |
+|**401** | Missing or invalid authentication. |  -  |
+|**403** | Admin privileges required. |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **alertsCreateTopUp**
+> BudgetTopUpOut alertsCreateTopUp(budgetTopUpRequest)
+
+Raise the tenant\'s pool budget for the current calendar month.
+
+### Example
+
+```typescript
+import {
+    Alert,
+    Configuration,
+    BudgetTopUpRequest
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Alert(configuration);
+
+let budgetTopUpRequest: BudgetTopUpRequest; //
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.alertsCreateTopUp(
+    budgetTopUpRequest,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **budgetTopUpRequest** | **BudgetTopUpRequest**|  | |
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**BudgetTopUpOut**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Successful Response |  -  |
+|**401** | Missing or invalid authentication. |  -  |
+|**403** | Admin privileges required. |  -  |
+|**422** | The tenant\'s plan has no monthly pool to raise. |  -  |
+
+[[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)
+
+# **alertsDeleteAlert**
+> alertsDeleteAlert()
+
+Delete an existing budget alert.
+
+### Example
+
+```typescript
+import {
+    Alert,
+    Configuration
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Alert(configuration);
+
+let alertId: string; //Public id of the budget alert to delete. (default to undefined)
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.alertsDeleteAlert(
+    alertId,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **alertId** | [**string**] | Public id of the budget alert to delete. | defaults to undefined|
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Successful Response |  -  |
+|**401** | Missing or invalid authentication. |  -  |
+|**403** | Admin privileges required. |  -  |
+|**404** | No budget alert exists with the given id. |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **alertsUpdateAlert**
+> BudgetAlert alertsUpdateAlert(budgetAlertUpdate)
+
+Update an existing budget alert.
+
+### Example
+
+```typescript
+import {
+    Alert,
+    Configuration,
+    BudgetAlertUpdate
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Alert(configuration);
+
+let alertId: string; //Public id of the budget alert to update. (default to undefined)
+let budgetAlertUpdate: BudgetAlertUpdate; //
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.alertsUpdateAlert(
+    alertId,
+    budgetAlertUpdate,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **budgetAlertUpdate** | **BudgetAlertUpdate**|  | |
+| **alertId** | [**string**] | Public id of the budget alert to update. | defaults to undefined|
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**BudgetAlert**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**401** | Missing or invalid authentication. |  -  |
+|**403** | Admin privileges required. |  -  |
+|**404** | No budget alert exists with the given id. |  -  |
+|**422** | Validation Error |  -  |
+
+[[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/ApiKey.md

@@ -0,0 +1,123 @@
+# ApiKey
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**apiCreateKey**](#apicreatekey) | **POST** /api/key/ | Create an API key|
+|[**apiRevokeApiKey**](#apirevokeapikey) | **PATCH** /api/key/revoke/{api_key_id} | Revoke an API key|
+
+# **apiCreateKey**
+> ApiKeyCreateResponse apiCreateKey()
+
+Create an API key for the current user; the secret is returned only once.
+
+### Example
+
+```typescript
+import {
+    ApiKey,
+    Configuration,
+    ApiKeyCreateRequest
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ApiKey(configuration);
+
+let cookieName: string; // (optional) (default to undefined)
+let apiKeyCreateRequest: ApiKeyCreateRequest; // (optional)
+
+const { status, data } = await apiInstance.apiCreateKey(
+    cookieName,
+    apiKeyCreateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **apiKeyCreateRequest** | **ApiKeyCreateRequest**|  | |
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**ApiKeyCreateResponse**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Successful Response |  -  |
+|**401** | Missing or invalid authentication. |  -  |
+|**422** | Validation Error |  -  |
+
+[[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)
+
+# **apiRevokeApiKey**
+> apiRevokeApiKey()
+
+Deactivate an API key so it can no longer authenticate requests.  Revoking your own key needs no permission: withdrawing a credential is never an escalation, and gating it would strand keys whose holder just lost the permission that minted them. Revoking someone else\'s key needs MANAGE_API_KEYS in that key\'s tenant (an Operator, any key) — the path an admin uses to clean up keys left by members. A caller allowed neither gets the same 404 as an unknown id, so the endpoint cannot confirm which key ids exist. Only a browser session may revoke, never an API key.
+
+### Example
+
+```typescript
+import {
+    ApiKey,
+    Configuration
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ApiKey(configuration);
+
+let apiKeyId: string; //Public id of the API key to revoke. (default to undefined)
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.apiRevokeApiKey(
+    apiKeyId,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **apiKeyId** | [**string**] | Public id of the API key to revoke. | defaults to undefined|
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**204** | Successful Response |  -  |
+|**401** | Missing or invalid authentication. |  -  |
+|**404** | No API key exists with the given id. |  -  |
+|**422** | Validation Error |  -  |
+
+[[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/ApiKeyCreateRequest.md

@@ -0,0 +1,23 @@
+# ApiKeyCreateRequest
+
+Payload for creating an API key. All fields are optional.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ApiKeyCreateRequest } from 'neuland-hub-sdk';
+
+const instance: ApiKeyCreateRequest = {
+    name,
+    description,
+};
+```
+
+[[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/ApiKeyCreateResponse.md

@@ -0,0 +1,27 @@
+# ApiKeyCreateResponse
+
+Returned once when an API key is created.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** | The full secret token, in the form `ak.<key_id>.<secret>`. **Shown only once at creation** — store it securely; it cannot be retrieved again. | [default to undefined]
+**key_id** | **string** | Public identifier of the key. Safe to log and reference. | [default to undefined]
+**public_id** | **string** | Public, non-enumerable id of the key. Use it to revoke the key via PATCH /api/key/revoke/{public_id}. | [default to undefined]
+**expires_at** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ApiKeyCreateResponse } from 'neuland-hub-sdk';
+
+const instance: ApiKeyCreateResponse = {
+    key,
+    key_id,
+    public_id,
+    expires_at,
+};
+```
+
+[[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/ApiKeyInventoryRequest.md

@@ -0,0 +1,21 @@
+# ApiKeyInventoryRequest
+
+Request for the API key inventory.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active_only** | **boolean** | Return only keys that are currently active. | [optional] [default to false]
+
+## Example
+
+```typescript
+import { ApiKeyInventoryRequest } from 'neuland-hub-sdk';
+
+const instance: ApiKeyInventoryRequest = {
+    active_only,
+};
+```
+
+[[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/ApiKeyInventoryResponse.md

@@ -0,0 +1,22 @@
+# ApiKeyInventoryResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rows** | [**Array<ApiKeyInventoryRow>**](ApiKeyInventoryRow.md) | One entry per key. | [default to undefined]
+**truncated** | **boolean** | True when more keys matched than were returned. | [optional] [default to false]
+
+## Example
+
+```typescript
+import { ApiKeyInventoryResponse } from 'neuland-hub-sdk';
+
+const instance: ApiKeyInventoryResponse = {
+    rows,
+    truncated,
+};
+```
+
+[[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/ApiKeyInventoryRow.md

@@ -0,0 +1,36 @@
+# ApiKeyInventoryRow
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**public_id** | **string** | Public key identifier; the value /llm/usage filters on. | [default to undefined]
+**name** | **string** |  | [default to undefined]
+**active** | **boolean** | Whether the key is currently active. | [default to undefined]
+**created_at** | **string** | When the key was created. | [default to undefined]
+**expires_at** | **string** |  | [default to undefined]
+**last_used_at** | **string** |  | [default to undefined]
+**days_idle** | **number** |  | [default to undefined]
+**idle** | **boolean** | True when unused for more than 30 days. | [default to undefined]
+**expiring_soon** | **boolean** | True when the key expires within 30 days. | [default to undefined]
+
+## Example
+
+```typescript
+import { ApiKeyInventoryRow } from 'neuland-hub-sdk';
+
+const instance: ApiKeyInventoryRow = {
+    public_id,
+    name,
+    active,
+    created_at,
+    expires_at,
+    last_used_at,
+    days_idle,
+    idle,
+    expiring_soon,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)