# Tipos

> Os tipos TypeScript do SDK — as mesmas estruturas JSON da API v1, nomes de campos inalterados.

URL: https://developers.vimine.network/pt/sdk/types/

Os tipos são exportados pelo `@vimine/sdk` (e pelo `/server`) e espelham o documento OpenAPI: os nomes dos campos
são os do JSON. As estruturas completas estão na [referência da API](https://developers.vimine.network/api/); aqui, as principais.

## Permissões e status

```ts
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';
/** O que a carteirinha vale neste momento. */
type MembershipVerdict = 'valid' | 'expired' | 'not_yet_valid' | 'statuto_required' | 'inactive';
```

## O associado

```ts
interface Me {
    sub: string;                  // identificador para a sua associação (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;     // só estatístico: não é conferido com o código
    birthplace: string | null;    // comune (nascidos na Itália) ou cidade, texto livre (nascidos no exterior)
    birth_country: string | null; // ISO 3166-1 alpha-2
    codicefiscale: string | null; // opcional: uma pessoa pode não ter um
    codicefiscale_check: CodiceFiscaleCheck | null;   // como a pessoa está identificada; null = ainda não
    locale: Locale | null;        // o idioma que a pessoa escolheu; null = nunca escolhido
    updated_at: string | null;
}

/** Um idioma que o Vimine fala. Onde a API aceita um, também aceita uma tag regional (`en-GB` → `en`, `zh-TW` → `zh-Hant`) e a reduz. */
type Locale = 'it' | 'en' | 'zh-Hans' | 'zh-Hant' | 'fr' | 'es' | 'de' | 'pt-BR';
interface LocaleParam { locale?: Locale | string }   // ?locale= das leituras — veja o guia Idiomas

/** Como uma pessoa é identificada: por um código fiscal OU pela data, local e país de nascimento — nunca por nenhum dos dois. */
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;            // pode ser adicionado depois, ou voltar a null
    codicefiscale_confirmed?: boolean;        // só de escrita: a pessoa confirma um código que não confere (depois de um `confirmable: true`)
    locale?: Locale | null;                   // null apaga a escolha; 422 `unsupported` para um idioma que o Vimine não fala
}
```

## A carteirinha

```ts
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;         // foi publicado um statuto mais recente do que o aceito pelo associado
        overdue: boolean;         // … e o prazo para aceitá-lo de novo já passou
    };
    pending_reasons: Array<'approval' | 'payment'>;   // por que ainda está pendente, em ordem: admissão, depois a taxa
    payment_open: boolean;        // a taxa já pode ser paga? (a admissão abre o pagamento)
    valid_from: string | null;    // quando a carteirinha se torna utilizável (o intervalo da associação)
    usable: boolean;              // a carteirinha vale na entrada neste 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 };   // renovação pelo próprio associado: aberta 60 dias antes do vencimento
    network_opt_in: boolean;
    card: { token: string; nbf: number; exp: number } | null;   // o token vmt_… do QR e a sua janela (unix s)
}

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

interface MembershipRequest {     // POST /v1/me/membership
    membership_type?: string;     // uid; opcional quando a associação oferece exatamente um
    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

```ts
interface Verification {
    status: 'active' | 'inactive';
    valid_until?: string;
    valid_from?: string;          // com reason 'not_yet_valid': a carteirinha é autêntica e ativa, e se torna utilizável a partir daqui
    reason?: 'expired' | 'invalid' | 'not_yet_valid';
}

type AdmissionModel = 'board' | 'provisional' | 'automatic';   // como a associação admite os seus associados

interface AssociationPublicConfig {
    aps: {
        slug: string; name: string;
        picture_url: string | null;
        citta: string | null; provincia: string | null;
        enroll_enabled: boolean;
        accepting_requests: boolean;  // a adesão está ativa E há espaço para mais um associado, neste momento
        invitation_only: boolean;     // beta privado: só recebe as pessoas que convidou (accepting_requests é false)
        // como a associação admite os seus associados — diga isso de antemão a quem pede. board: a diretoria decide, a taxa depois;
        // provisional: admitido na hora, ratificado depois; automatic: ativa assim que as condições são cumpridas.
        // delay_hours: horas entre a admissão e uma carteirinha UTILIZÁVEL (0 = na hora)
        admission: { model: AdmissionModel; delay_hours: number };
        approval_required: boolean;   // obsoleto: true quando admission.model é 'board' — leia `admission`
        payment_instructions: string | null;   // como pagar a taxa, quando a associação o publicou
        member_address: MemberAddressPolicy;   // se a associação coleta o endereço dos seus associados — de todos ou de nenhum
        // atividades de interesse geral (art. 5 do Código do Terceiro Setor): letra, texto, qual é a predominante
        activity_sectors: Array<{ cod: string; description: string; prevalent: boolean }>;
        // inscrita no RUNTS segundo as listas oficiais, senão 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 nascimento: para uma pessoa nascida no exterior o código só traz o país, e `place` não é comparado
}
type FiscalCodeMismatch = 'lastName' | 'firstName' | 'gender' | 'date' | 'place';
type FiscalCodeHint = 'names_swapped';
interface FiscalCodeResult {
    valid: boolean;
    error: 'invalid' | 'mismatch' | null;     // 'invalid': estrutura ou caractere de controle; 'mismatch': não confere com os dados enviados
    mismatches: FiscalCodeMismatch[];
    hints: FiscalCodeHint[];
    birth_date: string | null;    // a data de nascimento que o código traz (YYYY-MM-DD)
    birth_country: string | null; // o país de nascimento que o código traz (IT para um comune)
}

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

## Clientes confidenciais

```ts
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 uma pessoa nascida no exterior: o código só traz o país
    codicefiscale?: string | null;
    codicefiscale_confirmed?: boolean;        // a pessoa confirma um código que não confere (422 `codicefiscale_mismatch` com `confirmable: true`)
    accept_terms?: LegalRef;                  // as condições de uso da conta aceitas no seu site — opcional, a versão em vigor
    acknowledge_privacy?: LegalRef;           // o aviso de privacidade da plataforma lido no seu site — opcional, mesma regra
}
interface EnrollInput extends SignupInput {   // POST /v1/enroll
    codicefiscale?: string | null;            // opcional: um código fiscal OU dob + birthplace + birth_country, nunca nenhum dos dois
    address?: MemberAddress;                  // residência ou domicílio, quando `aps.member_address` não é `none`
    membership_type?: string;     // opcional quando existe exatamente um tipo
    accept_statuto: { version: number; sha256?: string };
    privacy_notice?: { version: number; sha256?: string };   // obrigatório quando a associação publica um aviso
}
interface MemberAddress {
    kind?: 'residence' | 'domicile';          // padrão 'residence'
    line: string;                 // rua e número
    postal_code?: string | null;
    city: string;
    province?: string | null;     // só endereços italianos (duas letras)
    country?: string;             // ISO 3166-1 alpha-2, padrão 'IT'
}
interface EnrollIdentification {  // POST /v1/enroll/confirm depois de um 409 identification_required
    dob?: string; birthplace?: string; birth_country?: string; codicefiscale?: string; codicefiscale_confirmed?: boolean;
}
interface CardCheckinResult {     // POST /v1/checkins para uma carteirinha
    kind: 'card';
    verdict: MembershipVerdict;
    status: MembershipStatus;
    membership_id: string;
    valid_until: string | null;
    valid_from: string | null;
    identity_check: IdentityCheck | null;     // uma observação para quem cuida da entrada: não faz parte do `verdict`, não restringe nada
    checked_in_at: string;
}
/** 'pending': um documento ainda precisa ser olhado; 'verified': olhado; 'flagged': olhado, e não conferia. */
type IdentityCheck = 'pending' | 'verified' | 'flagged';
interface FieldError {            // uma entrada de `VimineError.errors`
    field?: string; code?: string; message?: string;
    mismatches?: FiscalCodeMismatch[]; hints?: FiscalCodeHint[]; confirmable?: boolean;   // só `codicefiscale_mismatch`
}
interface LegalRef { version: string; sha256?: string }      // accept_terms / acknowledge_privacy (opcional, versão em 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' }     // a resposta, sempre a mesma
interface EnrollConfirmResult {  // POST /v1/enroll/confirm
    status: MembershipStatus;
    already: boolean;             // já tinha uma carteirinha ou um pedido
    pending_reasons: Array<'approval' | 'payment'>;   // em ordem: primeiro a admissão, depois a taxa
    payment_open: boolean;
    valid_from: string | null;
    association: { name: string; slug: string };
    event?: EnrolledPlace | null; // só para um link que começou na página de adesão aberta a partir de um evento: o que aconteceu com a vaga
}
interface EnrolledPlace {        // a vaga pedida com o pedido de adesão (guia Eventos › Quem ainda não é associado)
    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: o próprio pedido aguarda a confirmação do endereço
    waiting: Array<'membership' | 'contribution'>;               // o que uma vaga `reserved` aguarda
    reasons: string[];                                           // por que está `unavailable` (os motivos de elegibilidade)
    reserved_until: string | null;
    payment_instructions: string | null;
    already: boolean;                                            // a vaga já estava guardada
}

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

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

## O vocabulário do documento OpenAPI

`Spec` é gerado a partir de `openapi/v1.json` (`npm run spec:types`, verificado na CI): cada schema do documento como um tipo, mais `Spec.operations` (id → método e caminho). Os tipos acima continuam sendo a superfície documentada; `Spec` é para quem trabalha diretamente com a API.

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