@veriko-mx/sdk 0.4.13 → 0.5.0

package/dist/esm/generated/openapi.d.ts

@@ -15,14 +15,16 @@ export interface paths {
          * @description Devuelve en una sola llamada todos los datos recabados del usuario
          *     autenticado:
          *
-         *     - **Perfil**: identificador, correo electrónico, nombre, rol, estado, zona
+         *     - **Perfil**: identificador, correo electrónico, nombre, estado, zona
          *       horaria e idioma.
          *     - **Datos de la clave de API**: el prefijo y los últimos 4 caracteres, nunca
          *       la clave.
          *     - **Datos de la suscripción**: el plan, el estado y el fin del periodo en
          *       curso.
          *     - **Estado de la autenticación de 2 factores (2FA)**.
-         *     - **Permisos del rol**: como lista plana de pares `resource:action`.
+         *     - **Autorización**: los permisos efectivos como lista plana de claves
+         *       como `validations.records.read`, si puede entrar al panel de administración y
+         *       sus roles vigentes con su ámbito.
          *     - **Resumen de notificaciones**: notificaciones sin leer, envío push y
          *       vínculo con Telegram.
          *
@@ -1171,7 +1173,8 @@ export interface paths {
          *
          *     - `operational`: Todos los chequeos pasan y la latencia es normal.
          *     - `degraded`: Problemas parciales — latencia elevada o errores
-         *       intermitentes.
+         *       intermitentes. Un aviso preventivo que no afecta las consultas (por
+         *       ejemplo, un certificado próximo a vencer) no produce `degraded`.
          *     - `down`: El servicio es por el momento inaccesible.
          *     - `unknown`: No hay datos de salud vigentes: aún no se ha ejecutado ningún
          *       chequeo, o el último es más viejo que tres veces `check_interval_seconds`
@@ -2206,6 +2209,25 @@ export interface components {
          * @example 2026-05-01T05:14:38Z
          */
         TimestampUTC: string;
+        /** @description Un rol vigente de la cuenta de usuario y el ámbito en el que lo tiene. Las asignaciones revocadas no aparecen. */
+        RoleAssignmentSummary: {
+            /**
+             * @description Clave del rol, con el prefijo de su plano: `platform.` para los roles del equipo y `org.` para los de una organización.
+             * @example org.owner
+             */
+            key: string;
+            /**
+             * @description Ámbito de la asignación — `platform`: Toda la plataforma; `organization`: Una organización.
+             * @example organization
+             * @enum {string}
+             */
+            scope_type: "platform" | "organization";
+            /**
+             * @description Identificador de la organización cuando `scope_type` es `organization`. `null` en el ámbito `platform`.
+             * @example b1e4a2c3-1234-4abc-8def-0000000000aa
+             */
+            scope_id: string | null;
+        };
         /** @description Conjunto consolidado del usuario autenticado que devuelve `GET /v1/users/me`: perfil, metadatos de la clave de API, suscripción activa, estado de la autenticación de 2 factores (2FA), permisos del rol y resumen de notificaciones en una sola llamada. */
         UserMeBundle: {
             /**
@@ -2225,12 +2247,6 @@ export interface components {
              * @example Carlos Lopez
              */
             name?: string;
-            /**
-             * @description Rol de la cuenta de usuario en la organización. Decide qué permisos tienen sus sesiones — `owner`: Es la titular; `admin`: La administra; `user`: La usa.
-             * @example user
-             * @enum {string}
-             */
-            role?: "owner" | "admin" | "user";
             /**
              * @description Estado de la cuenta de usuario — `active`: Permite operar con normalidad; `suspended`: Cuenta suspendida; `revoked`: Eliminada por el usuario.
              * @example active
@@ -2260,7 +2276,7 @@ export interface components {
              * @example 2026-01-15T08:00:00Z
              */
             created_at?: string;
-            /** @description Datos de la clave de API de la cuenta de usuario. Nunca contiene la clave completa: para eso está `POST /v1/users/me/api-key/reveal`, que exige la contraseña. */
+            /** @description Datos de la clave de API vigente de la cuenta de usuario, o `null` cuando no tiene ninguna. Nunca contiene la clave completa: para eso está `POST /v1/users/me/api-key/reveal`, que exige la contraseña. */
             api_key?: {
                 /**
                  * @description Primeros 8 caracteres de la clave de API.
@@ -2268,7 +2284,7 @@ export interface components {
                  */
                 prefix?: string;
                 /**
-                 * @description Últimos 4 caracteres de la clave de API, con los que se pinta enmascarada (`veriko_a1b2••••••f9c2`). `null` en las cuentas anteriores a ese campo, hasta que se rellena.
+                 * @description Últimos 4 caracteres de la clave de API, con los que se pinta enmascarada (`veriko_a1b2••••••f9c2`). `null` en las claves más antiguas, que no lo guardaron.
                  * @example f9c2
                  */
                 last_4?: string | null;
@@ -2330,8 +2346,15 @@ export interface components {
                  */
                 last_used_at?: string | null;
             };
-            /** @description Lista plana de permisos del rol asignado a la cuenta de usuario (en formato `resource:action`). */
+            /** @description Lista plana y ordenada de los permisos efectivos de la cuenta de usuario, con claves como `validations.records.read`: los que le dan sus roles en la plataforma y en su organización personal. */
             permissions?: string[];
+            /**
+             * @description `true` cuando la cuenta de usuario puede entrar al panel de administración.
+             * @example false
+             */
+            platform_access?: boolean;
+            /** @description Roles vigentes de la cuenta de usuario, con el ámbito de cada uno. */
+            roles?: components["schemas"]["RoleAssignmentSummary"][];
             /** @description Resumen de la cola de notificaciones del usuario. */
             notifications?: {
                 /**
@@ -3692,6 +3715,14 @@ export interface components {
         /** @description Respuesta de `POST /v1/beneficiaries` con el beneficiario en `data`. Devuelve `201` al crear un registro nuevo, y `200` cuando reactiva una cuenta archivada con el mismo `account_number`: Ahí `meta.reactivated` viene en `true`. */
         CreateBeneficiaryResponse: components["schemas"]["SuccessEnvelope"] & {
             data: components["schemas"]["Beneficiary"];
+            /** @description Metadatos del alta. */
+            meta?: {
+                /**
+                 * @description `true` cuando el alta reactivó una cuenta archivada con el mismo `account_number` y la respuesta es `200`. Un alta nueva (`201`) no lo incluye.
+                 * @example true
+                 */
+                reactivated?: boolean;
+            };
         };
         /** @description Cuerpo de `PUT /v1/beneficiaries/{id}`. Acepta envoltorio JSON:API `{ data: { attributes: {...} } }` o un objeto plano. Todos los campos son opcionales — solo se actualizan los presentes. Si el cuerpo no contiene ningún campo editable, el servidor responde `422 no_valid_fields`. Hay tres rutas de actualización. Con solo `label`, se sanea y se guarda. Con un `account_number` nuevo, se vuelven a derivar `account_type`, `bank_code` y `bank_name` con las mismas reglas que `POST /v1/beneficiaries`. Con solo `bank_code`, el cambio vale únicamente si el beneficiario es de tipo `phone`: En CLABE y tarjeta se ignora sin avisar—, y deja el evento de auditoría `beneficiary.phone_bank_updated` cuando el código cambia. */
         UpdateBeneficiaryRequest: {
@@ -4373,7 +4404,7 @@ export interface components {
         /** @description Estado público del servicio de verificación de Banxico, tal como lo devuelve `GET /v1/status/banxico`. Muestra el estado operativo actual y una explicación legible. */
         BanxicoPublicStatus: {
             /**
-             * @description Estado agregado del servicio de verificación de Banxico — `operational`: Todas las pruebas pasan y la latencia es normal; `degraded`: Problemas parciales (latencia elevada o errores intermitentes); `down`: Servicio inaccesible; `unknown`: no hay datos de salud vigentes, porque aún no se ha ejecutado ningún chequeo o porque el último tiene más de tres veces `check_interval_seconds` de antigüedad (el chequeo automático dejó de correr).
+             * @description Estado agregado del servicio de verificación de Banxico — `operational`: Todas las pruebas pasan y la latencia es normal; `degraded`: Problemas parciales (latencia elevada o errores intermitentes). Un aviso preventivo que no afecta las consultas —por ejemplo, un certificado próximo a vencer— no produce `degraded`: el servicio sigue operando con normalidad; `down`: Servicio inaccesible; `unknown`: no hay datos de salud vigentes, porque aún no se ha ejecutado ningún chequeo o porque el último tiene más de tres veces `check_interval_seconds` de antigüedad (el chequeo automático dejó de correr).
              * @example operational
              * @enum {string}
              */