fulcrum-cem-client 0.0.2 → 0.0.4

package/docs/AgentsApi.md

@@ -0,0 +1,922 @@
+# AgentsApi
+
+All URIs are relative to *https://api.fulcrum.testudosrl.dev/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**agentTypesCreate**](AgentsApi.md#agenttypescreate) | **POST** /agent-types | Create an agent type |
+| [**agentTypesDelete**](AgentsApi.md#agenttypesdelete) | **DELETE** /agent-types/{id} | Delete an agent type |
+| [**agentTypesGet**](AgentsApi.md#agenttypesget) | **GET** /agent-types/{id} | Get an agent type |
+| [**agentTypesList**](AgentsApi.md#agenttypeslist) | **GET** /agent-types | List agent types |
+| [**agentTypesUpdate**](AgentsApi.md#agenttypesupdate) | **PATCH** /agent-types/{id} | Update an agent type |
+| [**agentsCreate**](AgentsApi.md#agentscreate) | **POST** /agents | Create an agent |
+| [**agentsDelete**](AgentsApi.md#agentsdelete) | **DELETE** /agents/{id} | Delete an agent |
+| [**agentsGet**](AgentsApi.md#agentsget) | **GET** /agents/{id} | Get an agent |
+| [**agentsGetCurrent**](AgentsApi.md#agentsgetcurrent) | **GET** /agents/me | Get current agent |
+| [**agentsList**](AgentsApi.md#agentslist) | **GET** /agents | List agents |
+| [**agentsUpdate**](AgentsApi.md#agentsupdate) | **PATCH** /agents/{id} | Update an agent |
+| [**agentsUpdateStatus**](AgentsApi.md#agentsupdatestatusoperation) | **PUT** /agents/me/status | Update agent status |
+
+
+
+## agentTypesCreate
+
+> AgentTypeRes agentTypesCreate(createAgentTypeReq)
+
+Create an agent type
+
+Creates a new agent type with optional service types
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgentsApi,
+} from 'fulcrum-cem-client';
+import type { AgentTypesCreateRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new AgentsApi(config);
+
+  const body = {
+    // CreateAgentTypeReq
+    createAgentTypeReq: ...,
+  } satisfies AgentTypesCreateRequest;
+
+  try {
+    const data = await api.agentTypesCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createAgentTypeReq** | [CreateAgentTypeReq](CreateAgentTypeReq.md) |  | |
+
+### Return type
+
+[**AgentTypeRes**](AgentTypeRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Agent type created successfully |  -  |
+| **400** | Invalid request body or validation error |  -  |
+| **401** | Authentication required |  -  |
+| **403** | Administrator access required |  -  |
+| **409** | Agent type with same name already exists |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## agentTypesDelete
+
+> agentTypesDelete(id)
+
+Delete an agent type
+
+Deletes an agent type if no agents depend on it
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgentsApi,
+} from 'fulcrum-cem-client';
+import type { AgentTypesDeleteRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new AgentsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies AgentTypesDeleteRequest;
+
+  try {
+    const data = await api.agentTypesDelete(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Agent type deleted successfully |  -  |
+| **401** | Authentication required |  -  |
+| **403** | Administrator access required |  -  |
+| **404** | Agent type not found |  -  |
+| **409** | Cannot delete agent type with dependent agents |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## agentTypesGet
+
+> AgentTypeRes agentTypesGet(id)
+
+Get an agent type
+
+Retrieves a specific agent type by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgentsApi,
+} from 'fulcrum-cem-client';
+import type { AgentTypesGetRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new AgentsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies AgentTypesGetRequest;
+
+  try {
+    const data = await api.agentTypesGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**AgentTypeRes**](AgentTypeRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | The agent type details |  -  |
+| **404** | Agent type not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## agentTypesList
+
+> AgentTypesList200Response agentTypesList(page, pageSize, sort, name)
+
+List agent types
+
+Retrieves a paginated list of agent types
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgentsApi,
+} from 'fulcrum-cem-client';
+import type { AgentTypesListRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new AgentsApi(config);
+
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+    // string | Sort field. Prefix with \'+\' for ascending or \'-\' for descending. Default is ascending. Supported fields: name (optional)
+    sort: +name,
+    // Array<string> | Filter by agent type name (can specify multiple values) (optional)
+    name: ...,
+  } satisfies AgentTypesListRequest;
+
+  try {
+    const data = await api.agentTypesList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
+| **sort** | `string` | Sort field. Prefix with \&#39;+\&#39; for ascending or \&#39;-\&#39; for descending. Default is ascending. Supported fields: name | [Optional] [Defaults to `undefined`] |
+| **name** | `Array<string>` | Filter by agent type name (can specify multiple values) | [Optional] |
+
+### Return type
+
+[**AgentTypesList200Response**](AgentTypesList200Response.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | A paginated list of agent types |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## agentTypesUpdate
+
+> AgentTypeRes agentTypesUpdate(id, updateAgentTypeReq)
+
+Update an agent type
+
+Partially updates an agent type (PATCH semantics)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgentsApi,
+} from 'fulcrum-cem-client';
+import type { AgentTypesUpdateRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new AgentsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateAgentTypeReq
+    updateAgentTypeReq: ...,
+  } satisfies AgentTypesUpdateRequest;
+
+  try {
+    const data = await api.agentTypesUpdate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+| **updateAgentTypeReq** | [UpdateAgentTypeReq](UpdateAgentTypeReq.md) |  | |
+
+### Return type
+
+[**AgentTypeRes**](AgentTypeRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Agent type updated successfully |  -  |
+| **400** | Invalid request body or validation error |  -  |
+| **401** | Authentication required |  -  |
+| **403** | Administrator access required |  -  |
+| **404** | Agent type not found |  -  |
+| **409** | Agent type with same name already exists |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## agentsCreate
+
+> AgentCreateRes agentsCreate(createAgentReq)
+
+Create an agent
+
+Creates a new agent and returns the agent data with an authentication token
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgentsApi,
+} from 'fulcrum-cem-client';
+import type { AgentsCreateRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new AgentsApi(config);
+
+  const body = {
+    // CreateAgentReq
+    createAgentReq: ...,
+  } satisfies AgentsCreateRequest;
+
+  try {
+    const data = await api.agentsCreate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createAgentReq** | [CreateAgentReq](CreateAgentReq.md) |  | |
+
+### Return type
+
+[**AgentCreateRes**](AgentCreateRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Agent created successfully |  -  |
+| **400** | Invalid request |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## agentsDelete
+
+> agentsDelete(id)
+
+Delete an agent
+
+Deletes an agent by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgentsApi,
+} from 'fulcrum-cem-client';
+import type { AgentsDeleteRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new AgentsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies AgentsDeleteRequest;
+
+  try {
+    const data = await api.agentsDelete(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **204** | Agent deleted successfully |  -  |
+| **404** | Agent not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## agentsGet
+
+> AgentRes agentsGet(id)
+
+Get an agent
+
+Retrieves a specific agent by ID
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgentsApi,
+} from 'fulcrum-cem-client';
+import type { AgentsGetRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new AgentsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies AgentsGetRequest;
+
+  try {
+    const data = await api.agentsGet(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**AgentRes**](AgentRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | The agent details |  -  |
+| **404** | Agent not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## agentsGetCurrent
+
+> AgentRes agentsGetCurrent()
+
+Get current agent
+
+Retrieves information about the currently authenticated agent
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgentsApi,
+} from 'fulcrum-cem-client';
+import type { AgentsGetCurrentRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new AgentsApi(config);
+
+  try {
+    const data = await api.agentsGetCurrent();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**AgentRes**](AgentRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | The agent details |  -  |
+| **401** | Unauthorized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## agentsList
+
+> AgentsList200Response agentsList(page, pageSize, sort, name, status, providerId, agentTypeId)
+
+List agents
+
+Retrieves a paginated list of agents
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgentsApi,
+} from 'fulcrum-cem-client';
+import type { AgentsListRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new AgentsApi(config);
+
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+    // string | Sort field. Prefix with \'+\' for ascending or \'-\' for descending. Default is ascending. Supported fields: name (optional)
+    sort: +name,
+    // Array<string> | Filter by agent name (can specify multiple values) (optional)
+    name: ...,
+    // Array<'New' | 'Connected' | 'Disconnected' | 'Error' | 'Disabled'> | Filter by agent status (can specify multiple values) (optional)
+    status: ...,
+    // Array<string> | Filter by provider ID (can specify multiple values) (optional)
+    providerId: ...,
+    // Array<string> | Filter by agent type ID (can specify multiple values) (optional)
+    agentTypeId: ...,
+  } satisfies AgentsListRequest;
+
+  try {
+    const data = await api.agentsList(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
+| **sort** | `string` | Sort field. Prefix with \&#39;+\&#39; for ascending or \&#39;-\&#39; for descending. Default is ascending. Supported fields: name | [Optional] [Defaults to `undefined`] |
+| **name** | `Array<string>` | Filter by agent name (can specify multiple values) | [Optional] |
+| **status** | `New`, `Connected`, `Disconnected`, `Error`, `Disabled` | Filter by agent status (can specify multiple values) | [Optional] [Enum: New, Connected, Disconnected, Error, Disabled] |
+| **providerId** | `Array<string>` | Filter by provider ID (can specify multiple values) | [Optional] |
+| **agentTypeId** | `Array<string>` | Filter by agent type ID (can specify multiple values) | [Optional] |
+
+### Return type
+
+[**AgentsList200Response**](AgentsList200Response.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | A paginated list of agents |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## agentsUpdate
+
+> AgentRes agentsUpdate(id, updateAgentReq)
+
+Update an agent
+
+Updates an existing agent
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgentsApi,
+} from 'fulcrum-cem-client';
+import type { AgentsUpdateRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new AgentsApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // UpdateAgentReq
+    updateAgentReq: ...,
+  } satisfies AgentsUpdateRequest;
+
+  try {
+    const data = await api.agentsUpdate(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+| **updateAgentReq** | [UpdateAgentReq](UpdateAgentReq.md) |  | |
+
+### Return type
+
+[**AgentRes**](AgentRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Agent updated successfully |  -  |
+| **404** | Agent not found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## agentsUpdateStatus
+
+> AgentRes agentsUpdateStatus(agentsUpdateStatusRequest)
+
+Update agent status
+
+Updates the status of the authenticated agent
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AgentsApi,
+} from 'fulcrum-cem-client';
+import type { AgentsUpdateStatusOperationRequest } from 'fulcrum-cem-client';
+
+async function example() {
+  console.log("🚀 Testing fulcrum-cem-client SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: BearerAuth implicit
+    accessToken: "YOUR ACCESS TOKEN",
+  });
+  const api = new AgentsApi(config);
+
+  const body = {
+    // AgentsUpdateStatusRequest
+    agentsUpdateStatusRequest: ...,
+  } satisfies AgentsUpdateStatusOperationRequest;
+
+  try {
+    const data = await api.agentsUpdateStatus(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **agentsUpdateStatusRequest** | [AgentsUpdateStatusRequest](AgentsUpdateStatusRequest.md) |  | |
+
+### Return type
+
+[**AgentRes**](AgentRes.md)
+
+### Authorization
+
+[BearerAuth implicit](../README.md#BearerAuth-implicit)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Agent status updated successfully |  -  |
+| **400** | Invalid request |  -  |
+| **401** | Unauthorized |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+