@komputer-ai/sdk 0.11.1 → 0.11.2

package/docs/AgentsApi.md

@@ -1,584 +0,0 @@
-# AgentsApi
-
-All URIs are relative to *http://localhost:8080/api/v1*
-
-| Method | HTTP request | Description |
-|------------- | ------------- | -------------|
-| [**agentsNameWsGet**](AgentsApi.md#agentsnamewsget) | **GET** /agents/{name}/ws | Stream agent events (WebSocket) |
-| [**cancelAgentTask**](AgentsApi.md#cancelagenttask) | **POST** /agents/{name}/cancel | Cancel agent task |
-| [**createAgent**](AgentsApi.md#createagentoperation) | **POST** /agents | Create agent or send task |
-| [**deleteAgent**](AgentsApi.md#deleteagent) | **DELETE** /agents/{name} | Delete agent |
-| [**getAgent**](AgentsApi.md#getagent) | **GET** /agents/{name} | Get agent details |
-| [**getAgentEvents**](AgentsApi.md#getagentevents) | **GET** /agents/{name}/events | Get agent events |
-| [**listAgents**](AgentsApi.md#listagents) | **GET** /agents | List agents |
-| [**patchAgent**](AgentsApi.md#patchagentoperation) | **PATCH** /agents/{name} | Patch agent |
-
-
-
-## agentsNameWsGet
-
-> agentsNameWsGet(name)
-
-Stream agent events (WebSocket)
-
-Upgrades to a WebSocket connection to stream real-time agent events. Events include task_started, thinking, tool_call, tool_result, text, task_completed, task_cancelled, and error.
-
-### Example
-
-```ts
-import {
-  Configuration,
-  AgentsApi,
-} from 'komputer-ai';
-import type { AgentsNameWsGetRequest } from 'komputer-ai';
-
-async function example() {
-  console.log("🚀 Testing komputer-ai SDK...");
-  const api = new AgentsApi();
-
-  const body = {
-    // string | Agent name
-    name: name_example,
-  } satisfies AgentsNameWsGetRequest;
-
-  try {
-    const data = await api.agentsNameWsGet(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **name** | `string` | Agent name | [Defaults to `undefined`] |
-
-### Return type
-
-`void` (Empty response body)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: Not defined
-
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## cancelAgentTask
-
-> { [key: string]: string; } cancelAgentTask(name, namespace)
-
-Cancel agent task
-
-Gracefully cancels the currently running task. The agent pod stays alive for future tasks.
-
-### Example
-
-```ts
-import {
-  Configuration,
-  AgentsApi,
-} from 'komputer-ai';
-import type { CancelAgentTaskRequest } from 'komputer-ai';
-
-async function example() {
-  console.log("🚀 Testing komputer-ai SDK...");
-  const api = new AgentsApi();
-
-  const body = {
-    // string | Agent name
-    name: name_example,
-    // string | Kubernetes namespace (optional)
-    namespace: namespace_example,
-  } satisfies CancelAgentTaskRequest;
-
-  try {
-    const data = await api.cancelAgentTask(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **name** | `string` | Agent name | [Defaults to `undefined`] |
-| **namespace** | `string` | Kubernetes namespace | [Optional] [Defaults to `undefined`] |
-
-### Return type
-
-**{ [key: string]: string; }**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: `application/json`
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | Task cancelling |  -  |
-| **404** | Agent not found |  -  |
-| **409** | Agent has no running pod |  -  |
-| **500** | Internal error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## createAgent
-
-> AgentResponse createAgent(request)
-
-Create agent or send task
-
-Creates a new agent or sends a task to an existing idle agent (upsert by name). If the agent doesn\'t exist, it is created. If it exists and is idle, the task is forwarded.
-
-### Example
-
-```ts
-import {
-  Configuration,
-  AgentsApi,
-} from 'komputer-ai';
-import type { CreateAgentOperationRequest } from 'komputer-ai';
-
-async function example() {
-  console.log("🚀 Testing komputer-ai SDK...");
-  const api = new AgentsApi();
-
-  const body = {
-    // CreateAgentRequest | Agent creation request
-    request: ...,
-  } satisfies CreateAgentOperationRequest;
-
-  try {
-    const data = await api.createAgent(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **request** | [CreateAgentRequest](CreateAgentRequest.md) | Agent creation request | |
-
-### Return type
-
-[**AgentResponse**](AgentResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: `application/json`
-- **Accept**: `application/json`
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | Task forwarded to existing agent |  -  |
-| **201** | Agent created |  -  |
-| **400** | Bad request |  -  |
-| **409** | Agent is busy or has no running pod |  -  |
-| **500** | Internal error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## deleteAgent
-
-> { [key: string]: string; } deleteAgent(name, namespace)
-
-Delete agent
-
-Deletes the agent CR, pod, PVC, secrets, and Redis event stream.
-
-### Example
-
-```ts
-import {
-  Configuration,
-  AgentsApi,
-} from 'komputer-ai';
-import type { DeleteAgentRequest } from 'komputer-ai';
-
-async function example() {
-  console.log("🚀 Testing komputer-ai SDK...");
-  const api = new AgentsApi();
-
-  const body = {
-    // string | Agent name
-    name: name_example,
-    // string | Kubernetes namespace (optional)
-    namespace: namespace_example,
-  } satisfies DeleteAgentRequest;
-
-  try {
-    const data = await api.deleteAgent(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **name** | `string` | Agent name | [Defaults to `undefined`] |
-| **namespace** | `string` | Kubernetes namespace | [Optional] [Defaults to `undefined`] |
-
-### Return type
-
-**{ [key: string]: string; }**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: `application/json`
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | Agent deleted |  -  |
-| **404** | Agent not found |  -  |
-| **500** | Internal error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## getAgent
-
-> AgentResponse getAgent(name, namespace)
-
-Get agent details
-
-Returns the current status and metadata for a single agent.
-
-### Example
-
-```ts
-import {
-  Configuration,
-  AgentsApi,
-} from 'komputer-ai';
-import type { GetAgentRequest } from 'komputer-ai';
-
-async function example() {
-  console.log("🚀 Testing komputer-ai SDK...");
-  const api = new AgentsApi();
-
-  const body = {
-    // string | Agent name
-    name: name_example,
-    // string | Kubernetes namespace (optional)
-    namespace: namespace_example,
-  } satisfies GetAgentRequest;
-
-  try {
-    const data = await api.getAgent(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **name** | `string` | Agent name | [Defaults to `undefined`] |
-| **namespace** | `string` | Kubernetes namespace | [Optional] [Defaults to `undefined`] |
-
-### Return type
-
-[**AgentResponse**](AgentResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: `application/json`
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | Agent details |  -  |
-| **404** | Agent not found |  -  |
-| **500** | Internal error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## getAgentEvents
-
-> { [key: string]: any; } getAgentEvents(name, namespace, limit)
-
-Get agent events
-
-Returns recent events from the agent\'s Redis stream in chronological order.
-
-### Example
-
-```ts
-import {
-  Configuration,
-  AgentsApi,
-} from 'komputer-ai';
-import type { GetAgentEventsRequest } from 'komputer-ai';
-
-async function example() {
-  console.log("🚀 Testing komputer-ai SDK...");
-  const api = new AgentsApi();
-
-  const body = {
-    // string | Agent name
-    name: name_example,
-    // string | Kubernetes namespace (optional)
-    namespace: namespace_example,
-    // number | Max events to return (1-200) (optional)
-    limit: 56,
-  } satisfies GetAgentEventsRequest;
-
-  try {
-    const data = await api.getAgentEvents(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **name** | `string` | Agent name | [Defaults to `undefined`] |
-| **namespace** | `string` | Kubernetes namespace | [Optional] [Defaults to `undefined`] |
-| **limit** | `number` | Max events to return (1-200) | [Optional] [Defaults to `50`] |
-
-### Return type
-
-**{ [key: string]: any; }**
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: `application/json`
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | Agent events |  -  |
-| **400** | Invalid limit parameter |  -  |
-| **500** | Internal error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## listAgents
-
-> AgentListResponse listAgents(namespace)
-
-List agents
-
-Returns all agents with their current status in the specified namespace.
-
-### Example
-
-```ts
-import {
-  Configuration,
-  AgentsApi,
-} from 'komputer-ai';
-import type { ListAgentsRequest } from 'komputer-ai';
-
-async function example() {
-  console.log("🚀 Testing komputer-ai SDK...");
-  const api = new AgentsApi();
-
-  const body = {
-    // string | Kubernetes namespace (optional)
-    namespace: namespace_example,
-  } satisfies ListAgentsRequest;
-
-  try {
-    const data = await api.listAgents(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **namespace** | `string` | Kubernetes namespace | [Optional] [Defaults to `undefined`] |
-
-### Return type
-
-[**AgentListResponse**](AgentListResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: `application/json`
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | List of agents |  -  |
-| **500** | Internal error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-
-## patchAgent
-
-> AgentResponse patchAgent(name, request, namespace)
-
-Patch agent
-
-Updates model, lifecycle, instructions, secretRefs, memories, skills, or connectors on an existing agent.
-
-### Example
-
-```ts
-import {
-  Configuration,
-  AgentsApi,
-} from 'komputer-ai';
-import type { PatchAgentOperationRequest } from 'komputer-ai';
-
-async function example() {
-  console.log("🚀 Testing komputer-ai SDK...");
-  const api = new AgentsApi();
-
-  const body = {
-    // string | Agent name
-    name: name_example,
-    // PatchAgentRequest | Fields to update
-    request: ...,
-    // string | Kubernetes namespace (optional)
-    namespace: namespace_example,
-  } satisfies PatchAgentOperationRequest;
-
-  try {
-    const data = await api.patchAgent(body);
-    console.log(data);
-  } catch (error) {
-    console.error(error);
-  }
-}
-
-// Run the test
-example().catch(console.error);
-```
-
-### Parameters
-
-
-| Name | Type | Description  | Notes |
-|------------- | ------------- | ------------- | -------------|
-| **name** | `string` | Agent name | [Defaults to `undefined`] |
-| **request** | [PatchAgentRequest](PatchAgentRequest.md) | Fields to update | |
-| **namespace** | `string` | Kubernetes namespace | [Optional] [Defaults to `undefined`] |
-
-### Return type
-
-[**AgentResponse**](AgentResponse.md)
-
-### Authorization
-
-No authorization required
-
-### HTTP request headers
-
-- **Content-Type**: `application/json`
-- **Accept**: `application/json`
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-| **200** | Updated agent |  -  |
-| **400** | Bad request |  -  |
-| **500** | Internal error |  -  |
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-

package/docs/ConnectorResponse.md

@@ -1,58 +0,0 @@
-
-# ConnectorResponse
-
-
-## Properties
-
-Name | Type
------------- | -------------
-`agentNames` | Array<string>
-`attachedAgents` | number
-`authSecretKey` | string
-`authSecretName` | string
-`authType` | string
-`createdAt` | string
-`displayName` | string
-`name` | string
-`namespace` | string
-`oauthStatus` | string
-`service` | string
-`type` | string
-`url` | string
-
-## Example
-
-```typescript
-import type { ConnectorResponse } from 'komputer-ai'
-
-// TODO: Update the object below with actual values
-const example = {
-  "agentNames": null,
-  "attachedAgents": null,
-  "authSecretKey": null,
-  "authSecretName": null,
-  "authType": null,
-  "createdAt": null,
-  "displayName": null,
-  "name": null,
-  "namespace": null,
-  "oauthStatus": null,
-  "service": null,
-  "type": null,
-  "url": null,
-} satisfies ConnectorResponse
-
-console.log(example)
-
-// Convert the instance to a JSON string
-const exampleJSON: string = JSON.stringify(example)
-console.log(exampleJSON)
-
-// Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as ConnectorResponse
-console.log(exampleParsed)
-```
-
-[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
-
-