tychat-contracts 1.6.21 → 1.6.23

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

@@ -1,290 +1,290 @@
-import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
-import {
-  IsBoolean,
-  IsInt,
-  IsNotEmpty,
-  IsOptional,
-  IsString,
-  MaxLength,
-  Min,
-} from 'class-validator';
-
-/**
- * Represents a follow-up timing configuration for a tenant.
- * Defines timing and enabled flags for all follow-up types:
- * abandonment, appointment confirmation, satisfaction surveys,
- * no-show reschedule, wellness check, and return suggestion.
- */
-export class FollowupConfigResponseDto {
-  @ApiProperty({ description: 'Config primary key (UUID)' })
-  @IsString()
-  @IsNotEmpty()
-  id: string;
-
-  @ApiPropertyOptional({ description: 'Tenant unit id', example: 1 })
-  @IsOptional()
-  @IsInt()
-  @Min(1)
-  unitId?: number;
-
-  // ---------------------------------------------------------------------------
-  // Abandonment follow-up settings
-  // ---------------------------------------------------------------------------
-
-  @ApiProperty({
-    description: 'Minutes since last AI/human message to consider the session as abandoned',
-    example: 30,
-  })
-  @IsInt()
-  @Min(1)
-  abandonmentThresholdMinutes: number;
-
-  @ApiProperty({ description: 'Minutes to wait before sending follow-up #1 after abandonment', example: 5 })
-  @IsInt()
-  @Min(1)
-  followup1DelayMinutes: number;
-
-  @ApiProperty({ description: 'Minutes to wait before sending follow-up #2 after #1', example: 15 })
-  @IsInt()
-  @Min(1)
-  followup2DelayMinutes: number;
-
-  @ApiProperty({ description: 'Minutes to wait before sending follow-up #3 after #2', example: 60 })
-  @IsInt()
-  @Min(1)
-  followup3DelayMinutes: number;
-
-  @ApiProperty({ description: 'Minutes to wait before sending follow-up #4 after #3', example: 1440 })
-  @IsInt()
-  @Min(1)
-  followup4DelayMinutes: number;
-
-  @ApiProperty({ description: 'Minutes to wait before sending follow-up #5 (final) after #4', example: 2880 })
-  @IsInt()
-  @Min(1)
-  followup5DelayMinutes: number;
-
-  // ---------------------------------------------------------------------------
-  // Appointment confirmation settings
-  // ---------------------------------------------------------------------------
-
-  @ApiProperty({ description: 'Minutes before the appointment to send the confirmation reminder', example: 60 })
-  @IsInt()
-  @Min(1)
-  confirmationMinutesBefore: number;
-
-  @ApiProperty({ description: 'Whether appointment confirmation follow-up is enabled' })
-  @IsBoolean()
-  confirmationEnabled: boolean;
-
-  // ---------------------------------------------------------------------------
-  // Satisfaction survey settings
-  // ---------------------------------------------------------------------------
-
-  @ApiProperty({ description: 'Minutes after booking confirmation to send the satisfaction survey', example: 10 })
-  @IsInt()
-  @Min(1)
-  satisfactionBookingDelayMinutes: number;
-
-  @ApiProperty({ description: 'Whether satisfaction survey after booking is enabled' })
-  @IsBoolean()
-  satisfactionBookingEnabled: boolean;
-
-  @ApiProperty({ description: 'Minutes after appointment finishes to send the satisfaction survey', example: 30 })
-  @IsInt()
-  @Min(1)
-  satisfactionFinishedDelayMinutes: number;
-
-  @ApiProperty({ description: 'Whether satisfaction survey after finished appointment is enabled' })
-  @IsBoolean()
-  satisfactionFinishedEnabled: boolean;
-
-  // ---------------------------------------------------------------------------
-  // No-show reschedule settings
-  // ---------------------------------------------------------------------------
-
-  @ApiProperty({ description: 'Minutes after a no-show to send the reschedule follow-up', example: 60 })
-  @IsInt()
-  @Min(1)
-  noShowDelayMinutes: number;
-
-  @ApiProperty({ description: 'Whether no-show follow-up is enabled' })
-  @IsBoolean()
-  noShowEnabled: boolean;
-
-  // ---------------------------------------------------------------------------
-  // Wellness check settings
-  // ---------------------------------------------------------------------------
-
-  @ApiProperty({ description: 'Minutes after appointment finishes to send the wellness check', example: 1440 })
-  @IsInt()
-  @Min(1)
-  wellnessCheckDelayMinutes: number;
-
-  @ApiProperty({ description: 'Whether wellness check follow-up is enabled' })
-  @IsBoolean()
-  wellnessCheckEnabled: boolean;
-
-  // ---------------------------------------------------------------------------
-  // Return suggestion settings
-  // ---------------------------------------------------------------------------
-
-  @ApiProperty({ description: 'Minutes after appointment finishes to send the return suggestion', example: 2880 })
-  @IsInt()
-  @Min(1)
-  returnSuggestionDelayMinutes: number;
-
-  @ApiProperty({ description: 'Whether return suggestion follow-up is enabled' })
-  @IsBoolean()
-  returnSuggestionEnabled: boolean;
-
-  // ---------------------------------------------------------------------------
-  // WhatsApp Official template IDs (per follow-up type)
-  // ---------------------------------------------------------------------------
-
-  @ApiPropertyOptional({
-    description: 'WhatsApp Official template name for appointment confirmation follow-ups',
-    example: 'appointment_confirmation',
-  })
-  @IsOptional()
-  @IsString()
-  templateAppointmentConfirmation?: string;
-
-  @ApiPropertyOptional({
-    description: 'WhatsApp Official template name for satisfaction booking follow-ups',
-    example: 'satisfaction_booking',
-  })
-  @IsOptional()
-  @IsString()
-  templateSatisfactionBooking?: string;
-
-  @ApiPropertyOptional({
-    description: 'WhatsApp Official template name for satisfaction finished follow-ups',
-    example: 'satisfaction_finished',
-  })
-  @IsOptional()
-  @IsString()
-  templateSatisfactionFinished?: string;
-
-  @ApiPropertyOptional({
-    description: 'WhatsApp Official template name for no-show reschedule follow-ups',
-    example: 'no_show_reschedule',
-  })
-  @IsOptional()
-  @IsString()
-  templateNoShowReschedule?: string;
-
-  @ApiPropertyOptional({
-    description: 'WhatsApp Official template name for wellness check follow-ups',
-    example: 'wellness_check',
-  })
-  @IsOptional()
-  @IsString()
-  templateWellnessCheck?: string;
-
-  @ApiPropertyOptional({
-    description: 'WhatsApp Official template name for return suggestion follow-ups',
-    example: 'return_suggestion',
-  })
-  @IsOptional()
-  @IsString()
-  templateReturnSuggestion?: string;
-
-  @ApiPropertyOptional({
-    description: 'WhatsApp Official template name for abandonment follow-ups',
-    example: 'abandonment_followup',
-  })
-  @IsOptional()
-  @IsString()
-  templateAbandonment?: string;
-
-  // ---------------------------------------------------------------------------
-  // Global setting
-  // ---------------------------------------------------------------------------
-
-  @ApiProperty({ description: 'Whether abandonment follow-up is enabled for this tenant' })
-  @IsBoolean()
-  enabled: boolean;
-
-  @ApiProperty({
-    description:
-      'Minutes to send warning when attendant sent the last message and patient did not reply',
-    example: 5,
-  })
-  @IsInt()
-  @Min(1)
-  humanPatientIdleWarningDelayMinutes: number;
-
-  @ApiProperty({
-    description:
-      'Minutes after warning to finalize human attendance and return session to IA',
-    example: 10,
-  })
-  @IsInt()
-  @Min(1)
-  humanPatientIdleFinalizeDelayMinutes: number;
-
-  @ApiProperty({
-    description:
-      'Minutes to requeue when patient sent the last message and attendant did not reply',
-    example: 15,
-  })
-  @IsInt()
-  @Min(1)
-  humanAttendantIdleRequeueDelayMinutes: number;
-
-  @ApiProperty({
-    description:
-      'Minutes before requeue to send a push to the responsible attendant (0 = disabled). Must be less than humanAttendantIdleRequeueDelayMinutes when > 0.',
-    example: 3,
-  })
-  @IsInt()
-  @Min(0)
-  humanAttendantIdlePushWarningLeadMinutes: number;
-
-  @ApiProperty({
-    description: 'Message sent as warning when patient is idle during human attendance',
-    example:
-      'Ainda estamos aguardando sua resposta. Em alguns minutos, o atendimento humano sera finalizado caso nao haja retorno.',
-  })
-  @IsString()
-  @MaxLength(5000)
-  humanPatientIdleWarningMessage: string;
-
-  @ApiProperty({
-    description: 'Message sent when human attendance is finalized due to patient inactivity',
-    example:
-      'Como nao recebemos seu retorno, encerramos o atendimento humano por agora. Se precisar, posso continuar seu atendimento por IA.',
-  })
-  @IsString()
-  @MaxLength(5000)
-  humanPatientIdleFinalizeMessage: string;
-
-  @ApiProperty({
-    description: 'Message sent when session is requeued due to attendant inactivity',
-    example:
-      'Devido a alta demanda, outro atendente continuara seu atendimento em breve.',
-  })
-  @IsString()
-  @MaxLength(5000)
-  humanAttendantIdleRequeueMessage: string;
-
-  @ApiProperty({
-    description: 'Message sent when clinic is closed and session remains in waiting queue',
-    example:
-      'Nosso horario de atendimento foi encerrado. Retornaremos o contato no proximo dia util.',
-  })
-  @IsString()
-  @MaxLength(5000)
-  humanAfterHoursWaitingMessage: string;
-
-  @ApiProperty({
-    description:
-      'Message sent when patient requests human support outside clinic hours',
-    example:
-      'No momento estamos fora do horario de atendimento humano. Sua conversa foi para a fila e retornaremos no proximo dia util.',
-  })
-  @IsString()
-  @MaxLength(5000)
-  humanRequestOutsideHoursMessage: string;
-}
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+import {
+  IsBoolean,
+  IsInt,
+  IsNotEmpty,
+  IsOptional,
+  IsString,
+  MaxLength,
+  Min,
+} from 'class-validator';
+
+/**
+ * Represents a follow-up timing configuration for a tenant.
+ * Defines timing and enabled flags for all follow-up types:
+ * abandonment, appointment confirmation, satisfaction surveys,
+ * no-show reschedule, wellness check, and return suggestion.
+ */
+export class FollowupConfigResponseDto {
+  @ApiProperty({ description: 'Config primary key (UUID)' })
+  @IsString()
+  @IsNotEmpty()
+  id: string;
+
+  @ApiPropertyOptional({ description: 'Tenant unit id', example: 1 })
+  @IsOptional()
+  @IsInt()
+  @Min(1)
+  unitId?: number;
+
+  // ---------------------------------------------------------------------------
+  // Abandonment follow-up settings
+  // ---------------------------------------------------------------------------
+
+  @ApiProperty({
+    description: 'Minutes since last AI/human message to consider the session as abandoned',
+    example: 30,
+  })
+  @IsInt()
+  @Min(1)
+  abandonmentThresholdMinutes: number;
+
+  @ApiProperty({ description: 'Minutes to wait before sending follow-up #1 after abandonment', example: 5 })
+  @IsInt()
+  @Min(1)
+  followup1DelayMinutes: number;
+
+  @ApiProperty({ description: 'Minutes to wait before sending follow-up #2 after #1', example: 15 })
+  @IsInt()
+  @Min(1)
+  followup2DelayMinutes: number;
+
+  @ApiProperty({ description: 'Minutes to wait before sending follow-up #3 after #2', example: 60 })
+  @IsInt()
+  @Min(1)
+  followup3DelayMinutes: number;
+
+  @ApiProperty({ description: 'Minutes to wait before sending follow-up #4 after #3', example: 1440 })
+  @IsInt()
+  @Min(1)
+  followup4DelayMinutes: number;
+
+  @ApiProperty({ description: 'Minutes to wait before sending follow-up #5 (final) after #4', example: 2880 })
+  @IsInt()
+  @Min(1)
+  followup5DelayMinutes: number;
+
+  // ---------------------------------------------------------------------------
+  // Appointment confirmation settings
+  // ---------------------------------------------------------------------------
+
+  @ApiProperty({ description: 'Minutes before the appointment to send the confirmation reminder', example: 60 })
+  @IsInt()
+  @Min(1)
+  confirmationMinutesBefore: number;
+
+  @ApiProperty({ description: 'Whether appointment confirmation follow-up is enabled' })
+  @IsBoolean()
+  confirmationEnabled: boolean;
+
+  // ---------------------------------------------------------------------------
+  // Satisfaction survey settings
+  // ---------------------------------------------------------------------------
+
+  @ApiProperty({ description: 'Minutes after booking confirmation to send the satisfaction survey', example: 10 })
+  @IsInt()
+  @Min(1)
+  satisfactionBookingDelayMinutes: number;
+
+  @ApiProperty({ description: 'Whether satisfaction survey after booking is enabled' })
+  @IsBoolean()
+  satisfactionBookingEnabled: boolean;
+
+  @ApiProperty({ description: 'Minutes after appointment finishes to send the satisfaction survey', example: 30 })
+  @IsInt()
+  @Min(1)
+  satisfactionFinishedDelayMinutes: number;
+
+  @ApiProperty({ description: 'Whether satisfaction survey after finished appointment is enabled' })
+  @IsBoolean()
+  satisfactionFinishedEnabled: boolean;
+
+  // ---------------------------------------------------------------------------
+  // No-show reschedule settings
+  // ---------------------------------------------------------------------------
+
+  @ApiProperty({ description: 'Minutes after a no-show to send the reschedule follow-up', example: 60 })
+  @IsInt()
+  @Min(1)
+  noShowDelayMinutes: number;
+
+  @ApiProperty({ description: 'Whether no-show follow-up is enabled' })
+  @IsBoolean()
+  noShowEnabled: boolean;
+
+  // ---------------------------------------------------------------------------
+  // Wellness check settings
+  // ---------------------------------------------------------------------------
+
+  @ApiProperty({ description: 'Minutes after appointment finishes to send the wellness check', example: 1440 })
+  @IsInt()
+  @Min(1)
+  wellnessCheckDelayMinutes: number;
+
+  @ApiProperty({ description: 'Whether wellness check follow-up is enabled' })
+  @IsBoolean()
+  wellnessCheckEnabled: boolean;
+
+  // ---------------------------------------------------------------------------
+  // Return suggestion settings
+  // ---------------------------------------------------------------------------
+
+  @ApiProperty({ description: 'Minutes after appointment finishes to send the return suggestion', example: 2880 })
+  @IsInt()
+  @Min(1)
+  returnSuggestionDelayMinutes: number;
+
+  @ApiProperty({ description: 'Whether return suggestion follow-up is enabled' })
+  @IsBoolean()
+  returnSuggestionEnabled: boolean;
+
+  // ---------------------------------------------------------------------------
+  // WhatsApp Official template IDs (per follow-up type)
+  // ---------------------------------------------------------------------------
+
+  @ApiPropertyOptional({
+    description: 'WhatsApp Official template name for appointment confirmation follow-ups',
+    example: 'appointment_confirmation',
+  })
+  @IsOptional()
+  @IsString()
+  templateAppointmentConfirmation?: string;
+
+  @ApiPropertyOptional({
+    description: 'WhatsApp Official template name for satisfaction booking follow-ups',
+    example: 'satisfaction_booking',
+  })
+  @IsOptional()
+  @IsString()
+  templateSatisfactionBooking?: string;
+
+  @ApiPropertyOptional({
+    description: 'WhatsApp Official template name for satisfaction finished follow-ups',
+    example: 'satisfaction_finished',
+  })
+  @IsOptional()
+  @IsString()
+  templateSatisfactionFinished?: string;
+
+  @ApiPropertyOptional({
+    description: 'WhatsApp Official template name for no-show reschedule follow-ups',
+    example: 'no_show_reschedule',
+  })
+  @IsOptional()
+  @IsString()
+  templateNoShowReschedule?: string;
+
+  @ApiPropertyOptional({
+    description: 'WhatsApp Official template name for wellness check follow-ups',
+    example: 'wellness_check',
+  })
+  @IsOptional()
+  @IsString()
+  templateWellnessCheck?: string;
+
+  @ApiPropertyOptional({
+    description: 'WhatsApp Official template name for return suggestion follow-ups',
+    example: 'return_suggestion',
+  })
+  @IsOptional()
+  @IsString()
+  templateReturnSuggestion?: string;
+
+  @ApiPropertyOptional({
+    description: 'WhatsApp Official template name for abandonment follow-ups',
+    example: 'abandonment_followup',
+  })
+  @IsOptional()
+  @IsString()
+  templateAbandonment?: string;
+
+  // ---------------------------------------------------------------------------
+  // Global setting
+  // ---------------------------------------------------------------------------
+
+  @ApiProperty({ description: 'Whether abandonment follow-up is enabled for this tenant' })
+  @IsBoolean()
+  enabled: boolean;
+
+  @ApiProperty({
+    description:
+      'Minutes to send warning when attendant sent the last message and patient did not reply',
+    example: 5,
+  })
+  @IsInt()
+  @Min(1)
+  humanPatientIdleWarningDelayMinutes: number;
+
+  @ApiProperty({
+    description:
+      'Minutes after warning to finalize human attendance and return session to IA',
+    example: 10,
+  })
+  @IsInt()
+  @Min(1)
+  humanPatientIdleFinalizeDelayMinutes: number;
+
+  @ApiProperty({
+    description:
+      'Minutes to requeue when patient sent the last message and attendant did not reply',
+    example: 15,
+  })
+  @IsInt()
+  @Min(1)
+  humanAttendantIdleRequeueDelayMinutes: number;
+
+  @ApiProperty({
+    description:
+      'Minutes before requeue to send a push to the responsible attendant (0 = disabled). Must be less than humanAttendantIdleRequeueDelayMinutes when > 0.',
+    example: 3,
+  })
+  @IsInt()
+  @Min(0)
+  humanAttendantIdlePushWarningLeadMinutes: number;
+
+  @ApiProperty({
+    description: 'Message sent as warning when patient is idle during human attendance',
+    example:
+      'Ainda estamos aguardando sua resposta. Em alguns minutos, o atendimento humano sera finalizado caso nao haja retorno.',
+  })
+  @IsString()
+  @MaxLength(5000)
+  humanPatientIdleWarningMessage: string;
+
+  @ApiProperty({
+    description: 'Message sent when human attendance is finalized due to patient inactivity',
+    example:
+      'Como nao recebemos seu retorno, encerramos o atendimento humano por agora. Se precisar, posso continuar seu atendimento por IA.',
+  })
+  @IsString()
+  @MaxLength(5000)
+  humanPatientIdleFinalizeMessage: string;
+
+  @ApiProperty({
+    description: 'Message sent when session is requeued due to attendant inactivity',
+    example:
+      'Devido a alta demanda, outro atendente continuara seu atendimento em breve.',
+  })
+  @IsString()
+  @MaxLength(5000)
+  humanAttendantIdleRequeueMessage: string;
+
+  @ApiProperty({
+    description: 'Message sent when clinic is closed and session remains in waiting queue',
+    example:
+      'Nosso horario de atendimento foi encerrado. Retornaremos o contato no proximo dia util.',
+  })
+  @IsString()
+  @MaxLength(5000)
+  humanAfterHoursWaitingMessage: string;
+
+  @ApiProperty({
+    description:
+      'Message sent when patient requests human support outside clinic hours',
+    example:
+      'No momento estamos fora do horario de atendimento humano. Sua conversa foi para a fila e retornaremos no proximo dia util.',
+  })
+  @IsString()
+  @MaxLength(5000)
+  humanRequestOutsideHoursMessage: string;
+}