whio-api-sdk 1.0.193-bet-staging → 1.0.194-beta-staging

package/src/sdk/types/agent.types.ts

@@ -0,0 +1,65 @@
+import { Organization } from './organization.types';
+
+// Agent types
+export interface Agent {
+  id: string;
+  name: string;
+  templateTextReplacement?: string;
+  createdAt: string;
+  updatedAt: string;
+  organizations?: AgentOrganization[];
+}
+
+// Agent Organization association
+export interface AgentOrganization {
+  agentId: string;
+  organizationId: string;
+  createdAt: string;
+  agent?: Agent;
+  organization?: Organization;
+}
+
+// Agent DTOs
+export interface CreateAgentDto {
+  name: string;
+  templateTextReplacement?: string;
+}
+
+export interface UpdateAgentDto {
+  name?: string;
+  templateTextReplacement?: string;
+}
+
+// Agent Settings types
+export interface AgentSettings {
+  id: string;
+  temperature: number;
+  topK: number;
+  topP: number;
+  repetitionPenalty: number;
+  createdAt: string;
+  updatedAt: string;
+  agentId: string;
+  organizationId: string;
+
+  // Relationships (populated by API)
+  agent?: Agent;
+  organization?: Organization;
+}
+
+// Agent Settings DTOs
+export interface CreateAgentSettingsDto {
+  agentId: string;
+  organizationId: string;
+  temperature?: number;
+  topK?: number;
+  topP?: number;
+  repetitionPenalty?: number;
+}
+
+export interface UpdateAgentSettingsDto {
+  temperature?: number;
+  topK?: number;
+  topP?: number;
+  repetitionPenalty?: number;
+}

package/src/sdk/types/audio.types.ts

@@ -0,0 +1,89 @@
+import { Session } from './session.types';
+import { User } from './user.types';
+
+// Audio File types
+export enum AudioFileStatus {
+  UPLOADED = 'UPLOADED',
+  PROCESSING = 'PROCESSING',
+  TRANSCRIBED = 'TRANSCRIBED',
+  FAILED = 'FAILED',
+}
+
+export interface AudioFile {
+  id: string;
+  originalName: string;
+  fileName: string;
+  filePath: string;
+  fileSize: number;
+  mimeType: string;
+  uploadId?: string;
+  transcriptionUrl?: string;
+  transcription?: string;
+  cultural_transcription?: string;
+  status: AudioFileStatus;
+  createdAt: string;
+  updatedAt: string;
+  sessionId: string;
+  userId: string;
+
+  // Relationships (populated by API)
+  session?: Session;
+  user?: User;
+}
+
+// Audio File DTOs
+export interface CreateAudioFileDto {
+  originalName: string;
+  fileName: string;
+  filePath: string;
+  fileSize: number;
+  mimeType: string;
+  uploadId?: string;
+  sessionId: string;
+}
+
+export interface UpdateAudioFileDto {
+  transcriptionUrl?: string;
+  transcription?: string;
+  cultural_transcription?: string;
+  status?: AudioFileStatus;
+}
+
+export interface UploadAudioFileDto {
+  cultural_transcription?: string;
+}
+
+export interface TranscriptionAudioUploadResponse {
+  success: boolean;
+  transcription: string;
+  model_version: string;
+  metadata: any[];
+  duration: number;
+  log: string;
+}
+
+// Base64 Audio File types
+export interface Base64AudioFile {
+  id: string;
+  sessionId: string;
+  audioChunks: string[];
+  createdAt: string;
+  updatedAt: string;
+
+  session?: Session;
+}
+
+// Base64 Audio File DTOs
+export interface CreateBase64AudioFileDto {
+  sessionId: string;
+  audioChunks: string[];
+}
+
+export interface UpdateBase64AudioFileDto {
+  sessionId?: string;
+  audioChunks?: string[];
+}
+
+export interface AddBase64ChunkResponse {
+  count: number;
+}

package/src/sdk/types/auth.types.ts

@@ -0,0 +1,29 @@
+import { User } from './user.types';
+
+// Login response type
+export interface LoginResponse {
+  access_token: string;
+  refresh_token: string;
+  user: User;
+}
+
+// Login credentials type
+export interface LoginCredentials {
+  email: string;
+  password: string;
+}
+
+// Password change DTOs
+export interface ChangePasswordDto {
+  currentPassword: string;
+  newPassword: string;
+}
+
+export interface AdminChangePasswordDto {
+  userId: string;
+  newPassword: string;
+}
+
+export interface PasswordChangeResponse {
+  message: string;
+}

package/src/sdk/types/common.types.ts

@@ -0,0 +1,26 @@
+// Common types used across the SDK
+
+export interface SDKConfig {
+  baseUrl?: string;
+  storage?: {
+    getItem: (key: string) => string | null | Promise<string | null>;
+    setItem: (key: string, value: string) => void | Promise<void>;
+    removeItem: (key: string) => void | Promise<void>;
+  };
+}
+
+// Role type
+export interface Role {
+  id: string;
+  name: string;
+  createdAt: string;
+  updatedAt: string;
+}
+
+// Enum for global role types to match API
+export enum RoleType {
+  SUPERUSER = 'SUPERUSER',
+  ADMIN = 'ADMIN',
+  TRIAL = 'TRIAL',
+  PAID = 'PAID',
+}

package/src/sdk/types/external-integration.types.ts

@@ -0,0 +1,37 @@
+import { Organization } from './organization.types';
+
+// ExternalIntegration type
+export interface ExternalIntegration {
+  id: string;
+  name: string;
+  getUserEndpoint: string;
+  getPatientDataEndpoint: string;
+  saveSummaryEndpoint: string;
+  apiKey: string;
+  headerName: string;
+  createdAt: string;
+  updatedAt: string;
+  organizations?: Array<{
+    id: string;
+    name: string;
+  }>;
+}
+
+// ExternalIntegration DTOs
+export interface CreateExternalIntegrationDto {
+  name: string;
+  getUserEndpoint: string;
+  getPatientDataEndpoint: string;
+  saveSummaryEndpoint: string;
+  apiKey: string;
+  headerName: string;
+}
+
+export interface UpdateExternalIntegrationDto {
+  name?: string;
+  getUserEndpoint?: string;
+  getPatientDataEndpoint?: string;
+  saveSummaryEndpoint?: string;
+  apiKey?: string;
+  headerName?: string;
+}

package/src/sdk/types/index.ts

@@ -0,0 +1,13 @@
+// Barrel export for all types
+export * from './common.types';
+export * from './auth.types';
+export * from './user.types';
+export * from './organization.types';
+export * from './team.types';
+export * from './template.types';
+export * from './agent.types';
+export * from './session.types';
+export * from './audio.types';
+export * from './workflow.types';
+export * from './log.types';
+export * from './external-integration.types';

package/src/sdk/types/log.types.ts

@@ -0,0 +1,68 @@
+// Log types
+export interface Log {
+  id: number;
+  level: string;
+  message: string;
+  meta: any;
+  timestamp: string;
+}
+
+export interface LogsResponse {
+  logs: Log[];
+  total: number;
+  limit: number;
+  offset: number;
+  hasMore: boolean;
+}
+
+export interface LogStats {
+  totalLogs: number;
+  errorLogs: number;
+  warnLogs: number;
+  infoLogs: number;
+  recentLogs: number;
+}
+
+export interface FilterLogsDto {
+  controller?: string;
+  userId?: string;
+  organizationId?: string;
+  level?: 'error' | 'warn' | 'info' | 'debug' | 'verbose';
+  role?: string;
+  organizationRole?: string;
+  teamRole?: string;
+  startDate?: string;
+  endDate?: string;
+  limit?: number;
+  offset?: number;
+}
+
+export interface CreateLogDto {
+  level: 'error' | 'warn' | 'info' | 'debug' | 'verbose';
+  message: string;
+  context?: string;
+  action?: string;
+  data?: any;
+  additionalMeta?: Record<string, any>;
+}
+
+// Debug types
+export interface DebugSessionSummary {
+  id: string;
+  sessionName?: string;
+  dateTime: string;
+  createdAt: string;
+  user: {
+    id: string;
+    email: string;
+    firstName?: string;
+    lastName?: string;
+    organizationId?: string;
+  };
+  template?: {
+    id: string;
+    title: string;
+  };
+  hasMedicalTranscription: boolean;
+  hasPrimaryTranscriptionSummary: boolean;
+}

package/src/sdk/types/organization.types.ts

@@ -0,0 +1,55 @@
+import { User } from './user.types';
+import { AgentOrganization } from './agent.types';
+
+// Organization Role type
+export interface OrganizationRole {
+  id: string;
+  name: string;
+  createdAt: string;
+  updatedAt: string;
+  organizationId: string;
+}
+
+export enum OrganizationRoleType {
+  ADMIN = 'ADMIN',
+  EDITOR = 'EDITOR',
+  DISABLED = 'DISABLED',
+}
+
+// User Organization Role association
+export interface UserOrganizationRole {
+  userId: string;
+  organizationRoleId: string;
+  createdAt: string;
+  organizationRole: OrganizationRole;
+}
+
+// Organization type
+export interface Organization {
+  id: string;
+  name: string;
+  description: string;
+  createdAt: string;
+  updatedAt: string;
+
+  users?: User[];
+  roles?: OrganizationRole[];
+  agents?: AgentOrganization[];
+}
+
+// Organization DTOs
+export interface CreateOrganizationDto {
+  name: string;
+  description?: string;
+}
+
+export interface UpdateOrganizationDto {
+  name?: string;
+  description?: string;
+}
+
+// Organization role assignment DTO
+export interface AssignOrganizationRoleDto {
+  userId: string;
+  organizationRoleId: string;
+}

package/src/sdk/types/session.types.ts

@@ -0,0 +1,63 @@
+import { User } from './user.types';
+import { Template, TranscriptionSummary } from './template.types';
+import { AudioFile } from './audio.types';
+
+// Session types
+export interface Session {
+  id: string;
+  transcript: string;
+  medicalTranscription?: string;
+  culturalTranscription?: string;
+  dateTime: string;
+  startDateTime?: string;
+  stopDateTime?: string;
+  templateName?: string;
+  summary?: string;
+  sessionName?: string;
+  createdAt: string;
+  updatedAt: string;
+  templateId: string;
+  userId: string;
+  primaryTranscriptionSummaryId?: string;
+
+  // Derived fields (computed by API)
+  hasSummaryType?: boolean;
+  hasServerAudioFile?: boolean;
+  hasSummary?: boolean;
+
+  // Relationships (populated by API)
+  user?: User;
+  template?: Template;
+  transcriptionSummaries?: TranscriptionSummary[];
+  primaryTranscriptionSummary?: TranscriptionSummary;
+  audioFiles?: AudioFile[];
+}
+
+// Session DTOs
+export interface CreateSessionDto {
+  transcript: string;
+  medicalTranscription?: string;
+  culturalTranscription?: string;
+  dateTime: string;
+  startDateTime?: string;
+  stopDateTime?: string;
+  templateId?: string;
+  templateName?: string;
+  summary?: string;
+  sessionName?: string;
+  primaryTranscriptionSummaryId?: string;
+}
+
+export interface UpdateSessionDto {
+  transcript?: string;
+  medicalTranscription?: string;
+  culturalTranscription?: string;
+  dateTime?: string;
+  startDateTime?: string;
+  stopDateTime?: string;
+  templateId?: string;
+  templateName?: string;
+  summary?: string;
+  sessionName?: string;
+  primaryTranscriptionSummaryId?: string;
+}

package/src/sdk/types/team.types.ts

@@ -0,0 +1,48 @@
+import { Organization } from './organization.types';
+import { User } from './user.types';
+import { TeamTemplate } from './template.types';
+
+export interface TeamRole {
+  id: string;
+  name: string;
+  createdAt: string;
+  updatesAt: string;
+  userId: string;
+  teamId: string;
+
+  user?: User;
+  team?: Team;
+}
+
+export interface Team {
+  id: string;
+  name: string;
+  description?: string;
+  createdAt: string;
+  updatesAt: string;
+  organizationId: string;
+
+  organization?: Organization;
+  teamRoles?: TeamRole[];
+  teamTemplates?: TeamTemplate[];
+}
+
+// Team DTOs
+export interface CreateTeamDto {
+  name: string;
+  description?: string;
+  organizationId: string;
+}
+
+export interface UpdateTeamDto {
+  name?: string;
+  description?: string;
+  organizationId?: string;
+}
+
+// Team Role assignment DTO
+export interface AssignTeamRoleDto {
+  userId: string;
+  teamId: string;
+  name: string;
+}

package/src/sdk/types/template.types.ts

@@ -0,0 +1,142 @@
+import { Organization } from './organization.types';
+import { User } from './user.types';
+import { Workflow } from './workflow.types';
+import { Agent } from './agent.types';
+import { Team } from './team.types';
+
+export interface TemplateCategory {
+  id: string;
+  name: string;
+}
+
+export interface Template {
+  id: string;
+  title: string;
+  content: string;
+  createdAt: string;
+  updatesAt: string;
+  isGlobal: boolean;
+  organizationId?: string;
+  categoryId: string;
+  createdById: string;
+  workflowId?: string;
+  agentId?: string;
+
+  organization?: Organization;
+  category?: TemplateCategory;
+  createdBy?: User;
+  workflow?: Workflow;
+  agent?: Agent;
+  userTemplates?: UserTemplate[];
+  transcriptionSummaries?: TranscriptionSummary[];
+  teamTemplates?: TeamTemplate[];
+}
+
+export interface UserTemplate {
+  id: string;
+  title: string;
+  content: string;
+  createdAt: string;
+  updatesAt: string;
+  userId: string;
+  originalTemplateId?: string;
+
+  user?: User;
+  originalTemplate?: Template;
+}
+
+export interface TranscriptionSummary {
+  id: string;
+  anonymisedTranscript?: string;
+  content: string;
+  metadata?: any;
+  createdAt: string;
+  updatesAt: string;
+  templateId: string;
+  userId: string;
+
+  template?: Template;
+  user?: User;
+}
+
+export interface TeamTemplate {
+  teamId: string;
+  templateId: string;
+  createdAt: string;
+
+  team?: Team;
+  template?: Template;
+}
+
+// Template DTOs
+export interface CreateTemplateDto {
+  title: string;
+  content: string;
+  isGlobal?: boolean;
+  organizationId: string;
+  categoryId: string;
+  createdById: string;
+  workflowId?: string;
+  agentId?: string;
+}
+
+export interface UpdateTemplateDto {
+  title?: string;
+  content?: string;
+  isGlobal?: boolean;
+  organizationId: string;
+  categoryId?: string;
+  workflowId?: string;
+  agentId?: string;
+}
+
+// Template Category DTOs
+export interface CreateTemplateCategoryDto {
+  name: string;
+}
+
+export interface UpdateTemplateCategoryDto {
+  name?: string;
+}
+
+// User Template DTOs
+export interface CreateUserTemplateDto {
+  title: string;
+  content: string;
+  userId: string;
+  originalTemplateId?: string;
+}
+
+export interface UpdateUserTemplateDto {
+  title?: string;
+  content?: string;
+}
+
+// Team Template DTOs
+export interface AssignTeamTemplateDto {
+  teamId: string;
+  templateId: string;
+}
+
+// Transcription Summary DTOs
+export interface GenerateTranscriptionSummaryDto {
+  templateId: string;
+  userId?: string;
+  fromUserTemplate?: boolean;
+  sessionId: string;
+}
+
+export interface CreateTranscriptionSummaryDto {
+  userId: string;
+  templateId: string;
+  content: string;
+  anonymisedTranscript?: string;
+  metadata?: Record<string, any>;
+}
+
+export interface UpdateTranscriptionSummaryDto {
+  anonymisedTranscript?: string;
+  content?: string;
+  metadata?: Record<string, any>;
+  templateId?: string;
+}

package/src/sdk/types/user.types.ts

@@ -0,0 +1,50 @@
+import { Organization, UserOrganizationRole } from './organization.types';
+import { Role } from './common.types';
+
+// User Role association
+export interface UserRole {
+  userId: string;
+  roleId: string;
+  createdAt: string;
+  role: Role;
+}
+
+// User type
+export interface User {
+  id: string;
+  email: string;
+  firstName: string;
+  lastName: string;
+  createdAt: string;
+  updatedAt: string;
+  organizationId: string;
+  organization: Organization;
+  roles: UserRole[];
+  organizationRoles: UserOrganizationRole[];
+}
+
+// User creation DTO
+export interface CreateUserDto {
+  email: string;
+  password: string;
+  firstName?: string;
+  lastName?: string;
+  organizationId?: string;
+}
+
+// User update DTO
+export interface UpdateUserDto {
+  email?: string;
+  password?: string;
+  firstName?: string;
+  lastName?: string;
+  organizationId?: string;
+}
+
+export interface AdminUser {
+  id: string;
+  email: string;
+  password_hash: string;
+  role: string;
+  created_at: Date;
+}