shori-sdk-ts 1.0.1

package/src/modules/caso/dto/request/addCommentRequest.ts

@@ -0,0 +1,150 @@
+/**
+ * Request para agregar un comentario a un caso en Shori.
+ *
+ * Usa el patrón Builder para construir instancias de forma fluida.
+ * Los campos son inmutables (`readonly`) una vez construidos.
+ *
+ * @example
+ * ```ts
+ * // Comentario básico
+ * const request = AddCommentRequest.builder()
+ *   .casoId("a1b2c3d4-e5f6-7890-abcd-ef1234567890")
+ *   .comment("El cliente confirmó su disponibilidad.")
+ *   .build();
+ *
+ * await client.caso().comment().add(request);
+ *
+ * // Comentario con origen y tarea
+ * const request = AddCommentRequest.builder()
+ *   .casoId("caso-uuid")
+ *   .comment("Nota asociada a tarea de revisión.")
+ *   .origin("TAREA")
+ *   .taskId("tarea-uuid")
+ *   .build();
+ * ```
+ */
+export class AddCommentRequest {
+  /** UUID del caso al que se agrega el comentario */
+  readonly casoId: string;
+  /** Texto del comentario */
+  readonly comment: string;
+  /** Origen del comentario. Por defecto: `"CASO"` */
+  readonly origin: string;
+  /** UUID de la tarea asociada (opcional) */
+  readonly taskId?: string;
+  /** Identificador interno (opcional) */
+  readonly internal?: string;
+
+  /** @internal — usar {@link AddCommentRequest.builder()} */
+  private constructor(builder: _AddCommentRequestBuilder) {
+    this.casoId = builder._casoId!;
+    this.comment = builder._comment!;
+    this.origin = builder._origin;
+    this.taskId = builder._taskId;
+    this.internal = builder._internal;
+  }
+
+  /**
+   * Crea un nuevo Builder para construir una instancia de `AddCommentRequest`.
+   *
+   * @example
+   * ```ts
+   * const request = AddCommentRequest.builder()
+   *   .casoId("caso-uuid")
+   *   .comment("Comentario del caso.")
+   *   .build();
+   * ```
+   */
+  static builder(): _AddCommentRequestBuilder {
+    return new _AddCommentRequestBuilder();
+  }
+
+  // Permite acceso interno desde el Builder
+  static _create(b: _AddCommentRequestBuilder): AddCommentRequest {
+    return new AddCommentRequest(b);
+  }
+}
+
+/**
+ * Builder fluido para `AddCommentRequest`.
+ *
+ * Obtén una instancia con `AddCommentRequest.builder()`.
+ */
+export class _AddCommentRequestBuilder {
+  /** @internal */
+  _casoId?: string;
+  /** @internal */
+  _comment?: string;
+  /** @internal */
+  _origin = "CASO";
+  /** @internal */
+  _taskId?: string;
+  /** @internal */
+  _internal?: string;
+
+  /**
+   * UUID del caso al que se agrega el comentario. **Requerido.**
+   *
+   * @param value - UUID del caso
+   */
+  casoId(value: string): this {
+    this._casoId = value;
+    return this;
+  }
+
+  /**
+   * Texto del comentario. **Requerido.**
+   *
+   * @param value - Texto del comentario
+   */
+  comment(value: string): this {
+    this._comment = value;
+    return this;
+  }
+
+  /**
+   * Origen del comentario. Por defecto: `"CASO"`.
+   *
+   * @param value - Origen (ej: `"TAREA"`, `"CASO"`)
+   */
+  origin(value: string): this {
+    this._origin = value;
+    return this;
+  }
+
+  /**
+   * UUID de la tarea asociada al comentario. Opcional.
+   *
+   * @param value - UUID de la tarea
+   */
+  taskId(value: string): this {
+    this._taskId = value;
+    return this;
+  }
+
+  /**
+   * Identificador interno. Opcional.
+   *
+   * @param value - Valor interno
+   */
+  internal(value: string): this {
+    this._internal = value;
+    return this;
+  }
+
+  /**
+   * Valida los campos requeridos y construye la instancia de `AddCommentRequest`.
+   *
+   * @throws Error si `casoId` o `comment` no están especificados
+   * @returns Instancia inmutable de `AddCommentRequest`
+   */
+  build(): AddCommentRequest {
+    if (!this._casoId?.trim())
+      throw new Error('casoId es requerido. Usa .casoId("uuid-del-caso")');
+    if (!this._comment?.trim())
+      throw new Error(
+        'comment es requerido. Usa .comment("texto del comentario")',
+      );
+    return AddCommentRequest._create(this);
+  }
+}

package/src/modules/caso/dto/request/casoCreateRequest.ts

@@ -0,0 +1,258 @@
+import { z } from "zod";
+
+// ── Schema de validación Zod ──────────────────────────────────────────────────
+
+/**
+ * Schema Zod para `CasoCreateRequest`.
+ *
+ * Se puede usar también para validar datos externos.
+ *
+ * @example
+ * ```ts
+ * const result = CasoCreateRequestSchema.safeParse({
+ *   casoTypeId: "tipo-uuid",
+ *   formId: "form-uuid",
+ *   priority: "prioridad-uuid",
+ * });
+ * if (!result.success) {
+ *   console.error(result.error.issues);
+ * }
+ * ```
+ */
+export const CasoCreateRequestSchema = z.object({
+  /** UUID del tipo de caso (producto). Requerido. */
+  casoTypeId: z
+    .string({ error: "casoTypeId es requerido" })
+    .min(1, "casoTypeId no puede estar vacío"),
+
+  /** UUID del formulario. Requerido. */
+  formId: z
+    .string({ error: "formId es requerido" })
+    .min(1, "formId no puede estar vacío"),
+
+  /** UUID de la prioridad. Requerido. */
+  priority: z
+    .string({ error: "priority es requerido" })
+    .min(1, "priority no puede estar vacío"),
+
+  /** ID externo opcional. */
+  externalId: z.string().optional(),
+
+  /** ¿Es urgente? Por defecto: false. */
+  isUrgent: z.boolean().default(false),
+
+  /** Nivel de grupo. Por defecto: 1. */
+  groupLevel: z.number().int("groupLevel debe ser un entero").min(1).default(1),
+
+  /** Datos del formulario como mapa clave-valor. Por defecto: `{}`. */
+  submittedData: z.record(z.string(), z.unknown()).default({}),
+});
+
+/** Tipo inferido del schema */
+export type CasoCreateRequestData = z.infer<typeof CasoCreateRequestSchema>;
+
+// ── Clase principal ───────────────────────────────────────────────────────────
+
+/**
+ * Request para crear un nuevo caso en Shori.
+ *
+ * Usa el patrón Builder con validación Zod en `build()`.
+ * Los campos `casoTypeId`, `formId` y `priority` son **requeridos**.
+ *
+ * @example
+ * ```ts
+ * // Creación básica
+ * const request = CasoCreateRequest.builder()
+ *   .casoTypeId("tipo-uuid")
+ *   .formId("form-uuid")
+ *   .priority("prioridad-uuid")
+ *   .build();
+ *
+ * const result = await client.caso().create(request);
+ * console.log(result.casoId); // UUID del caso creado
+ *
+ * // Con datos del formulario
+ * const request = CasoCreateRequest.builder()
+ *   .casoTypeId("tipo-uuid")
+ *   .formId("form-uuid")
+ *   .priority("prioridad-uuid")
+ *   .submittedData({
+ *     nombreCliente: "Ana García",
+ *     telefono: "+51987654321",
+ *   })
+ *   .isUrgent(true)
+ *   .groupLevel(2)
+ *   .externalId("EXT-001")
+ *   .build();
+ * ```
+ */
+export class CasoCreateRequest {
+  /** UUID del tipo de caso (producto) */
+  readonly casoTypeId: string;
+  /** UUID del formulario */
+  readonly formId: string;
+  /** UUID de la prioridad */
+  readonly priority: string;
+  /** ID externo opcional */
+  readonly externalId?: string;
+  /** ¿Es urgente? Por defecto: false */
+  readonly isUrgent: boolean;
+  /** Nivel de grupo. Por defecto: 1 */
+  readonly groupLevel: number;
+  /** Datos del formulario. Por defecto: `{}` */
+  readonly submittedData: Record<string, unknown>;
+
+  /** @internal — usar {@link CasoCreateRequest.builder()} */
+  private constructor(data: CasoCreateRequestData) {
+    this.casoTypeId = data.casoTypeId;
+    this.formId = data.formId;
+    this.priority = data.priority;
+    this.externalId = data.externalId;
+    this.isUrgent = data.isUrgent;
+    this.groupLevel = data.groupLevel;
+    this.submittedData = data.submittedData;
+  }
+
+  /**
+   * Crea un nuevo Builder para construir una instancia de `CasoCreateRequest`.
+   *
+   * @example
+   * ```ts
+   * const request = CasoCreateRequest.builder()
+   *   .casoTypeId("tipo-uuid")
+   *   .formId("form-uuid")
+   *   .priority("prioridad-uuid")
+   *   .build();
+   * ```
+   */
+  static builder(): _CasoCreateRequestBuilder {
+    return new _CasoCreateRequestBuilder();
+  }
+
+  /** @internal */
+  static _create(data: CasoCreateRequestData): CasoCreateRequest {
+    return new CasoCreateRequest(data);
+  }
+}
+
+// ── Builder ───────────────────────────────────────────────────────────────────
+
+/**
+ * Builder fluido para `CasoCreateRequest`.
+ *
+ * La validación ocurre en `build()` usando Zod — lanza `ZodError` con
+ * mensajes detallados si algún campo requerido falta o es inválido.
+ *
+ * Obtén una instancia con `CasoCreateRequest.builder()`.
+ */
+export class _CasoCreateRequestBuilder {
+  private _casoTypeId?: string;
+  private _formId?: string;
+  private _priority?: string;
+  private _externalId?: string;
+  private _isUrgent?: boolean;
+  private _groupLevel?: number;
+  private _submittedData?: Record<string, unknown>;
+
+  /**
+   * UUID del tipo de caso (producto). **Requerido.**
+   *
+   * @param value - UUID del tipo de caso
+   */
+  casoTypeId(value: string): this {
+    this._casoTypeId = value;
+    return this;
+  }
+
+  /**
+   * UUID del formulario. **Requerido.**
+   *
+   * @param value - UUID del formulario
+   */
+  formId(value: string): this {
+    this._formId = value;
+    return this;
+  }
+
+  /**
+   * UUID de la prioridad. **Requerido.**
+   *
+   * @param value - UUID de la prioridad
+   */
+  priority(value: string): this {
+    this._priority = value;
+    return this;
+  }
+
+  /**
+   * ID externo del caso. Opcional.
+   *
+   * @param value - ID externo
+   */
+  externalId(value: string): this {
+    this._externalId = value;
+    return this;
+  }
+
+  /**
+   * Indica si el caso es urgente. Por defecto: `false`.
+   *
+   * @param value - `true` si es urgente
+   */
+  isUrgent(value: boolean): this {
+    this._isUrgent = value;
+    return this;
+  }
+
+  /**
+   * Nivel de grupo. Por defecto: `1`.
+   *
+   * @param value - Nivel de grupo (entero ≥ 1)
+   */
+  groupLevel(value: number): this {
+    this._groupLevel = value;
+    return this;
+  }
+
+  /**
+   * Datos del formulario como mapa clave-valor. Por defecto: `{}`.
+   *
+   * @param value - Campos del formulario
+   */
+  submittedData(value: Record<string, unknown>): this {
+    this._submittedData = value;
+    return this;
+  }
+
+  /**
+   * Valida todos los campos con Zod y construye la instancia.
+   *
+   * Lanza `ZodError` con mensajes detallados si algún campo requerido falta.
+   *
+   * @throws {z.ZodError} si algún campo no pasa la validación
+   * @returns Instancia inmutable de `CasoCreateRequest`
+   *
+   * @example
+   * ```ts
+   * try {
+   *   CasoCreateRequest.builder().build(); // falta casoTypeId, formId, priority
+   * } catch (err) {
+   *   if (err instanceof z.ZodError) {
+   *     err.issues.forEach(i => console.error(i.path[0], i.message));
+   *   }
+   * }
+   * ```
+   */
+  build(): CasoCreateRequest {
+    const data = CasoCreateRequestSchema.parse({
+      casoTypeId: this._casoTypeId,
+      formId: this._formId,
+      priority: this._priority,
+      externalId: this._externalId,
+      isUrgent: this._isUrgent,
+      groupLevel: this._groupLevel,
+      submittedData: this._submittedData,
+    });
+    return CasoCreateRequest._create(data);
+  }
+}

package/src/modules/caso/dto/request/casoFileUpdateRequest.ts

@@ -0,0 +1,20 @@
+/**
+ * Request para actualizar los metadatos de un archivo adjunto.
+ *
+ * @example
+ * ```ts
+ * await client.caso().files().update({
+ *   id: "archivo-uuid",
+ *   isValid: true,
+ *   isDeleted: false,
+ * });
+ * ```
+ */
+export interface CasoFileUpdateRequest {
+  /** UUID del archivo adjunto. Requerido. */
+  id: string;
+  /** Indica si el archivo es válido */
+  isValid?: boolean;
+  /** UUID de la categoría del archivo */
+  categoryId?: string;
+}

package/src/modules/caso/dto/request/casoUpdateRequest.ts

@@ -0,0 +1,251 @@
+import { z } from "zod";
+
+// ── Schema de validación Zod ──────────────────────────────────────────────────
+
+/**
+ * Schema Zod para `CasoUpdateRequest`.
+ *
+ * Se puede usar también para validar datos externos.
+ *
+ * @example
+ * ```ts
+ * const result = CasoUpdateRequestSchema.safeParse({
+ *   id: "caso-uuid",
+ *   priority: "prioridad-uuid",
+ *   formId: "form-uuid",
+ * });
+ * if (!result.success) {
+ *   console.error(result.error.issues);
+ * }
+ * ```
+ */
+export const CasoUpdateRequestSchema = z.object({
+  /** UUID del caso a actualizar. Requerido. */
+  id: z.string({ error: "id es requerido" }).min(1, "id no puede estar vacío"),
+
+  /** UUID de la prioridad. Requerido. */
+  priority: z
+    .string({ error: "priority es requerido" })
+    .min(1, "priority no puede estar vacío"),
+
+  /** UUID del formulario. Requerido. */
+  formId: z
+    .string({ error: "formId es requerido" })
+    .min(1, "formId no puede estar vacío"),
+
+  /** ¿Es urgente? Por defecto: false. */
+  isUrgent: z.boolean().default(false),
+
+  /** UUID del usuario a asignar al caso. Opcional. */
+  assignedUserId: z.string().optional(),
+
+  /** Datos del formulario a actualizar. Opcional. */
+  submittedData: z.record(z.string(), z.unknown()).optional(),
+
+  /** ID externo opcional. */
+  externalId: z.string().optional(),
+});
+
+/** Tipo inferido del schema */
+export type CasoUpdateRequestData = z.infer<typeof CasoUpdateRequestSchema>;
+
+// ── Clase principal ───────────────────────────────────────────────────────────
+
+/**
+ * Request para actualizar un caso existente en Shori.
+ *
+ * Usa el patrón Builder con validación Zod en `build()`.
+ * Los campos `id`, `priority` y `formId` son **requeridos**.
+ *
+ * @example
+ * ```ts
+ * // Actualización básica
+ * const request = CasoUpdateRequest.builder()
+ *   .id("caso-uuid")
+ *   .priority("prioridad-uuid")
+ *   .formId("form-uuid")
+ *   .build();
+ *
+ * await client.caso().update(request);
+ *
+ * // Con datos del formulario
+ * const request = CasoUpdateRequest.builder()
+ *   .id("caso-uuid")
+ *   .priority("prioridad-uuid")
+ *   .formId("form-uuid")
+ *   .submittedData({ observaciones: "Cliente contactado el 2024-01-15" })
+ *   .isUrgent(true)
+ *   .assignedUserId("usuario-uuid")
+ *   .build();
+ * ```
+ */
+export class CasoUpdateRequest {
+  /** UUID del caso a actualizar */
+  readonly id: string;
+  /** UUID de la prioridad */
+  readonly priority: string;
+  /** UUID del formulario */
+  readonly formId: string;
+  /** ¿Es urgente? Por defecto: false */
+  readonly isUrgent: boolean;
+  /** UUID del usuario asignado (opcional) */
+  readonly assignedUserId?: string;
+  /** Datos del formulario a actualizar (opcional) */
+  readonly submittedData?: Record<string, unknown>;
+  /** ID externo (opcional) */
+  readonly externalId?: string;
+
+  /** @internal — usar {@link CasoUpdateRequest.builder()} */
+  private constructor(data: CasoUpdateRequestData) {
+    this.id = data.id;
+    this.priority = data.priority;
+    this.formId = data.formId;
+    this.isUrgent = data.isUrgent;
+    this.assignedUserId = data.assignedUserId;
+    this.submittedData = data.submittedData;
+    this.externalId = data.externalId;
+  }
+
+  /**
+   * Crea un nuevo Builder para construir una instancia de `CasoUpdateRequest`.
+   *
+   * @example
+   * ```ts
+   * const request = CasoUpdateRequest.builder()
+   *   .id("caso-uuid")
+   *   .priority("prioridad-uuid")
+   *   .formId("form-uuid")
+   *   .build();
+   * ```
+   */
+  static builder(): _CasoUpdateRequestBuilder {
+    return new _CasoUpdateRequestBuilder();
+  }
+
+  /** @internal */
+  static _create(data: CasoUpdateRequestData): CasoUpdateRequest {
+    return new CasoUpdateRequest(data);
+  }
+}
+
+// ── Builder ───────────────────────────────────────────────────────────────────
+
+/**
+ * Builder fluido para `CasoUpdateRequest`.
+ *
+ * La validación ocurre en `build()` usando Zod — lanza `ZodError` con
+ * mensajes detallados si algún campo requerido falta o es inválido.
+ *
+ * Obtén una instancia con `CasoUpdateRequest.builder()`.
+ */
+export class _CasoUpdateRequestBuilder {
+  private _id?: string;
+  private _priority?: string;
+  private _formId?: string;
+  private _isUrgent?: boolean;
+  private _assignedUserId?: string;
+  private _submittedData?: Record<string, unknown>;
+  private _externalId?: string;
+
+  /**
+   * UUID del caso a actualizar. **Requerido.**
+   *
+   * @param value - UUID del caso
+   */
+  id(value: string): this {
+    this._id = value;
+    return this;
+  }
+
+  /**
+   * UUID de la prioridad. **Requerido.**
+   *
+   * @param value - UUID de la prioridad
+   */
+  priority(value: string): this {
+    this._priority = value;
+    return this;
+  }
+
+  /**
+   * UUID del formulario. **Requerido.**
+   *
+   * @param value - UUID del formulario
+   */
+  formId(value: string): this {
+    this._formId = value;
+    return this;
+  }
+
+  /**
+   * Indica si el caso es urgente. Por defecto: `false`.
+   *
+   * @param value - `true` si es urgente
+   */
+  isUrgent(value: boolean): this {
+    this._isUrgent = value;
+    return this;
+  }
+
+  /**
+   * UUID del usuario a asignar al caso. Opcional.
+   *
+   * @param value - UUID del usuario
+   */
+  assignedUserId(value: string): this {
+    this._assignedUserId = value;
+    return this;
+  }
+
+  /**
+   * Datos del formulario a actualizar como mapa clave-valor. Opcional.
+   *
+   * @param value - Campos del formulario
+   */
+  submittedData(value: Record<string, unknown>): this {
+    this._submittedData = value;
+    return this;
+  }
+
+  /**
+   * ID externo del caso. Opcional.
+   *
+   * @param value - ID externo
+   */
+  externalId(value: string): this {
+    this._externalId = value;
+    return this;
+  }
+
+  /**
+   * Valida todos los campos con Zod y construye la instancia.
+   *
+   * Lanza `ZodError` con mensajes detallados si algún campo requerido falta.
+   *
+   * @throws {z.ZodError} si algún campo no pasa la validación
+   * @returns Instancia inmutable de `CasoUpdateRequest`
+   *
+   * @example
+   * ```ts
+   * try {
+   *   CasoUpdateRequest.builder().build(); // falta id, priority, formId
+   * } catch (err) {
+   *   if (err instanceof z.ZodError) {
+   *     err.issues.forEach(i => console.error(i.path[0], i.message));
+   *   }
+   * }
+   * ```
+   */
+  build(): CasoUpdateRequest {
+    const data = CasoUpdateRequestSchema.parse({
+      id: this._id,
+      priority: this._priority,
+      formId: this._formId,
+      isUrgent: this._isUrgent,
+      assignedUserId: this._assignedUserId,
+      submittedData: this._submittedData,
+      externalId: this._externalId,
+    });
+    return CasoUpdateRequest._create(data);
+  }
+}