neuland-hub-sdk 1.0.3

package/docs/Tool.md

@@ -0,0 +1,188 @@
+# Tool
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**toolsCreateTool**](#toolscreatetool) | **POST** /tools/ | Create a tool|
+|[**toolsDeleteTool**](#toolsdeletetool) | **DELETE** /tools/{tool_id} | Delete a tool|
+|[**toolsUpdateTool**](#toolsupdatetool) | **PATCH** /tools/{tool_id} | Update a tool|
+
+# **toolsCreateTool**
+> ToolOut toolsCreateTool(toolCreate)
+
+Create a new tool (superadmin only).
+
+### Example
+
+```typescript
+import {
+    Tool,
+    Configuration,
+    ToolCreate
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Tool(configuration);
+
+let toolCreate: ToolCreate; //
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.toolsCreateTool(
+    toolCreate,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **toolCreate** | **ToolCreate**|  | |
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**ToolOut**
+
+### 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** | Caller is not a superadmin. |  -  |
+|**422** | Invalid payload, an unknown or inactive category public_id, or a tool with the given 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)
+
+# **toolsDeleteTool**
+> toolsDeleteTool()
+
+Delete a tool (superadmin only).
+
+### Example
+
+```typescript
+import {
+    Tool,
+    Configuration
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Tool(configuration);
+
+let toolId: string; //Public id of the tool to delete. (default to undefined)
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.toolsDeleteTool(
+    toolId,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **toolId** | [**string**] | Public id of the tool 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** | Caller is not a superadmin. |  -  |
+|**404** | No tool 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)
+
+# **toolsUpdateTool**
+> ToolOut toolsUpdateTool(toolUpdate)
+
+Update a tool\'s editable fields (superadmin only).
+
+### Example
+
+```typescript
+import {
+    Tool,
+    Configuration,
+    ToolUpdate
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Tool(configuration);
+
+let toolId: string; //Public id of the tool to update. (default to undefined)
+let toolUpdate: ToolUpdate; //
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.toolsUpdateTool(
+    toolId,
+    toolUpdate,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **toolUpdate** | **ToolUpdate**|  | |
+| **toolId** | [**string**] | Public id of the tool to update. | defaults to undefined|
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**ToolOut**
+
+### 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** | Caller is not a superadmin. |  -  |
+|**404** | No tool exists with the given id. |  -  |
+|**422** | Invalid payload, or an unknown or inactive category public_id. |  -  |
+
+[[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/ToolAction.md

@@ -0,0 +1,355 @@
+# ToolAction
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**toolactionsConnectSharedMailbox**](#toolactionsconnectsharedmailbox) | **POST** /tool-actions/email/shared-mailboxes | Connect a shared mailbox|
+|[**toolactionsCreateEmailDraft**](#toolactionscreateemaildraft) | **POST** /tool-actions/email/draft | Create an Outlook mailbox draft from a chat draft|
+|[**toolactionsDisconnectSharedMailbox**](#toolactionsdisconnectsharedmailbox) | **DELETE** /tool-actions/email/shared-mailboxes/{address} | Disconnect a shared mailbox|
+|[**toolactionsListSharedMailboxes**](#toolactionslistsharedmailboxes) | **GET** /tool-actions/email/shared-mailboxes | List connected shared mailboxes|
+|[**toolactionsSearchSharedMailboxes**](#toolactionssearchsharedmailboxes) | **GET** /tool-actions/email/shared-mailboxes/search | Search the directory for mailboxes to connect|
+|[**toolactionsSendEmailFromDraft**](#toolactionssendemailfromdraft) | **POST** /tool-actions/email/send | Send an email from a draft|
+
+# **toolactionsConnectSharedMailbox**
+> SharedMailbox toolactionsConnectSharedMailbox(connectSharedMailboxIn)
+
+Verify the caller can open the mailbox with their own token — or, for a Microsoft 365 group address, that they are a member — then add it to their allowlist. Idempotent: re-connecting updates the display name.
+
+### Example
+
+```typescript
+import {
+    ToolAction,
+    Configuration,
+    ConnectSharedMailboxIn
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ToolAction(configuration);
+
+let connectSharedMailboxIn: ConnectSharedMailboxIn; //
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.toolactionsConnectSharedMailbox(
+    connectSharedMailboxIn,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **connectSharedMailboxIn** | **ConnectSharedMailboxIn**|  | |
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**SharedMailbox**
+
+### 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** | Consent for the shared-mailbox scopes is required (detail.error == \'consent_required\'). |  -  |
+|**403** | Microsoft 365 denied access: the caller has no permission on this mailbox, or it does not exist. |  -  |
+|**422** | Invalid address, or the caller\'s own mailbox. |  -  |
+|**503** | Microsoft Graph is throttling; retry after the Retry-After header. |  -  |
+
+[[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)
+
+# **toolactionsCreateEmailDraft**
+> CreateOutlookDraftResponse toolactionsCreateEmailDraft(createOutlookDraftRequest)
+
+Create (not send) a draft in the user\'s mailbox — used by the draft card\'s \"Open in Outlook\" action, which cannot pass attachments through a compose deep link. Attachment scope rules are identical to sending.
+
+### Example
+
+```typescript
+import {
+    ToolAction,
+    Configuration,
+    CreateOutlookDraftRequest
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ToolAction(configuration);
+
+let createOutlookDraftRequest: CreateOutlookDraftRequest; //
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.toolactionsCreateEmailDraft(
+    createOutlookDraftRequest,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **createOutlookDraftRequest** | **CreateOutlookDraftRequest**|  | |
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**CreateOutlookDraftResponse**
+
+### 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 |  -  |
+|**400** | Invalid attachments/recipients or the mail provider rejected the draft. |  -  |
+|**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)
+
+# **toolactionsDisconnectSharedMailbox**
+> toolactionsDisconnectSharedMailbox()
+
+Remove one shared mailbox from the caller\'s allowlist. The personal consent and any other shared mailboxes are untouched.
+
+### Example
+
+```typescript
+import {
+    ToolAction,
+    Configuration
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ToolAction(configuration);
+
+let address: string; //Address of the connected shared mailbox. (default to undefined)
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.toolactionsDisconnectSharedMailbox(
+    address,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **address** | [**string**] | Address of the connected shared mailbox. | 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 |  -  |
+|**404** | The mailbox is not connected for the caller. |  -  |
+|**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)
+
+# **toolactionsListSharedMailboxes**
+> SharedMailboxListOut toolactionsListSharedMailboxes()
+
+Shared mailboxes the caller connected on top of their personal account.
+
+### Example
+
+```typescript
+import {
+    ToolAction,
+    Configuration
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ToolAction(configuration);
+
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.toolactionsListSharedMailboxes(
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**SharedMailboxListOut**
+
+### 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 |  -  |
+|**404** | The caller has not connected Outlook Mail. |  -  |
+|**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)
+
+# **toolactionsSearchSharedMailboxes**
+> SharedMailboxSearchOut toolactionsSearchSharedMailboxes()
+
+Mailboxes the caller can open, found via the People API.  Graph has no \"shared mailbox\" flag and no list of mailboxes a user has been granted, so candidates come from People (the query, or the caller\'s most relevant contacts for an empty query) and each one is probed with the caller\'s token exactly like connecting does. Regular colleagues fail the probe and drop out; what remains are mailboxes the caller holds Full Access on. Already-connected ones are reported with ``connected``.  Only the already-granted read/people caps are required here, so browsing never trips re-consent — adding a mailbox does that, deliberately.
+
+### Example
+
+```typescript
+import {
+    ToolAction,
+    Configuration
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ToolAction(configuration);
+
+let q: string; //Name or address fragment; empty returns suggestions. (optional) (default to '')
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.toolactionsSearchSharedMailboxes(
+    q,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **q** | [**string**] | Name or address fragment; empty returns suggestions. | (optional) defaults to ''|
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**SharedMailboxSearchOut**
+
+### 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** | Consent for the shared-mailbox scopes is required (detail.error == \'consent_required\'). |  -  |
+|**502** | Microsoft Graph failed. |  -  |
+|**503** | Microsoft Graph is throttling; retry after the Retry-After header. |  -  |
+|**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)
+
+# **toolactionsSendEmailFromDraft**
+> SendEmailResponse toolactionsSendEmailFromDraft(sendEmailRequest)
+
+Send an email from a user-approved, tool-generated draft via Microsoft Graph.
+
+### Example
+
+```typescript
+import {
+    ToolAction,
+    Configuration,
+    SendEmailRequest
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ToolAction(configuration);
+
+let sendEmailRequest: SendEmailRequest; //
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.toolactionsSendEmailFromDraft(
+    sendEmailRequest,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **sendEmailRequest** | **SendEmailRequest**|  | |
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**SendEmailResponse**
+
+### 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 |  -  |
+|**400** | No recipient provided or the mail provider rejected the send. |  -  |
+|**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)
+

package/docs/ToolCallOut.md

@@ -0,0 +1,38 @@
+# ToolCallOut
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | ID of the tool call. | [default to undefined]
+**call_id** | **string** | Provider-assigned identifier for the tool call. | [default to undefined]
+**tool_name** | **string** | Name of the invoked tool. | [default to undefined]
+**call_group** | **number** | Group index for tool calls issued together. | [default to undefined]
+**call_index** | **number** | Order of the call within its group. | [default to undefined]
+**state** | **string** |  | [default to undefined]
+**is_error** | **boolean** |  | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**parent_tool_call_id** | **number** |  | [optional] [default to undefined]
+**progress_steps** | [**Array<ToolCallProgressStepOut>**](ToolCallProgressStepOut.md) | Ordered progress steps emitted during the call. | [default to undefined]
+
+## Example
+
+```typescript
+import { ToolCallOut } from 'neuland-hub-sdk';
+
+const instance: ToolCallOut = {
+    id,
+    call_id,
+    tool_name,
+    call_group,
+    call_index,
+    state,
+    is_error,
+    description,
+    parent_tool_call_id,
+    progress_steps,
+};
+```
+
+[[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/ToolCallProgressStepOut.md

@@ -0,0 +1,24 @@
+# ToolCallProgressStepOut
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Name of the progress step. | [default to undefined]
+**message** | **string** | Human-readable progress message. | [default to undefined]
+**step_index** | **number** | Zero-based order of the step within the tool call. | [default to undefined]
+
+## Example
+
+```typescript
+import { ToolCallProgressStepOut } from 'neuland-hub-sdk';
+
+const instance: ToolCallProgressStepOut = {
+    name,
+    message,
+    step_index,
+};
+```
+
+[[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/ToolCreate.md

@@ -0,0 +1,27 @@
+# ToolCreate
+
+Fields required to create a tool.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** | Human-readable name of the tool. | [default to undefined]
+**description** | **string** | Short description of what the tool does. | [default to undefined]
+**prompt** | **string** |  | [optional] [default to undefined]
+**category_public_id** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ToolCreate } from 'neuland-hub-sdk';
+
+const instance: ToolCreate = {
+    name,
+    description,
+    prompt,
+    category_public_id,
+};
+```
+
+[[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/ToolOut.md

@@ -0,0 +1,35 @@
+# ToolOut
+
+A tool as returned by the API.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **number** | Unique identifier of the tool. | [default to undefined]
+**public_id** | **string** | Public, non-enumerable external identifier of the tool. | [default to undefined]
+**name** | **string** | Human-readable name of the tool. | [default to undefined]
+**description** | **string** |  | [default to undefined]
+**prompt** | **string** |  | [default to undefined]
+**created_at** | **string** | UTC timestamp when the tool was created. | [default to undefined]
+**updated_at** | **string** |  | [default to undefined]
+**category** | [**CategoryOut**](CategoryOut.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ToolOut } from 'neuland-hub-sdk';
+
+const instance: ToolOut = {
+    id,
+    public_id,
+    name,
+    description,
+    prompt,
+    created_at,
+    updated_at,
+    category,
+};
+```
+
+[[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/ToolUpdate.md

@@ -0,0 +1,27 @@
+# ToolUpdate
+
+Editable fields of a tool; only provided fields are updated.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**prompt** | **string** |  | [optional] [default to undefined]
+**category_public_id** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ToolUpdate } from 'neuland-hub-sdk';
+
+const instance: ToolUpdate = {
+    name,
+    description,
+    prompt,
+    category_public_id,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)