tychat-contracts 1.6.21 → 1.6.23

package/src/conversations/followup-log-response.dto.ts

@@ -1,58 +1,58 @@
-import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
-import { IsIn, IsInt, IsNotEmpty, IsOptional, IsString, Max, Min } from 'class-validator';
-import { FOLLOWUP_TYPES, FollowupTypeDto } from './followup-type.dto';
-
-/**
- * Represents a follow-up attempt log entry.
- * Tracks each follow-up message sent to a patient within a session or appointment.
- */
-export class FollowupLogResponseDto {
-  @ApiProperty({ description: 'Log primary key (UUID)' })
-  @IsString()
-  @IsNotEmpty()
-  id: string;
-
-  @ApiPropertyOptional({ description: 'Session UUID from conversation_sessions (null for appointment-based)' })
-  @IsOptional()
-  @IsString()
-  sessionUuid?: string | null;
-
-  @ApiProperty({ description: 'Patient UUID' })
-  @IsString()
-  @IsNotEmpty()
-  patientId: string;
-
-  @ApiProperty({ description: 'Follow-up attempt number (1-5 for abandonment, 1 for appointment-based)', example: 1 })
-  @IsInt()
-  @Min(1)
-  @Max(5)
-  attempt: number;
-
-  @ApiProperty({ description: 'The follow-up message sent to the patient' })
-  @IsString()
-  @IsNotEmpty()
-  message: string;
-
-  @ApiPropertyOptional({ description: 'The intention detected at the time of follow-up' })
-  @IsOptional()
-  @IsString()
-  intention?: string;
-
-  @ApiProperty({
-    description: 'Type of follow-up',
-    enum: FOLLOWUP_TYPES,
-    example: 'abandonment',
-  })
-  @IsIn(FOLLOWUP_TYPES)
-  followupType: FollowupTypeDto;
-
-  @ApiPropertyOptional({ description: 'Appointment UUID (for appointment-based follow-ups)' })
-  @IsOptional()
-  @IsString()
-  appointmentId?: string | null;
-
-  @ApiProperty({ description: 'Timestamp when the follow-up was sent (ISO 8601)' })
-  @IsString()
-  @IsNotEmpty()
-  sentAt: string;
-}
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import { IsIn, IsInt, IsNotEmpty, IsOptional, IsString, Max, Min } from 'class-validator';
+import { FOLLOWUP_TYPES, FollowupTypeDto } from './followup-type.dto';
+
+/**
+ * Represents a follow-up attempt log entry.
+ * Tracks each follow-up message sent to a patient within a session or appointment.
+ */
+export class FollowupLogResponseDto {
+  @ApiProperty({ description: 'Log primary key (UUID)' })
+  @IsString()
+  @IsNotEmpty()
+  id: string;
+
+  @ApiPropertyOptional({ description: 'Session UUID from conversation_sessions (null for appointment-based)' })
+  @IsOptional()
+  @IsString()
+  sessionUuid?: string | null;
+
+  @ApiProperty({ description: 'Patient UUID' })
+  @IsString()
+  @IsNotEmpty()
+  patientId: string;
+
+  @ApiProperty({ description: 'Follow-up attempt number (1-5 for abandonment, 1 for appointment-based)', example: 1 })
+  @IsInt()
+  @Min(1)
+  @Max(5)
+  attempt: number;
+
+  @ApiProperty({ description: 'The follow-up message sent to the patient' })
+  @IsString()
+  @IsNotEmpty()
+  message: string;
+
+  @ApiPropertyOptional({ description: 'The intention detected at the time of follow-up' })
+  @IsOptional()
+  @IsString()
+  intention?: string;
+
+  @ApiProperty({
+    description: 'Type of follow-up',
+    enum: FOLLOWUP_TYPES,
+    example: 'abandonment',
+  })
+  @IsIn(FOLLOWUP_TYPES)
+  followupType: FollowupTypeDto;
+
+  @ApiPropertyOptional({ description: 'Appointment UUID (for appointment-based follow-ups)' })
+  @IsOptional()
+  @IsString()
+  appointmentId?: string | null;
+
+  @ApiProperty({ description: 'Timestamp when the follow-up was sent (ISO 8601)' })
+  @IsString()
+  @IsNotEmpty()
+  sentAt: string;
+}

package/src/conversations/followup-type.dto.ts

@@ -1,22 +1,22 @@
-/**
- * All follow-up types supported by the follow-up service.
- *
- * - "abandonment"              → Patient stopped responding during a conversation.
- * - "appointment_confirmation" → Reminder sent before an upcoming appointment.
- * - "satisfaction_booking"     → Satisfaction survey after the patient books an appointment.
- * - "satisfaction_finished"    → Satisfaction survey after an appointment is marked as finished.
- * - "no_show_reschedule"       → Follow-up for patients who did not show up (no_show status).
- * - "wellness_check"           → Check on patient well-being after procedures (side effects).
- * - "return_suggestion"        → Suggest a return visit based on procedure return_days.
- */
-export const FOLLOWUP_TYPES = [
-  'abandonment',
-  'appointment_confirmation',
-  'satisfaction_booking',
-  'satisfaction_finished',
-  'no_show_reschedule',
-  'wellness_check',
-  'return_suggestion',
-] as const;
-
-export type FollowupTypeDto = (typeof FOLLOWUP_TYPES)[number];
+/**
+ * All follow-up types supported by the follow-up service.
+ *
+ * - "abandonment"              → Patient stopped responding during a conversation.
+ * - "appointment_confirmation" → Reminder sent before an upcoming appointment.
+ * - "satisfaction_booking"     → Satisfaction survey after the patient books an appointment.
+ * - "satisfaction_finished"    → Satisfaction survey after an appointment is marked as finished.
+ * - "no_show_reschedule"       → Follow-up for patients who did not show up (no_show status).
+ * - "wellness_check"           → Check on patient well-being after procedures (side effects).
+ * - "return_suggestion"        → Suggest a return visit based on procedure return_days.
+ */
+export const FOLLOWUP_TYPES = [
+  'abandonment',
+  'appointment_confirmation',
+  'satisfaction_booking',
+  'satisfaction_finished',
+  'no_show_reschedule',
+  'wellness_check',
+  'return_suggestion',
+] as const;
+
+export type FollowupTypeDto = (typeof FOLLOWUP_TYPES)[number];

package/src/conversations/index.ts

@@ -1,17 +1,17 @@
-export * from './conversation-type.dto';
-export * from './conversation-intention.dto';
-export * from './list-conversation-contacts-filters.dto';
-export * from './conversation-contact-filters-query.validator';
-export * from './list-conversation-contacts-query.dto';
-export * from './list-conversation-sessions-query.dto';
-export * from './create-conversation-session.dto';
-export * from './conversation-session-response.dto';
-export * from './create-conversation.dto';
-export * from './conversation-response.dto';
-export * from './followup-type.dto';
-export * from './followup-config-response.dto';
-export * from './followup-log-response.dto';
-export * from './followup-log-list-query.dto';
-export * from './followup-log-list-response.dto';
-export * from './satisfaction-response.dto';
-export * from './followup-events.dto';
+export * from './conversation-type.dto';
+export * from './conversation-intention.dto';
+export * from './list-conversation-contacts-filters.dto';
+export * from './conversation-contact-filters-query.validator';
+export * from './list-conversation-contacts-query.dto';
+export * from './list-conversation-sessions-query.dto';
+export * from './create-conversation-session.dto';
+export * from './conversation-session-response.dto';
+export * from './create-conversation.dto';
+export * from './conversation-response.dto';
+export * from './followup-type.dto';
+export * from './followup-config-response.dto';
+export * from './followup-log-response.dto';
+export * from './followup-log-list-query.dto';
+export * from './followup-log-list-response.dto';
+export * from './satisfaction-response.dto';
+export * from './followup-events.dto';

package/src/conversations/list-conversation-contacts-filters.dto.ts

@@ -1,15 +1,15 @@
-/**
- * Re-exports CONVERSATION_CONTACT_LIST_FILTER_KEYS from the query DTO
- * for backward compatibility. The generic ParsedFilterDto from `../filters`
- * is now the canonical filter shape used across all services.
- */
-export {
-  CONVERSATION_CONTACT_LIST_FILTER_KEYS,
-  type ConversationContactListFilterKeyDto,
-} from './list-conversation-contacts-query.dto';
-
-/**
- * @deprecated Use `ParsedFilterDto` from `../filters` instead.
- * Kept as an alias for backward compatibility during migration.
- */
-export type { ParsedFilterDto as ConversationContactListFilterDto } from '../filters/parsed-filter.dto';
+/**
+ * Re-exports CONVERSATION_CONTACT_LIST_FILTER_KEYS from the query DTO
+ * for backward compatibility. The generic ParsedFilterDto from `../filters`
+ * is now the canonical filter shape used across all services.
+ */
+export {
+  CONVERSATION_CONTACT_LIST_FILTER_KEYS,
+  type ConversationContactListFilterKeyDto,
+} from './list-conversation-contacts-query.dto';
+
+/**
+ * @deprecated Use `ParsedFilterDto` from `../filters` instead.
+ * Kept as an alias for backward compatibility during migration.
+ */
+export type { ParsedFilterDto as ConversationContactListFilterDto } from '../filters/parsed-filter.dto';

package/src/conversations/list-conversation-contacts-query.dto.ts

@@ -1,81 +1,81 @@
-import { ApiPropertyOptional } from '@nestjs/swagger';
-import { Transform } from 'class-transformer';
-import { IsIn, IsInt, IsOptional, Max, Min } from 'class-validator';
-import type { ParsedFilterDto } from '../filters/parsed-filter.dto';
-
-/**
- * Allowed conversation session entity columns for filtering (camelCase API keys).
- * Microservice uses this whitelist to prevent access to non-existent columns.
- */
-export const CONVERSATION_CONTACT_LIST_FILTER_KEYS = [
-  'id',
-  'sessionUuid',
-  'patientId',
-  'unitId',
-  'tenantEvogoInstanceId',
-  'conversationType',
-  'intention',
-  'unreadCount',
-  'startedAt',
-  'expiresAt',
-] as const;
-export type ConversationContactListFilterKeyDto =
-  (typeof CONVERSATION_CONTACT_LIST_FILTER_KEYS)[number];
-
-export class ListConversationContactsQueryDto {
-  @ApiPropertyOptional({
-    description: 'Número da página (iniciando em 1)',
-    example: 1,
-    minimum: 1,
-    default: 1,
-  })
-  @IsOptional()
-  @IsInt()
-  @Min(1)
-  page?: number;
-
-  @ApiPropertyOptional({
-    description: 'Registros por página',
-    example: 20,
-    minimum: 1,
-    maximum: 100,
-    default: 20,
-  })
-  @IsOptional()
-  @IsInt()
-  @Min(1)
-  @Max(100)
-  limit?: number;
-
-  @ApiPropertyOptional({
-    description:
-      'Campo de ordenação: `startedAt` (padrão na API) ou `unreadCount`.',
-    enum: ['startedAt', 'unreadCount'],
-  })
-  @IsOptional()
-  @Transform(({ value }) => (typeof value === 'string' ? value.trim() : value))
-  @IsIn(['startedAt', 'unreadCount'])
-  sortBy?: 'startedAt' | 'unreadCount';
-
-  @ApiPropertyOptional({
-    description: 'Direção: `ASC` ou `DESC` (case-insensitive na query string).',
-    enum: ['ASC', 'DESC'],
-  })
-  @IsOptional()
-  @Transform(({ value }) =>
-    typeof value === 'string' ? value.trim().toUpperCase() : value,
-  )
-  @IsIn(['ASC', 'DESC'])
-  sortOrder?: 'ASC' | 'DESC';
-
-  @ApiPropertyOptional({
-    description:
-      'JSON string with an array of filter objects `{ key, op, value }`. ' +
-      'Example: `[{"key":"intention","op":"==","value":"clinic_info"}]`. ' +
-      'Ops: ==, !=, >, <, >=, <=, in (value must be array for `in`), like, unlike (value must be string pattern for SQL LIKE).',
-    type: String,
-    example: '[{"key":"intention","op":"==","value":"clinic_info"}]',
-  })
-  @IsOptional()
-  filters?: ParsedFilterDto[];
-}
+import { ApiPropertyOptional } from '@nestjs/swagger';
+import { Transform } from 'class-transformer';
+import { IsIn, IsInt, IsOptional, Max, Min } from 'class-validator';
+import type { ParsedFilterDto } from '../filters/parsed-filter.dto';
+
+/**
+ * Allowed conversation session entity columns for filtering (camelCase API keys).
+ * Microservice uses this whitelist to prevent access to non-existent columns.
+ */
+export const CONVERSATION_CONTACT_LIST_FILTER_KEYS = [
+  'id',
+  'sessionUuid',
+  'patientId',
+  'unitId',
+  'tenantEvogoInstanceId',
+  'conversationType',
+  'intention',
+  'unreadCount',
+  'startedAt',
+  'expiresAt',
+] as const;
+export type ConversationContactListFilterKeyDto =
+  (typeof CONVERSATION_CONTACT_LIST_FILTER_KEYS)[number];
+
+export class ListConversationContactsQueryDto {
+  @ApiPropertyOptional({
+    description: 'Número da página (iniciando em 1)',
+    example: 1,
+    minimum: 1,
+    default: 1,
+  })
+  @IsOptional()
+  @IsInt()
+  @Min(1)
+  page?: number;
+
+  @ApiPropertyOptional({
+    description: 'Registros por página',
+    example: 20,
+    minimum: 1,
+    maximum: 100,
+    default: 20,
+  })
+  @IsOptional()
+  @IsInt()
+  @Min(1)
+  @Max(100)
+  limit?: number;
+
+  @ApiPropertyOptional({
+    description:
+      'Campo de ordenação: `startedAt` (padrão na API) ou `unreadCount`.',
+    enum: ['startedAt', 'unreadCount'],
+  })
+  @IsOptional()
+  @Transform(({ value }) => (typeof value === 'string' ? value.trim() : value))
+  @IsIn(['startedAt', 'unreadCount'])
+  sortBy?: 'startedAt' | 'unreadCount';
+
+  @ApiPropertyOptional({
+    description: 'Direção: `ASC` ou `DESC` (case-insensitive na query string).',
+    enum: ['ASC', 'DESC'],
+  })
+  @IsOptional()
+  @Transform(({ value }) =>
+    typeof value === 'string' ? value.trim().toUpperCase() : value,
+  )
+  @IsIn(['ASC', 'DESC'])
+  sortOrder?: 'ASC' | 'DESC';
+
+  @ApiPropertyOptional({
+    description:
+      'JSON string with an array of filter objects `{ key, op, value }`. ' +
+      'Example: `[{"key":"intention","op":"==","value":"clinic_info"}]`. ' +
+      'Ops: ==, !=, >, <, >=, <=, in (value must be array for `in`), like, unlike (value must be string pattern for SQL LIKE).',
+    type: String,
+    example: '[{"key":"intention","op":"==","value":"clinic_info"}]',
+  })
+  @IsOptional()
+  filters?: ParsedFilterDto[];
+}

package/src/conversations/satisfaction-response.dto.ts

@@ -1,116 +1,116 @@
-import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
-import {
-  IsIn,
-  IsInt,
-  IsNotEmpty,
-  IsOptional,
-  IsString,
-  Max,
-  MaxLength,
-  Min,
-} from 'class-validator';
-
-/** Valid satisfaction survey types. */
-export const SATISFACTION_TYPES = [
-  'satisfaction_booking',
-  'satisfaction_finished',
-] as const;
-
-export type SatisfactionTypeDto = (typeof SATISFACTION_TYPES)[number];
-
-/**
- * Payload to save a patient's satisfaction rating.
- * Sent from the conversation-service to the followup-service
- * when the AI detects a numeric satisfaction response.
- */
-export class SaveSatisfactionRequestDto {
-  @ApiProperty({ description: 'Tenant slug', example: 'clinic-alpha' })
-  @IsString()
-  @IsNotEmpty()
-  tenant: string;
-
-  @ApiProperty({ description: 'Patient UUID' })
-  @IsString()
-  @IsNotEmpty()
-  patientId: string;
-
-  @ApiProperty({ description: 'Appointment UUID linked to the satisfaction survey' })
-  @IsString()
-  @IsNotEmpty()
-  appointmentId: string;
-
-  @ApiProperty({
-    description: 'Type of satisfaction survey',
-    enum: SATISFACTION_TYPES,
-    example: 'satisfaction_booking',
-  })
-  @IsIn(SATISFACTION_TYPES)
-  satisfactionType: SatisfactionTypeDto;
-
-  @ApiProperty({ description: 'Patient satisfaction rating (1-5)', example: 4 })
-  @IsInt()
-  @Min(1)
-  @Max(5)
-  rating: number;
-
-  @ApiPropertyOptional({ description: 'Optional text comment from the patient', example: 'Otimo atendimento!' })
-  @IsOptional()
-  @IsString()
-  @MaxLength(2000)
-  comment?: string;
-}
-
-/**
- * Response DTO for a saved satisfaction rating.
- */
-export class SatisfactionResponseDto {
-  @ApiProperty({ description: 'Primary key (UUID)' })
-  @IsString()
-  @IsNotEmpty()
-  id: string;
-
-  @ApiProperty({ description: 'Patient UUID' })
-  @IsString()
-  @IsNotEmpty()
-  patientId: string;
-
-  @ApiProperty({ description: 'Appointment UUID' })
-  @IsString()
-  @IsNotEmpty()
-  appointmentId: string;
-
-  @ApiProperty({
-    description: 'Type of satisfaction survey',
-    enum: SATISFACTION_TYPES,
-    example: 'satisfaction_finished',
-  })
-  @IsIn(SATISFACTION_TYPES)
-  satisfactionType: SatisfactionTypeDto;
-
-  @ApiProperty({ description: 'Patient satisfaction rating (1-5)', example: 5 })
-  @IsInt()
-  @Min(1)
-  @Max(5)
-  rating: number;
-
-  @ApiPropertyOptional({ description: 'Optional text comment from the patient' })
-  @IsOptional()
-  @IsString()
-  comment?: string | null;
-
-  @ApiProperty({ description: 'Timestamp when the response was recorded (ISO 8601)' })
-  @IsString()
-  @IsNotEmpty()
-  createdAt: string;
-}
-
-/**
- * Response DTO for average satisfaction stats.
- */
-export class SatisfactionAverageDto {
-  @ApiProperty({ description: 'Average rating', example: 4.2 })
-  average: number;
-
-  @ApiProperty({ description: 'Total number of responses', example: 42 })
-  count: number;
-}
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import {
+  IsIn,
+  IsInt,
+  IsNotEmpty,
+  IsOptional,
+  IsString,
+  Max,
+  MaxLength,
+  Min,
+} from 'class-validator';
+
+/** Valid satisfaction survey types. */
+export const SATISFACTION_TYPES = [
+  'satisfaction_booking',
+  'satisfaction_finished',
+] as const;
+
+export type SatisfactionTypeDto = (typeof SATISFACTION_TYPES)[number];
+
+/**
+ * Payload to save a patient's satisfaction rating.
+ * Sent from the conversation-service to the followup-service
+ * when the AI detects a numeric satisfaction response.
+ */
+export class SaveSatisfactionRequestDto {
+  @ApiProperty({ description: 'Tenant slug', example: 'clinic-alpha' })
+  @IsString()
+  @IsNotEmpty()
+  tenant: string;
+
+  @ApiProperty({ description: 'Patient UUID' })
+  @IsString()
+  @IsNotEmpty()
+  patientId: string;
+
+  @ApiProperty({ description: 'Appointment UUID linked to the satisfaction survey' })
+  @IsString()
+  @IsNotEmpty()
+  appointmentId: string;
+
+  @ApiProperty({
+    description: 'Type of satisfaction survey',
+    enum: SATISFACTION_TYPES,
+    example: 'satisfaction_booking',
+  })
+  @IsIn(SATISFACTION_TYPES)
+  satisfactionType: SatisfactionTypeDto;
+
+  @ApiProperty({ description: 'Patient satisfaction rating (1-5)', example: 4 })
+  @IsInt()
+  @Min(1)
+  @Max(5)
+  rating: number;
+
+  @ApiPropertyOptional({ description: 'Optional text comment from the patient', example: 'Otimo atendimento!' })
+  @IsOptional()
+  @IsString()
+  @MaxLength(2000)
+  comment?: string;
+}
+
+/**
+ * Response DTO for a saved satisfaction rating.
+ */
+export class SatisfactionResponseDto {
+  @ApiProperty({ description: 'Primary key (UUID)' })
+  @IsString()
+  @IsNotEmpty()
+  id: string;
+
+  @ApiProperty({ description: 'Patient UUID' })
+  @IsString()
+  @IsNotEmpty()
+  patientId: string;
+
+  @ApiProperty({ description: 'Appointment UUID' })
+  @IsString()
+  @IsNotEmpty()
+  appointmentId: string;
+
+  @ApiProperty({
+    description: 'Type of satisfaction survey',
+    enum: SATISFACTION_TYPES,
+    example: 'satisfaction_finished',
+  })
+  @IsIn(SATISFACTION_TYPES)
+  satisfactionType: SatisfactionTypeDto;
+
+  @ApiProperty({ description: 'Patient satisfaction rating (1-5)', example: 5 })
+  @IsInt()
+  @Min(1)
+  @Max(5)
+  rating: number;
+
+  @ApiPropertyOptional({ description: 'Optional text comment from the patient' })
+  @IsOptional()
+  @IsString()
+  comment?: string | null;
+
+  @ApiProperty({ description: 'Timestamp when the response was recorded (ISO 8601)' })
+  @IsString()
+  @IsNotEmpty()
+  createdAt: string;
+}
+
+/**
+ * Response DTO for average satisfaction stats.
+ */
+export class SatisfactionAverageDto {
+  @ApiProperty({ description: 'Average rating', example: 4.2 })
+  average: number;
+
+  @ApiProperty({ description: 'Total number of responses', example: 42 })
+  count: number;
+}

package/src/filters/index.ts

@@ -1 +1 @@
-export * from './parsed-filter.dto';
+export * from './parsed-filter.dto';