Tipos

Los tipos los exporta @vimine/sdk (y /server) y reflejan el documento OpenAPI: los nombres de campo son los del JSON. Las formas completas están en la referencia de la API; aquí, las principales.

Permisos y estados

type Scope =
    | 'profile:read' | 'profile:write'
    | 'membership:read' | 'membership:request' | 'statuto:accept' | 'network:manage'
    | 'memberships:read' | 'verify:read'
    | 'identity:signup' | 'enroll:write' | 'checkins:write' | 'webhooks:manage'
    | 'events:read' | 'registrations:read' | 'registrations:write';

type MembershipStatus = 'pending' | 'active' | 'suspended' | 'revoked' | 'rejected';
/** Lo que vale el carné ahora mismo. */
type MembershipVerdict = 'valid' | 'expired' | 'not_yet_valid' | 'statuto_required' | 'inactive';

El socio

interface Me {
    sub: string;                  // identificador para tu asociación (vms_…)
    email: string;
    email_verified: boolean;
    first_name: string | null;
    last_name: string | null;
    phone: string | null;
    dob: string | null;           // YYYY-MM-DD
    gender: 'M' | 'F' | null;     // solo demográfico: no se coteja con el código
    birthplace: string | null;    // comune (nacidos en Italia) o ciudad, texto libre (nacidos en el extranjero)
    birth_country: string | null; // ISO 3166-1 alpha-2
    codicefiscale: string | null; // opcional: una persona puede no tenerlo
    codicefiscale_check: CodiceFiscaleCheck | null;   // cómo está identificada la persona; null = todavía no
    locale: Locale | null;        // el idioma que eligió la persona; null = nunca elegido
    updated_at: string | null;
}

/** Un idioma que habla Vimine. Donde la API acepta uno, acepta también una etiqueta regional (`en-GB` → `en`, `zh-TW` → `zh-Hant`) y la reduce. */
type Locale = 'it' | 'en' | 'zh-Hans' | 'zh-Hant' | 'fr' | 'es' | 'de' | 'pt-BR';
interface LocaleParam { locale?: Locale | string }   // ?locale= de las lecturas — consulta la guía Idiomas

/** Cómo se identifica una persona: con un código fiscal O con la fecha, el lugar y el país de nacimiento — nunca sin ninguno. */
type CodiceFiscaleCheck = 'matched' | 'mismatch_confirmed' | 'absent';

interface MeUpdate {              // PATCH /v1/me
    phone?: string | null;
    dob?: string | null;
    gender?: 'M' | 'F' | null;
    birthplace?: string | null;
    birth_country?: string | null;            // ISO 3166-1 alpha-2
    codicefiscale?: string | null;            // se puede añadir más tarde, o volver a poner a null
    codicefiscale_confirmed?: boolean;        // solo escritura: la persona confirma un código que no coincide (después de un `confirmable: true`)
    locale?: Locale | null;                   // null borra la elección; 422 `unsupported` para un idioma que Vimine no habla
}

El carné

interface Membership {
    id: string;
    status: MembershipStatus;
    verdict: MembershipVerdict;
    subdate: string | null;
    issued_at: string | null;
    expires_at: string | null;
    membership_type: { uid: string; cod: string; name: string } | null;
    statuto: {
        current_version: number | null;
        current_sha256: string | null;
        accepted_version_id: string | null;
        accepted_at: string | null;
        pending: boolean;         // se ha publicado un estatuto más reciente desde que el socio aceptó uno
        overdue: boolean;         // … y ha vencido el plazo para volver a aceptarlo
    };
    pending_reasons: Array<'approval' | 'payment'>;   // por qué sigue pendiente, en orden: la admisión, luego la cuota
    payment_open: boolean;        // ¿se puede pagar ya la cuota? (la admisión abre el pago)
    valid_from: string | null;    // cuándo se podrá usar el carné (el intervalo de la asociación)
    usable: boolean;              // el carné vale en la entrada ahora mismo
    quota: { amount: number; currency: string; paid: boolean } | null;
    payment_instructions: string | null;
    expires_in_days: number | null;
    renewal: { window_open: boolean; requested_at: string | null };   // renovación por cuenta propia: abierta 60 días antes de la caducidad
    network_opt_in: boolean;
    card: { token: string; nbf: number; exp: number } | null;   // el token vmt_… del QR y su ventana (unix s)
}

interface Card { token: string; nbf: number; exp: number; status: MembershipStatus }

interface MembershipRequest {     // POST /v1/me/membership
    membership_type?: string;     // uid; opcional cuando la asociación ofrece exactamente uno
    accept_statuto: { version: number; sha256?: string };
}
type MembershipRequestResult =
    | { created: true; status: 'pending'; id: string }
    | { already_requested: true; status: MembershipStatus };

interface MembershipEvents {
    items: Array<{ from: MembershipStatus | null; to: MembershipStatus; reason: string | null; changed_at: string; channel: string }>;
    next_cursor: string | null;
}

interface StatutoInfo {
    uid: string;
    version: number;
    approvaldate: string | null;
    sha256: string | null;
    content: string | null;
    document_url: string | null;
    accepted: boolean;
    accepted_at: string | null;
    overdue: boolean;
}

interface Connection {
    client_id: string;
    name: string;
    kind: 'public' | 'native' | 'confidential' | 'first_party';
    scopes: Scope[];
    granted_at: string;
}

Públicos

interface Verification {
    status: 'active' | 'inactive';
    valid_until?: string;
    valid_from?: string;          // con reason 'not_yet_valid': el carné es auténtico y está activo, y se puede usar a partir de aquí
    reason?: 'expired' | 'invalid' | 'not_yet_valid';
}

type AdmissionModel = 'board' | 'provisional' | 'automatic';   // cómo admite la asociación a sus socios

interface AssociationPublicConfig {
    aps: {
        slug: string; name: string;
        picture_url: string | null;
        citta: string | null; provincia: string | null;
        enroll_enabled: boolean;
        accepting_requests: boolean;  // la inscripción está activa Y hay sitio para un socio más, ahora mismo
        invitation_only: boolean;     // beta privada: solo admite a las personas que ha invitado (accepting_requests es false)
        // cómo admite la asociación a sus socios — díselo de antemano a quien solicita. board: decide la junta, la cuota después;
        // provisional: admitido enseguida, ratificado más tarde; automatic: activo en cuanto se cumplen las condiciones.
        // delay_hours: horas entre la admisión y un carné QUE SE PUEDE USAR (0 = de inmediato)
        admission: { model: AdmissionModel; delay_hours: number };
        approval_required: boolean;   // obsoleto: true cuando admission.model es 'board' — lee `admission`
        payment_instructions: string | null;   // cómo pagar la cuota, cuando la asociación lo ha publicado
        member_address: MemberAddressPolicy;   // si la asociación recoge la dirección de sus socios — de todos o de ninguno
        // actividades de interés general (art. 5 del Código del Tercer Sector): letra, texto, cuál es la principal
        activity_sectors: Array<{ cod: string; description: string; prevalent: boolean }>;
        // inscrita en el RUNTS según las listas oficiales; si no, null
        registry: {
            section: 'APS' | 'ODV' | 'EF' | 'IS' | 'RA' | 'SOMS' | 'ALTRI' | null;
            number: string | null; registered_on: string | null; checked_on: string | null;
        } | null;
    };
    membership_types: Array<{
        uid: string; cod: string; name: string; description: string | null;
        quota_amount: number | null; currency: string;
        expiry_model: 'solar_year' | 'rolling_12' | 'rolling_24' | 'prorated_solar' | 'custom';
        network_eligible: boolean;
    }>;
    statuto: { uid: string; version: number; approvaldate: string | null; sha256: string | null; content: string | null; document_url: string | null } | null;
}

type MemberAddressPolicy = 'none' | 'optional' | 'required';

interface FiscalCodeCheck {
    code: string; first_name?: string; last_name?: string; gender?: 'M' | 'F'; date?: string; place?: string;
    country?: string;             // país de nacimiento: para una persona nacida en el extranjero el código solo contiene el país, y `place` no se compara
}
type FiscalCodeMismatch = 'lastName' | 'firstName' | 'gender' | 'date' | 'place';
type FiscalCodeHint = 'names_swapped';
interface FiscalCodeResult {
    valid: boolean;
    error: 'invalid' | 'mismatch' | null;     // 'invalid': estructura o carácter de control; 'mismatch': no coincide con los datos enviados
    mismatches: FiscalCodeMismatch[];
    hints: FiscalCodeHint[];
    birth_date: string | null;    // la fecha de nacimiento que contiene el código (YYYY-MM-DD)
    birth_country: string | null; // el país de nacimiento que contiene el código (IT para un comune)
}

interface CardKeys { keys: Array<{ kty: string; crv: string; x: string; kid: string; use: string; alg: string }> }

Clientes confidenciales

interface MembershipStatusInfo {  // GET /v1/memberships/{id}/status
    id: string;
    status: MembershipStatus;
    verdict: MembershipVerdict;
    valid_until: string | null;
    membership_type: { cod: string } | null;
}

interface SignupInput {           // POST /v1/signup
    email: string;
    first_name: string;
    last_name: string;
    phone?: string | null;
    dob?: string | null;          // YYYY-MM-DD
    gender?: 'M' | 'F' | null;
    birthplace?: string | null;
    birth_country?: string | null;            // ISO 3166-1 alpha-2 — para una persona nacida en el extranjero: el código solo contiene el país
    codicefiscale?: string | null;
    codicefiscale_confirmed?: boolean;        // la persona confirma un código que no coincide (422 `codicefiscale_mismatch` con `confirmable: true`)
    accept_terms?: LegalRef;                  // las condiciones de la cuenta aceptadas en tu sitio — opcional, la versión en vigor
    acknowledge_privacy?: LegalRef;           // la política de privacidad de la plataforma leída en tu sitio — opcional, misma regla
}
interface EnrollInput extends SignupInput {   // POST /v1/enroll
    codicefiscale?: string | null;            // opcional: un código fiscal O dob + birthplace + birth_country, nunca sin ninguno
    address?: MemberAddress;                  // residencia o domicilio, cuando `aps.member_address` no es `none`
    membership_type?: string;     // opcional cuando hay exactamente un tipo
    accept_statuto: { version: number; sha256?: string };
    privacy_notice?: { version: number; sha256?: string };   // obligatorio cuando la asociación publica una política
}
interface MemberAddress {
    kind?: 'residence' | 'domicile';          // por defecto 'residence'
    line: string;                 // calle y número
    postal_code?: string | null;
    city: string;
    province?: string | null;     // solo direcciones italianas (dos letras)
    country?: string;             // ISO 3166-1 alpha-2, por defecto 'IT'
}
interface EnrollIdentification {  // POST /v1/enroll/confirm después de un 409 identification_required
    dob?: string; birthplace?: string; birth_country?: string; codicefiscale?: string; codicefiscale_confirmed?: boolean;
}
interface CardCheckinResult {     // POST /v1/checkins para un carné
    kind: 'card';
    verdict: MembershipVerdict;
    status: MembershipStatus;
    membership_id: string;
    valid_until: string | null;
    valid_from: string | null;
    identity_check: IdentityCheck | null;     // una nota para quien atiende la entrada: no forma parte de `verdict`, no restringe nada
    checked_in_at: string;
}
/** 'pending': todavía hay que mirar un documento; 'verified': mirado; 'flagged': mirado, y no coincidía. */
type IdentityCheck = 'pending' | 'verified' | 'flagged';
interface FieldError {            // una entrada de `VimineError.errors`
    field?: string; code?: string; message?: string;
    mismatches?: FiscalCodeMismatch[]; hints?: FiscalCodeHint[]; confirmable?: boolean;   // solo `codicefiscale_mismatch`
}
interface LegalRef { version: string; sha256?: string }      // accept_terms / acknowledge_privacy (opcional, versión en vigor)
interface MyAcceptances {         // GET /v1/me/acceptances (legal:read)
    items: AcceptanceRecord[];    // at, action, channel, kind, title, version, sha256, rendered_sha256, locale, association
    pending: { platform: PendingDocument[]; privacy_notice: PendingDocument | null };
}
interface AcceptanceInput { kind: string; version: string | number; sha256?: string }   // POST /v1/me/acceptances (legal:accept)
interface Accepted { status: 'accepted' }     // la respuesta, siempre la misma
interface EnrollConfirmResult {  // POST /v1/enroll/confirm
    status: MembershipStatus;
    already: boolean;             // ya tenía una inscripción o una solicitud
    pending_reasons: Array<'approval' | 'payment'>;   // en orden: primero la admisión, luego la cuota
    payment_open: boolean;
    valid_from: string | null;
    association: { name: string; slug: string };
    event?: EnrolledPlace | null; // solo para un enlace que empezó en la página de inscripción abierta desde un evento: qué ha pasado con la plaza
}
interface EnrolledPlace {        // la plaza solicitada junto con la solicitud de inscripción (guía Eventos › Quien aún no es socio)
    slug: string; title: string; starts_at: string; timezone: string; place: string | null;
    registration_type: { uid: string; name: string; amount: number; currency: string };
    state: 'confirmed' | 'reserved' | 'held' | 'unavailable';   // held: la propia solicitud espera a que se confirme la dirección
    waiting: Array<'membership' | 'contribution'>;               // lo que espera una plaza `reserved`
    reasons: string[];                                           // por qué está `unavailable` (los motivos de elegibilidad)
    reserved_until: string | null;
    payment_instructions: string | null;
    already: boolean;                                            // la plaza ya estaba retenida
}

interface SandboxMembers { slug: string; members: Array<{ email: string; name: string; status: MembershipStatus; expires_at: string | null; statuto_accepted: boolean }> }
interface SandboxReset { password: string; members: Array<{ email: string; name: string; status: MembershipStatus }> }

OAuth

interface TokenResponse {
    access_token: string;
    token_type: 'Bearer';
    expires_in: number;
    refresh_token?: string;
    scope: string;
    sub?: string;                 // ausente en los tokens de cliente
}

El vocabulario del documento OpenAPI

Spec se genera a partir de openapi/v1.json (npm run spec:types, comprobado en CI): cada esquema del documento como un tipo, más Spec.operations (id → método y ruta). Los tipos de arriba siguen siendo la superficie documentada; Spec es para quien trabaja directamente contra la API.

import type { Spec } from '@vimine/sdk';
let p: Spec.Problem; const [m, path] = Spec.operations.listMemberships;