Tipi

I tipi sono esportati da @vimine/sdk (e da /server) e rispecchiano il documento OpenAPI: i nomi dei campi sono quelli del JSON. Le forme complete sono nel riferimento API; qui le principali.

Permessi e stati

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';
/** Quanto vale la tessera adesso. */
type MembershipVerdict = 'valid' | 'expired' | 'not_yet_valid' | 'statuto_required' | 'inactive';

Il socio

interface Me {
    sub: string;                  // identificativo per la tua associazione (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 statistico: non viene confrontato con il codice
    birthplace: string | null;    // comune (nati in Italia) o città, testo libero (nati all'estero)
    birth_country: string | null; // ISO 3166-1 alpha-2
    codicefiscale: string | null; // facoltativo: una persona può non averne
    codicefiscale_check: CodiceFiscaleCheck | null;   // come la persona è identificata; null = non ancora
    locale: Locale | null;        // la lingua che la persona ha scelto; null = mai scelta
    updated_at: string | null;
}

/** Una lingua che Vimine parla. Dove l'API ne accetta una accetta anche un tag regionale (`en-GB` → `en`, `zh-TW` → `zh-Hant`) e lo riduce. */
type Locale = 'it' | 'en' | 'zh-Hans' | 'zh-Hant' | 'fr' | 'es' | 'de' | 'pt-BR';
interface LocaleParam { locale?: Locale | string }   // ?locale= delle letture — vedi la guida Lingue

/** Come una persona è identificata: con un codice fiscale OPPURE con data, luogo e Stato di nascita — mai nessuno dei due. */
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;            // si può aggiungere più tardi, o riportare a null
    codicefiscale_confirmed?: boolean;        // solo in scrittura: la persona conferma un codice che non concorda (dopo un `confirmable: true`)
    locale?: Locale | null;                   // null azzera la scelta; 422 `unsupported` per una lingua che Vimine non parla
}

La tessera

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;         // pubblicato uno statuto più recente di quello accettato
        overdue: boolean;         // … e la finestra per riaccettarlo è scaduta
    };
    pending_reasons: Array<'approval' | 'payment'>;   // perché è ancora in attesa, in ordine: ammissione, poi quota
    payment_open: boolean;        // la quota si può versare adesso? (l'ammissione apre il pagamento)
    valid_from: string | null;    // da quando la tessera è utilizzabile (intervallo dell'associazione)
    usable: boolean;              // la tessera vale alla porta in questo momento
    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 };   // rinnovo dal socio: aperto 60 giorni prima della scadenza
    network_opt_in: boolean;
    card: { token: string; nbf: number; exp: number } | null;   // il token vmt_… del QR e la sua finestra (unix s)
}

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

interface MembershipRequest {     // POST /v1/me/membership
    membership_type?: string;     // uid; opzionale se l'associazione ne offre uno solo
    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;
}

Pubblici

interface Verification {
    status: 'active' | 'inactive';
    valid_until?: string;
    valid_from?: string;          // con reason 'not_yet_valid': la tessera è autentica e attiva, e diventa utilizzabile da qui
    reason?: 'expired' | 'invalid' | 'not_yet_valid';
}

type AdmissionModel = 'board' | 'provisional' | 'automatic';   // come l’associazione ammette i soci

interface AssociationPublicConfig {
    aps: {
        slug: string; name: string;
        picture_url: string | null;
        citta: string | null; provincia: string | null;
        enroll_enabled: boolean;
        accepting_requests: boolean;  // il tesseramento è aperto E c'è posto per un altro socio, adesso
        invitation_only: boolean;     // beta privata: accoglie solo chi ha invitato (accepting_requests è false)
        // come l'associazione ammette i soci — da dire a chi fa domanda. board: decide il direttivo, la quota dopo;
        // provisional: ammesso subito, ratificato poi; automatic: attiva appena le condizioni sono soddisfatte.
        // delay_hours: ore tra l'ammissione e una tessera UTILIZZABILE (0 = subito)
        admission: { model: AdmissionModel; delay_hours: number };
        approval_required: boolean;   // deprecato: true quando admission.model è 'board' — leggi `admission`
        payment_instructions: string | null;   // come versare la quota, se l'associazione lo ha pubblicato
        member_address: MemberAddressPolicy;   // se l'associazione raccoglie l'indirizzo dei soci — di tutti o di nessuno
        // attività di interesse generale (art. 5 CTS): la lettera, la descrizione, quale è prevalente
        activity_sectors: Array<{ cod: string; description: string; prevalent: boolean }>;
        // iscritta al RUNTS secondo gli elenchi ufficiali, altrimenti 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;             // Stato di nascita: per chi è nato all'estero il codice contiene solo lo Stato, e `place` non viene confrontato
}
type FiscalCodeMismatch = 'lastName' | 'firstName' | 'gender' | 'date' | 'place';
type FiscalCodeHint = 'names_swapped';
interface FiscalCodeResult {
    valid: boolean;
    error: 'invalid' | 'mismatch' | null;     // 'invalid': struttura o carattere di controllo; 'mismatch': non concorda con i dati inviati
    mismatches: FiscalCodeMismatch[];
    hints: FiscalCodeHint[];
    birth_date: string | null;    // la data di nascita che il codice contiene (YYYY-MM-DD)
    birth_country: string | null; // lo Stato di nascita che il codice contiene (IT per un comune)
}

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

Client riservati

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 — per chi è nato all'estero: il codice contiene solo lo Stato
    codicefiscale?: string | null;
    codicefiscale_confirmed?: boolean;        // la persona conferma un codice che non concorda (422 `codicefiscale_mismatch` con `confirmable: true`)
    accept_terms?: LegalRef;                  // le condizioni dell'account accettate sul tuo sito — facoltativo, versione in vigore
    acknowledge_privacy?: LegalRef;           // l'informativa della piattaforma letta sul tuo sito — facoltativo, stessa regola
}
interface EnrollInput extends SignupInput {   // POST /v1/enroll
    codicefiscale?: string | null;            // facoltativo: un codice fiscale OPPURE dob + birthplace + birth_country, mai nessuno dei due
    address?: MemberAddress;                  // residenza o domicilio, se `aps.member_address` non è `none`
    membership_type?: string;     // facoltativo se il tipo è uno solo
    accept_statuto: { version: number; sha256?: string };
    privacy_notice?: { version: number; sha256?: string };   // obbligatorio se l'associazione pubblica un'informativa
}
interface MemberAddress {
    kind?: 'residence' | 'domicile';          // predefinito 'residence'
    line: string;                 // via e numero
    postal_code?: string | null;
    city: string;
    province?: string | null;     // solo indirizzi italiani (due lettere)
    country?: string;             // ISO 3166-1 alpha-2, predefinito 'IT'
}
interface EnrollIdentification {  // POST /v1/enroll/confirm dopo un 409 identification_required
    dob?: string; birthplace?: string; birth_country?: string; codicefiscale?: string; codicefiscale_confirmed?: boolean;
}
interface CardCheckinResult {     // POST /v1/checkins per una tessera
    kind: 'card';
    verdict: MembershipVerdict;
    status: MembershipStatus;
    membership_id: string;
    valid_until: string | null;
    valid_from: string | null;
    identity_check: IdentityCheck | null;     // una nota per chi è all'ingresso: non fa parte di `verdict`, non limita nulla
    checked_in_at: string;
}
/** 'pending': un documento è ancora da vedere; 'verified': visto; 'flagged': visto, e non corrispondeva. */
type IdentityCheck = 'pending' | 'verified' | 'flagged';
interface FieldError {            // una voce di `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 (facoltativi, versione in vigore)
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 risposta, sempre uguale
interface EnrollConfirmResult {  // POST /v1/enroll/confirm
    status: MembershipStatus;
    already: boolean;             // aveva già una tessera o una richiesta
    pending_reasons: Array<'approval' | 'payment'>;   // in ordine: prima l'ammissione, poi la quota
    payment_open: boolean;
    valid_from: string | null;
    association: { name: string; slug: string };
    event?: EnrolledPlace | null; // solo per un link nato dalla pagina di iscrizione aperta da un evento: che ne è del posto
}
interface EnrolledPlace {        // il posto chiesto insieme all'adesione (guida Eventi › Chi non è ancora 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: l'adesione stessa aspetta la conferma dell'indirizzo
    waiting: Array<'membership' | 'contribution'>;               // che cosa aspetta un posto `reserved`
    reasons: string[];                                           // perché è `unavailable` (i motivi di eligibility)
    reserved_until: string | null;
    payment_instructions: string | null;
    already: boolean;                                            // il posto c'era già
}

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;                 // assente nei token dei client
}

Il vocabolario del documento OpenAPI

Spec è generato da openapi/v1.json (npm run spec:types, verificato in CI): ogni schema del documento come tipo, più Spec.operations (id → metodo e percorso). I tipi qui sopra restano la superficie documentata; Spec serve a chi lavora direttamente sull’API.

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