@breign/client 1.0.4 → 1.0.6

package/README.md

@@ -0,0 +1,51 @@
+# @breign/client
+
+TypeScript client library for interacting with the Brain API. This package provides a strongly-typed interface generated from OpenAPI specifications.
+
+## Installation
+
+```bash
+npm install @breign/client
+```
+
+## Usage
+
+```typescript
+import { ... } from '@breign/client';
+
+// Configure API key authentication
+// Implementation details depend on your use case
+```
+
+## Development
+
+### Prerequisites
+
+- Node.js (version specified in `.nvmrc`)
+- npm
+
+### Setup
+
+1. Clone the repository
+2. Install dependencies:
+   ```bash
+   npm install
+   ```
+
+### Available Scripts
+
+- `npm run generate` - Generates API client from OpenAPI specs
+- `npm run build` - Builds the TypeScript project
+- `npm run clean` - Cleans generated and build directories
+- `npm run format` - Formats code using Prettier
+- `npm run format:check` - Checks code formatting
+
+### Project Structure
+
+- `src/resources/openapi/` - OpenAPI specifications
+- `dist/` - Compiled output
+- `target/` - Generated source files
+
+## TODO
+- [ ] Generate API for mobile development (Swift, Kotlin)?
+- [ ] Decide if we should use date-time format for dates or strings?

package/dist/apis/AgentApi.d.ts

@@ -0,0 +1,330 @@
+/**
+ * brain-client
+ * Api ands models for brain-app and brain-app
+ *
+ * The version of the OpenAPI document: 0.0.0-SNAPSHOT
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import type { AgentDuplicateRequestUio, AgentFlowCreateUio, AgentFlowUio, AgentMetricsEventUio, AgentMetricsOverviewUio, AgentModuleUio, AgentPatchUio, AgentRequestUio, AgentSubscriptionUio, AgentUio, AgentUsageMetricsUio, BodyWithIdUio, ChatUio, FileCreationRequestUio, FileCreationResponseUio, S3UploadBodyUio } from '../models/index';
+export interface AddModuleRequest {
+    agentId: string;
+    agentModuleUio: AgentModuleUio;
+}
+export interface CreateAgentRequest {
+    agentRequestUio: AgentRequestUio;
+}
+export interface CreateFlowRequest {
+    agentId: string;
+    agentFlowCreateUio: AgentFlowCreateUio;
+}
+export interface DeleteAgentByIdRequest {
+    agentId: string;
+}
+export interface DeleteFlowRequest {
+    agentId: string;
+    flowId: string;
+}
+export interface DeleteModuleRequest {
+    agentId: string;
+    moduleName: string;
+}
+export interface DuplicateAgentRequest {
+    agentId: string;
+    agentDuplicateRequestUio: AgentDuplicateRequestUio;
+}
+export interface GetAgentByIdRequest {
+    agentId: string;
+}
+export interface GetAgentMetricsRequest {
+    agentId: string;
+    startDate?: Date;
+    endDate?: Date;
+}
+export interface GetAgentMetricsEventsRequest {
+    agentId: string;
+    offset?: number;
+    startDate?: Date;
+    endDate?: Date;
+}
+export interface GetAgentMetricsOverviewRequest {
+    agentId: string;
+    startDate?: Date;
+    endDate?: Date;
+}
+export interface GetConversationsForAgentRequest {
+    agentId: string;
+    page?: number;
+}
+export interface GetFlowRequest {
+    agentId: string;
+    flowId: string;
+}
+export interface GetFlowsRequest {
+    agentId: string;
+}
+export interface GetModulesRequest {
+    agentId: string;
+}
+export interface RemoveAgentProfileImageRequest {
+    agentId: string;
+}
+export interface RemoveAgentSubscriptionRequest {
+    agentId: string;
+}
+export interface UpdateAgentByIdRequest {
+    agentId: string;
+    agentPatchUio: AgentPatchUio;
+}
+export interface UpdateAgentProfilePictureRequest {
+    agentId: string;
+    fileCreationRequestUio: FileCreationRequestUio;
+}
+export interface UpdateAgentSubscriptionRequest {
+    agentId: string;
+    agentSubscriptionUio: AgentSubscriptionUio;
+}
+export interface UpdateFlowRequest {
+    agentId: string;
+    flowId: string;
+    agentFlowUio: AgentFlowUio;
+}
+export interface UploadAgentProfileImageRequest {
+    agentId: string;
+    fileCreationRequestUio: FileCreationRequestUio;
+}
+/**
+ *
+ */
+export declare class AgentApi extends runtime.BaseAPI {
+    /**
+     * Adds a new module to the specified agent
+     * Add a module to an agent
+     */
+    addModuleRaw(requestParameters: AddModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentModuleUio>>;
+    /**
+     * Adds a new module to the specified agent
+     * Add a module to an agent
+     */
+    addModule(agentId: string, agentModuleUio: AgentModuleUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentModuleUio>;
+    /**
+     * Creates a new agent with specified configuration (admin only)
+     * Create a new agent
+     */
+    createAgentRaw(requestParameters: CreateAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentUio>>;
+    /**
+     * Creates a new agent with specified configuration (admin only)
+     * Create a new agent
+     */
+    createAgent(agentRequestUio: AgentRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentUio>;
+    /**
+     * Creates a new conversation flow for a specific agent
+     * Create a new flow
+     */
+    createFlowRaw(requestParameters: CreateFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentFlowUio>>;
+    /**
+     * Creates a new conversation flow for a specific agent
+     * Create a new flow
+     */
+    createFlow(agentId: string, agentFlowCreateUio: AgentFlowCreateUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentFlowUio>;
+    /**
+     * Deletes an agent and all its associated flows
+     * Delete an agent
+     */
+    deleteAgentByIdRaw(requestParameters: DeleteAgentByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes an agent and all its associated flows
+     * Delete an agent
+     */
+    deleteAgentById(agentId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Deletes a specific conversation flow
+     * Delete a flow
+     */
+    deleteFlowRaw(requestParameters: DeleteFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes a specific conversation flow
+     * Delete a flow
+     */
+    deleteFlow(agentId: string, flowId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Deletes a specific module from the agent
+     * Remove a module from an agent
+     */
+    deleteModuleRaw(requestParameters: DeleteModuleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Deletes a specific module from the agent
+     * Remove a module from an agent
+     */
+    deleteModule(agentId: string, moduleName: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Duplicates an agent and returns the new agent
+     * Duplicate an agent
+     */
+    duplicateAgentRaw(requestParameters: DuplicateAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BodyWithIdUio>>;
+    /**
+     * Duplicates an agent and returns the new agent
+     * Duplicate an agent
+     */
+    duplicateAgent(agentId: string, agentDuplicateRequestUio: AgentDuplicateRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BodyWithIdUio>;
+    /**
+     * Get a specific agent by ID
+     */
+    getAgentByIdRaw(requestParameters: GetAgentByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentUio>>;
+    /**
+     * Get a specific agent by ID
+     */
+    getAgentById(agentId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentUio>;
+    /**
+     * Retrieves detailed usage metrics for a specific agent (admin only)
+     * Get detailed agent metrics
+     */
+    getAgentMetricsRaw(requestParameters: GetAgentMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AgentUsageMetricsUio>>>;
+    /**
+     * Retrieves detailed usage metrics for a specific agent (admin only)
+     * Get detailed agent metrics
+     */
+    getAgentMetrics(agentId: string, startDate?: Date, endDate?: Date, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AgentUsageMetricsUio>>;
+    /**
+     * Retrieves detailed metric events for a specific agent (admin only)
+     * Get agent metrics events
+     */
+    getAgentMetricsEventsRaw(requestParameters: GetAgentMetricsEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AgentMetricsEventUio>>>;
+    /**
+     * Retrieves detailed metric events for a specific agent (admin only)
+     * Get agent metrics events
+     */
+    getAgentMetricsEvents(agentId: string, offset?: number, startDate?: Date, endDate?: Date, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AgentMetricsEventUio>>;
+    /**
+     * Retrieves usage metrics overview for a specific agent
+     * Get agent metrics overview
+     */
+    getAgentMetricsOverviewRaw(requestParameters: GetAgentMetricsOverviewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentMetricsOverviewUio>>;
+    /**
+     * Retrieves usage metrics overview for a specific agent
+     * Get agent metrics overview
+     */
+    getAgentMetricsOverview(agentId: string, startDate?: Date, endDate?: Date, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentMetricsOverviewUio>;
+    /**
+     * Get all agents (admin only)
+     * Get all agents
+     */
+    getAgentsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AgentUio>>>;
+    /**
+     * Get all agents (admin only)
+     * Get all agents
+     */
+    getAgents(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AgentUio>>;
+    /**
+     * Get conversations for an agent
+     * Get conversations for an agent
+     */
+    getConversationsForAgentRaw(requestParameters: GetConversationsForAgentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<ChatUio>>>;
+    /**
+     * Get conversations for an agent
+     * Get conversations for an agent
+     */
+    getConversationsForAgent(agentId: string, page?: number, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<ChatUio>>;
+    /**
+     * Retrieves a specific conversation flow by ID
+     * Get a specific flow
+     */
+    getFlowRaw(requestParameters: GetFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentFlowUio>>;
+    /**
+     * Retrieves a specific conversation flow by ID
+     * Get a specific flow
+     */
+    getFlow(agentId: string, flowId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentFlowUio>;
+    /**
+     * Retrieves all conversation flows associated with a specific agent
+     * Get all flows for an agent
+     */
+    getFlowsRaw(requestParameters: GetFlowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AgentFlowUio>>>;
+    /**
+     * Retrieves all conversation flows associated with a specific agent
+     * Get all flows for an agent
+     */
+    getFlows(agentId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AgentFlowUio>>;
+    /**
+     * Retrieves all modules for a specific agent
+     * Get agent modules
+     */
+    getModulesRaw(requestParameters: GetModulesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentModuleUio>>;
+    /**
+     * Retrieves all modules for a specific agent
+     * Get agent modules
+     */
+    getModules(agentId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentModuleUio>;
+    /**
+     * Removes the profile image for an agent
+     * Remove agent profile image
+     */
+    removeAgentProfileImageRaw(requestParameters: RemoveAgentProfileImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Removes the profile image for an agent
+     * Remove agent profile image
+     */
+    removeAgentProfileImage(agentId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Removes the subscription plan from an agent (admin only)
+     * Remove agent subscription
+     */
+    removeAgentSubscriptionRaw(requestParameters: RemoveAgentSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Removes the subscription plan from an agent (admin only)
+     * Remove agent subscription
+     */
+    removeAgentSubscription(agentId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Updates an existing agent\'s properties
+     * Update an agent
+     */
+    updateAgentByIdRaw(requestParameters: UpdateAgentByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentPatchUio>>;
+    /**
+     * Updates an existing agent\'s properties
+     * Update an agent
+     */
+    updateAgentById(agentId: string, agentPatchUio: AgentPatchUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentPatchUio>;
+    /**
+     * Update profile picture for an agent
+     */
+    updateAgentProfilePictureRaw(requestParameters: UpdateAgentProfilePictureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<S3UploadBodyUio>>;
+    /**
+     * Update profile picture for an agent
+     */
+    updateAgentProfilePicture(agentId: string, fileCreationRequestUio: FileCreationRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<S3UploadBodyUio>;
+    /**
+     * Sets or updates a subscription plan for an agent (admin only)
+     * Update agent subscription
+     */
+    updateAgentSubscriptionRaw(requestParameters: UpdateAgentSubscriptionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentSubscriptionUio>>;
+    /**
+     * Sets or updates a subscription plan for an agent (admin only)
+     * Update agent subscription
+     */
+    updateAgentSubscription(agentId: string, agentSubscriptionUio: AgentSubscriptionUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentSubscriptionUio>;
+    /**
+     * Updates an existing conversation flow
+     * Update a flow
+     */
+    updateFlowRaw(requestParameters: UpdateFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AgentFlowUio>>;
+    /**
+     * Updates an existing conversation flow
+     * Update a flow
+     */
+    updateFlow(agentId: string, flowId: string, agentFlowUio: AgentFlowUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AgentFlowUio>;
+    /**
+     * Uploads a profile image for an agent and returns an upload URL
+     * Upload agent profile image
+     */
+    uploadAgentProfileImageRaw(requestParameters: UploadAgentProfileImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<FileCreationResponseUio>>;
+    /**
+     * Uploads a profile image for an agent and returns an upload URL
+     * Upload agent profile image
+     */
+    uploadAgentProfileImage(agentId: string, fileCreationRequestUio: FileCreationRequestUio, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<FileCreationResponseUio>;
+}