sgp-sdk 1.1.3 → 2.0.0-beta.1

package/dist/operation-sensitivity.d.ts

@@ -0,0 +1,496 @@
+import type { OperationSensitivity } from "./sensitivity.js";
+/** INTERNAL. Every operation the client ships; the one list `getSensitivity` reads. */
+export declare const shippedOperations: readonly [import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    paginacao: {
+        [x: string]: unknown;
+        offset?: number | null | undefined;
+        limit?: number | null | undefined;
+        parcial?: number | null | undefined;
+        total: number;
+    };
+    clientes: {
+        [x: string]: unknown;
+        id: number & import("zod").$brand<"CustomerId">;
+        nome: string;
+        tipo: string;
+        cpfcnpj: string;
+        sexo?: string | null | undefined;
+        dataCadastro?: string | null | undefined;
+        endereco?: {
+            [x: string]: unknown;
+            logradouro?: string | null | undefined;
+            numero?: string | number | null | undefined;
+            bairro?: string | null | undefined;
+            cidade?: string | null | undefined;
+            uf?: string | null | undefined;
+            cep?: string | null | undefined;
+            complemento?: string | null | undefined;
+            latitude?: string | null | undefined;
+            longitude?: string | null | undefined;
+        } | null | undefined;
+        contratos?: {
+            [x: string]: unknown;
+            id: number;
+            status?: string | null | undefined;
+            endereco?: {
+                [x: string]: unknown;
+                logradouro?: string | null | undefined;
+                numero?: string | number | null | undefined;
+                bairro?: string | null | undefined;
+                cidade?: string | null | undefined;
+                uf?: string | null | undefined;
+                cep?: string | null | undefined;
+                complemento?: string | null | undefined;
+                latitude?: string | null | undefined;
+                longitude?: string | null | undefined;
+            } | null | undefined;
+            servicos?: {
+                [x: string]: unknown;
+                id: number;
+                tipo?: string | null | undefined;
+                plano?: {
+                    [x: string]: unknown;
+                    id: number & import("zod").$brand<"PlanId">;
+                    descricao?: string | null | undefined;
+                } | null | undefined;
+                status?: string | null | undefined;
+                endereco?: {
+                    [x: string]: unknown;
+                    logradouro?: string | null | undefined;
+                    numero?: string | number | null | undefined;
+                    bairro?: string | null | undefined;
+                    cidade?: string | null | undefined;
+                    uf?: string | null | undefined;
+                    cep?: string | null | undefined;
+                    complemento?: string | null | undefined;
+                    latitude?: string | null | undefined;
+                    longitude?: string | null | undefined;
+                } | null | undefined;
+            }[] | null | undefined;
+        }[] | null | undefined;
+        titulos?: {
+            [x: string]: unknown;
+        }[] | null | undefined;
+        contatos?: {
+            [x: string]: unknown;
+            telefones?: string[] | null | undefined;
+            celulares?: string[] | null | undefined;
+            emails?: string[] | null | undefined;
+            outros?: unknown[] | null | undefined;
+        } | null | undefined;
+    }[];
+}, "customers.list">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    msg?: string | null | undefined;
+    contratos: {
+        [x: string]: unknown;
+        contratoId: number;
+        clienteId: number & import("zod").$brand<"CustomerId">;
+        contratoStatus?: number | null | undefined;
+        contratoStatusDisplay?: string | null | undefined;
+        contratoValorAberto?: number | null | undefined;
+        contratoTitulosAReceber?: number | null | undefined;
+        cobVencimento?: number | null | undefined;
+        contratoStatusModo?: number | null | undefined;
+        motivo_status?: string | null | undefined;
+        dataCadastro?: string | null | undefined;
+        dataAlteracao?: string | null | undefined;
+        popId?: number | null | undefined;
+        popNome?: string | null | undefined;
+        cobPermuta?: boolean | null | undefined;
+        cobIsento?: number | null | undefined;
+        promessasPagamentoMes?: number | null | undefined;
+        link_quitacao?: string | null | undefined;
+        planointernet?: string | null | undefined;
+        fidelidade?: {
+            [x: string]: unknown;
+            data_inicio?: string | null | undefined;
+            descricao?: string | null | undefined;
+            data_fim?: string | null | undefined;
+        } | null | undefined;
+        contrato_unificado_principal?: unknown;
+        contrato_unificado_filhos?: unknown;
+        tags?: {
+            [x: string]: unknown;
+            color?: string | null | undefined;
+            font?: string | null | undefined;
+            tag?: string | null | undefined;
+            id?: number | null | undefined;
+            categoria_id?: unknown;
+        }[] | null | undefined;
+        anotacoes?: unknown[] | null | undefined;
+        contratoCentralLogin?: string | null | undefined;
+        contratoCentralSenha?: string | null | undefined;
+        servico_login?: string | null | undefined;
+        servico_senha?: string | null | undefined;
+        servico_plano?: string | null | undefined;
+        servico_grupo?: string | null | undefined;
+        servico_tipo_conexao?: string | null | undefined;
+        servico_vlan?: string | null | undefined;
+        servico_mac?: string | null | undefined;
+        servico_mac2?: string | null | undefined;
+        servico_wifi_ssid?: string | null | undefined;
+        servico_wifi_ssid_5?: string | null | undefined;
+        servico_wifi_password?: string | null | undefined;
+        servico_wifi_password_5?: string | null | undefined;
+        servico_wifi_channel?: string | null | undefined;
+        servico_wifi_channel_5?: string | null | undefined;
+        razaoSocial?: string | null | undefined;
+        cpfCnpj?: string | null | undefined;
+        dataNascimento?: string | null | undefined;
+        telefones?: {
+            [x: string]: unknown;
+            inscricoes?: string[] | null | undefined;
+            tipoContato?: string | null | undefined;
+            contato?: string | null | undefined;
+        }[] | null | undefined;
+        telefones_cargos?: unknown[] | null | undefined;
+        emails?: {
+            [x: string]: unknown;
+            inscricoes?: string[] | null | undefined;
+            tipoContato?: string | null | undefined;
+            contato?: string | null | undefined;
+        }[] | null | undefined;
+        outros?: unknown[] | null | undefined;
+        endereco_logradouro?: string | null | undefined;
+        endereco_numero?: string | number | null | undefined;
+        endereco_complemento?: string | null | undefined;
+        endereco_bairro?: string | null | undefined;
+        endereco_cidade?: string | null | undefined;
+        endereco_uf?: string | null | undefined;
+        endereco_cep?: string | null | undefined;
+        endereco_pontoreferencia?: unknown;
+        endereco_ll?: string | null | undefined;
+    }[];
+}, "customers.search">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    message: string;
+}, "preRegistrations.create">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    resposta: {
+        [x: string]: unknown;
+        mensagem?: string | null | undefined;
+        contrato: number;
+        contrato_status: string;
+    };
+}, "contracts.updateStatus">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    resposta: {
+        [x: string]: unknown;
+        mensagem?: string | null | undefined;
+        contrato: number;
+        alterados: string[];
+    };
+}, "contracts.update">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    id_contrato: number;
+    id_cliente: number & import("zod").$brand<"CustomerId">;
+    status?: string | null | undefined;
+    pop_id?: number | null | undefined;
+    nome?: string | null | undefined;
+    cpfcnpj?: string | null | undefined;
+    email?: string | null | undefined;
+    telefone?: string | null | undefined;
+    data_status?: string | null | undefined;
+    data_cadastro?: string | null | undefined;
+    motivo_status?: string | null | undefined;
+}[], "contracts.list">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    paginacao: {
+        [x: string]: unknown;
+        offset?: number | null | undefined;
+        limit?: number | null | undefined;
+        parcial?: number | null | undefined;
+        total: number;
+    };
+    titulos: {
+        [x: string]: unknown;
+        id: number;
+        status?: string | null | undefined;
+        valor?: number | null | undefined;
+        dataVencimento?: string | null | undefined;
+        clienteNome?: string | null | undefined;
+        clienteCpfcnpj?: string | null | undefined;
+        clienteContrato?: number | null | undefined;
+        portador?: string | null | undefined;
+        numeroDocumento?: string | number | null | undefined;
+        nossoNumero?: string | null | undefined;
+        link?: string | null | undefined;
+        link_cobranca?: string | null | undefined;
+        valorDesconto?: number | null | undefined;
+        valorCorrigido?: number | null | undefined;
+        valorPago?: number | null | undefined;
+        valorPagoParcial?: number | null | undefined;
+        codigoBarras?: string | null | undefined;
+        linhaDigitavel?: string | null | undefined;
+        codigoPix?: string | null | undefined;
+        dataEmissao?: string | null | undefined;
+        dataPagamento?: string | null | undefined;
+        dataCancelamento?: string | null | undefined;
+        demonstrativo?: string | null | undefined;
+        acordoPagamento?: {
+            [x: string]: unknown;
+            acordados?: unknown[] | null | undefined;
+            cobrados?: unknown[] | null | undefined;
+        } | null | undefined;
+        formaPagamento?: string | null | undefined;
+        usuario_baixa?: string | null | undefined;
+    }[];
+}, "invoices.list">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    planos: {
+        [x: string]: unknown;
+        id: number & import("zod").$brand<"PlanId">;
+        descricao?: string | null | undefined;
+        preco?: number | null | undefined;
+        ativo?: boolean | null | undefined;
+        grupo?: string | null | undefined;
+        tipo?: string | null | undefined;
+        pos_pago?: boolean | null | undefined;
+        desconto?: number | null | undefined;
+        desconto_venc?: number | null | undefined;
+        desconto_venc_modo?: string | null | undefined;
+        valor_desconto_temporario?: number | null | undefined;
+        desconto_temporario_modo?: string | null | undefined;
+        desconto_temporario_quantidade?: number | null | undefined;
+        descricao_desconto_temporario?: string | null | undefined;
+        desconto_temporario_proporcional?: boolean | null | undefined;
+        observacao?: string | null | undefined;
+        instalacao_qtd_parcelas?: number | null | undefined;
+        instalacao_valor?: number | null | undefined;
+        instalacao_desconto_max?: number | null | undefined;
+        instalacao_desconto_min?: number | null | undefined;
+        disponivel_pre_cadastro?: boolean | null | undefined;
+        disponivel_pre_cadastro_publico?: boolean | null | undefined;
+        data_validade?: string | null | undefined;
+        pops?: {
+            [x: string]: unknown;
+            id?: number | null | undefined;
+            uf?: string | null | undefined;
+            pop?: string | null | undefined;
+        }[] | null | undefined;
+        auto_bloqueio?: boolean | null | undefined;
+        dias_bloqueio_pos_venc?: number | null | undefined;
+        dias_bloqueio_aviso?: number | null | undefined;
+        dias_reducao_velocidade?: number | null | undefined;
+        download?: number | null | undefined;
+        upload?: number | null | undefined;
+        trafego_mensal?: number | null | undefined;
+        contabilizacao_trafego_mensal?: string | null | undefined;
+        trafego_excedente_acao?: string | null | undefined;
+        valor_trafego_excedido?: number | null | undefined;
+        duplicacao_noturna?: boolean | null | undefined;
+        inicio_duplicacao_noturna?: string | null | undefined;
+        fim_duplicacao_noturna?: string | null | undefined;
+        modo_velocidade_reduzida?: string | null | undefined;
+        download_red_financeiro?: number | null | undefined;
+        upload_red_financeiro?: number | null | undefined;
+        modo_velocidade_red_franquia?: string | null | undefined;
+        download_red_franquia?: number | null | undefined;
+        upload_red_franquia?: number | null | undefined;
+        combo?: unknown[] | null | undefined;
+        qtd_servicos?: number | null | undefined;
+    }[];
+    total_planos?: number | null | undefined;
+    total_qtd_servicos?: number | null | undefined;
+}, "plans.list">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    paginacao: {
+        [x: string]: unknown;
+        offset?: number | null | undefined;
+        limit?: number | null | undefined;
+        parcial?: number | null | undefined;
+        total: number;
+    };
+    ordens_servicos: {
+        [x: string]: unknown;
+        id: number;
+        contrato?: number | null | undefined;
+        status_id?: number | null | undefined;
+        status?: string | null | undefined;
+        tipo_id?: number | null | undefined;
+        data_cadastro?: string | null | undefined;
+        cliente?: string | null | undefined;
+        contrato_status?: string | null | undefined;
+        contrato_status_id?: number | null | undefined;
+        ocorrencia?: string | null | undefined;
+        hora_cadastro?: string | null | undefined;
+        data_agendamento?: string | null | undefined;
+        hora_agendamento?: string | null | undefined;
+        data_finalizacao?: string | null | undefined;
+        hora_finalizacao?: string | null | undefined;
+        tipo?: string | null | undefined;
+        motivo?: string | null | undefined;
+        pop?: string | null | undefined;
+        conteudo?: string | null | undefined;
+        responsavel?: string | null | undefined;
+        tecnicos_auxiliares?: unknown[] | null | undefined;
+        usuario?: string | null | undefined;
+        usuario_finalizacao?: string | null | undefined;
+        classificacoes?: unknown[] | null | undefined;
+    }[];
+}, "workOrders.list">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    msg: string;
+}, "services.changePlan">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    msg: string;
+    clientecontrato_id?: string | undefined;
+    servico_id: number;
+}, "services.addTv">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    msg: string;
+    clientecontrato_id?: string | undefined;
+    servico_id: number;
+}, "services.removeTv">, import("./operation.js").OperationDefinition<import("./operations/experimental-annotations-list.js").ExperimentalAnnotationsListData, "experimental.annotations.list">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    id: number;
+    pop?: string | null | undefined;
+}[], "catalogs.listPops">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    id: number;
+    descricao?: string | null | undefined;
+    identificador?: string | null | undefined;
+    endereco_ip?: string | null | undefined;
+    ativo?: boolean | null | undefined;
+    pops?: {
+        [x: string]: unknown;
+        id?: number | null | undefined;
+        cidade?: string | null | undefined;
+        uf?: string | null | undefined;
+        codigo_ibge?: number | null | undefined;
+        ativo?: boolean | null | undefined;
+    }[] | null | undefined;
+}[], "catalogs.listNas">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    id: number;
+    descricao?: string | null | undefined;
+    codigo_banco?: string | null | undefined;
+}[], "catalogs.listBillingProfiles">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    id: number;
+    codigo: number;
+    descricao?: string | null | undefined;
+    ativo?: boolean | null | undefined;
+    classificacoes?: unknown[] | null | undefined;
+    classificacoes_obrigatorio?: boolean | null | undefined;
+    setores?: unknown[] | null | undefined;
+    classificacoes_obrigatorio_encerramento?: boolean | null | undefined;
+}[], "occurrences.listTypes">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    codigo: number;
+    descricao?: string | null | undefined;
+}[], "occurrences.listMethods">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    id: number;
+    codigo: number;
+    descricao?: string | null | undefined;
+    ativo?: boolean | null | undefined;
+    classificacoes?: unknown[] | null | undefined;
+    classificacoes_obrigatorio?: boolean | null | undefined;
+    setores?: unknown[] | null | undefined;
+}[], "workOrders.listReasons">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    id: number & import("zod").$brand<"PreRegistrationPlanId">;
+    tipo?: string | null | undefined;
+    valor?: number | null | undefined;
+    descricao?: string | null | undefined;
+    observacao?: string | null | undefined;
+    gateway?: {
+        [x: string]: unknown;
+        gateway_id?: string | number | null | undefined;
+        id?: string | number | null | undefined;
+        descricao?: string | null | undefined;
+    } | null | undefined;
+}[], "preRegistrations.listPlans">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    id: number;
+    dia?: number | null | undefined;
+}[], "preRegistrations.listDueDays">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    id: number;
+    nome?: string | null | undefined;
+    cpf?: string | null | undefined;
+    email?: string | null | undefined;
+}[], "preRegistrations.listSellers">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    id: number;
+    motivo?: string | null | undefined;
+}[], "contracts.listStatusReasons">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    id: number;
+    cliente_id: number & import("zod").$brand<"CustomerId">;
+    arquivo?: string | null | undefined;
+    descricao?: string | null | undefined;
+    usuario?: string | null | undefined;
+}[], "documents.list">, import("./operation.js").OperationDefinition<import("./operations/coverage-check.js").CoverageCheckData, "coverage.check">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    cliente_id: number & import("zod").$brand<"CustomerId">;
+    message?: string | null | undefined;
+}, "crm.customers.create">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    cliente_id: number & import("zod").$brand<"CustomerId">;
+    message?: string | null | undefined;
+    novo_status: {
+        [x: string]: unknown;
+        codigo: number;
+        descricao?: string | null | undefined;
+    };
+}, "crm.customers.updateStatus">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    message?: string | null | undefined;
+    clientecontrato: number;
+    cliente?: string | null | undefined;
+}, "crm.contracts.create">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    message?: string | null | undefined;
+    clientecontrato: number;
+    cliente?: string | null | undefined;
+}, "crm.contracts.createByCpfCnpj">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    cliente?: string | null | undefined;
+    cpf_cnpj?: string | null | undefined;
+    contratos: {
+        [x: string]: unknown;
+        cliente_contrato_id: number;
+        data_cadastro?: string | null | undefined;
+        vencimento_dia?: number | null | undefined;
+        pop?: string | null | undefined;
+        endereco?: string | null | undefined;
+        forma_cobranca?: string | null | undefined;
+        status?: string | null | undefined;
+        data_status?: string | null | undefined;
+        modo_status?: string | null | undefined;
+        motivo_status?: string | null | undefined;
+        vendedor?: string | null | undefined;
+        servicos?: {
+            [x: string]: unknown;
+            plano?: string | null | undefined;
+            login?: string | null | undefined;
+            contrato_tipo?: string | null | undefined;
+            situacao?: string | null | undefined;
+            aquisicao?: string | null | undefined;
+        }[] | null | undefined;
+    }[];
+}, "crm.contracts.list">, import("./operation.js").OperationDefinition<{
+    [x: string]: unknown;
+    status: 1;
+    protocolo: string;
+    id: number;
+    contratoId?: number | null | undefined;
+    razaoSocial?: string | null | undefined;
+    cpfCnpj?: string | null | undefined;
+    msg?: string | null | undefined;
+}, "occurrences.create">, import("./operation.js").OperationDefinition<null, "documents.add">];
+/**
+ * Name of every typed operation of the client, as in `SgpError.operation`. `request()` is not one:
+ * its `error.operation` is `"request"`, and it declares no sensitivity (see `getSensitivity`).
+ */
+export type OperationName = (typeof shippedOperations)[number]["name"];
+/**
+ * The secret and personal keys an operation declares, for its request (`input`) and its 2xx body
+ * (`output`), per item path. Use it to know what to strip; to decide what to send on, prefer an
+ * allowlist with `pick`: a key that is not listed is not safe, SGP adds fields without notice.
+ */
+export declare const getSensitivity: (operation: OperationName) => OperationSensitivity;

package/dist/operation.d.ts

@@ -0,0 +1,139 @@
+import type { Exposure } from "./exposure.js";
+import type { ResponseBody, SchemaWarning } from "./result.js";
+import type { OperationSensitivity } from "./sensitivity.js";
+/**
+ * How a request body is encoded; the executor switches on it. `form` is `multipart/form-data`
+ * without files: every param is a text field and the content-type (with its boundary) is left to
+ * `fetch`.
+ */
+export type Encoding = "json" | "form";
+/**
+ * The encodings an operation may declare: {@link Encoding} plus `form-files`, `multipart/form-data`
+ * with file parts next to the text fields (the file parts come from `RequestBuild.files`). Only
+ * typed operations use it: `request()` takes {@link Encoding}.
+ */
+type OperationEncoding = Encoding | "form-files";
+/** A file sent as one part of a `form-files` body. */
+export interface FilePart {
+    /** The bytes of the file: a `Blob`, raw bytes or an `ArrayBuffer`, sent as they are. */
+    data: Blob | Uint8Array | ArrayBuffer;
+    /** Name SGP sees for the part. */
+    filename: string;
+    /** MIME type of the part. Defaults to the `type` of a `Blob`; none for raw bytes. */
+    contentType?: string;
+}
+/** The fields every operation has, read or write. */
+interface OperationFields<Data, Name extends string> {
+    /** Public name, e.g. `customers.list`; also the `operation` of hooks and errors. */
+    name: Name;
+    method: "GET" | "POST" | "PUT" | "DELETE";
+    /** Path template starting with `/`; `{name}` placeholders are filled from `pathParams`. */
+    pathTemplate: string;
+    /**
+     * Hook metadata leaves out `pathTemplate`: for a call whose path is a literal chosen by the
+     * caller (`request()`), not a template. Absent means the template is shown.
+     */
+    omitPathFromHooks?: boolean;
+    /** Body encoding of POST/PUT/DELETE. A GET has no body: its params go in the query string. */
+    encoding: OperationEncoding;
+    /** Validates the raw input and builds the request. No I/O. */
+    buildRequest: (input: unknown) => RequestBuild;
+    /**
+     * Recognizes a 2xx body that is a known refusal (a 200 that did not do what was asked). Pure.
+     * `undefined` when the body is not a refusal.
+     */
+    detectRefusal?: (body: ResponseBody) => Refusal | undefined;
+    /** Checks a 2xx body against the contract the method promises. Pure, no I/O. */
+    decode: (body: ResponseBody) => DecodeOutcome<Data>;
+    /**
+     * Secret and personal keys of the request and of the 2xx body, per item path. Required: the
+     * single source `getSensitivity` reads. A definition with nothing sensitive says
+     * `{ input: [], output: [] }`.
+     */
+    sensitivity: OperationSensitivity;
+    /**
+     * For an operation whose response mixes records outside the requested scope: the executor
+     * withholds the body and keeps only message strings in `error.sgp`, on every status and path,
+     * before it builds any public object. Absent means the body is the evidence, as everywhere else.
+     */
+    exposure?: Exposure;
+}
+/**
+ * INTERNAL. An operation is data plus a few small pure functions; the executor does everything else.
+ * Not exported from the package: consumers only see the client methods, their types and options.
+ *
+ * A read may be `repeatable` (the retry gate of the operation contract; absent means `false`). A write, marked by
+ * `write`, carries an `effect` on every failure and is never repeatable: the type forbids
+ * `repeatable: true` next to `write`, and the executor refuses such a definition.
+ */
+export type OperationDefinition<Data, Name extends string = string> = (OperationFields<Data, Name> & {
+    repeatable?: boolean;
+    write?: undefined;
+}) | (OperationFields<Data, Name> & {
+    repeatable?: false;
+    write: WriteSpec;
+});
+/** What a write declares about itself on top of the default effect rules of the operation contract. */
+export interface WriteSpec {
+    /**
+     * Every failure after a request was sent has effect `unknown`, whatever the status and body say:
+     * for a call the SDK does not interpret (`request()`), where no rejection is known to apply
+     * nothing. Absent means the default rules of the operation contract.
+     */
+    effectUnknownAfterSend?: boolean;
+    /**
+     * Remote rejections this operation is proven to apply no effect for, whatever their body shape
+     * (in particular SGP's generic `errors` array, which is `unknown` by default). Declare one only
+     * with captured evidence for this operation.
+     */
+    knownRejections?: readonly KnownRejection[];
+}
+/** A remote 4xx known to leave the requested change unapplied. Gives the failure its `reason`. */
+export interface KnownRejection {
+    /** HTTP status of the rejection. Must be 4xx: any other status is never matched. */
+    status: number;
+    /** Recognizes the rejection from the body. Pure; must say `false` for a body it cannot read. */
+    matches: (body: ResponseBody) => boolean;
+    /** Value of `SgpError.reason`. */
+    reason: string;
+}
+/** What `buildRequest` returns: the request to send, or the first problem with the input. */
+export type RequestBuild = {
+    ok: true;
+    /** Values for the `{name}` placeholders of the path template. */
+    pathParams?: Readonly<Record<string, string | number>>;
+    /**
+     * Request fields: the body for POST/PUT/DELETE, the query string for GET. `undefined` values
+     * are omitted. A GET or a `form` body takes primitives only (a `json` body takes any value).
+     */
+    params?: Readonly<Record<string, unknown>>;
+    /**
+     * Fields that go in the URL of a request that has a body (POST/PUT/DELETE), after the path;
+     * `params` and the credentials stay in the body. Primitives only, `undefined` omitted, never
+     * `token` or `app`. A GET puts everything in its query string already: a GET with `query` is
+     * refused (`INVALID_INPUT`).
+     */
+    query?: Readonly<Record<string, unknown>>;
+    /** File parts by field name; only a `form-files` body sends them, after the text fields. */
+    files?: Readonly<Record<string, FilePart>>;
+} | {
+    ok: false;
+    problem: string;
+};
+/** A recognized refusal inside a 2xx response. */
+export interface Refusal {
+    reason?: string;
+}
+/**
+ * Result of checking a 2xx body. `warnings` lists the non-essential fields the decoder had to drop
+ * from `data`; it is absent when nothing was dropped.
+ */
+export type DecodeOutcome<Data> = {
+    ok: true;
+    data: Data;
+    warnings?: readonly SchemaWarning[];
+} | {
+    ok: false;
+    issues: readonly string[];
+};
+export {};

package/dist/operations/catalogs-list-billing-profiles.d.ts

@@ -0,0 +1,16 @@
+import { z } from "zod";
+import type { OperationDefinition } from "../operation.js";
+declare const billingProfilesSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    descricao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    codigo_banco: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, z.core.$loose>>;
+/**
+ * The response of `GET /api/ura/portador/`, in SGP's own shape: a bare array with one entry per
+ * billing profile (SGP "portador"). The route is not paginated, so there is no envelope and no
+ * total.
+ */
+export type CatalogsListBillingProfilesData = z.output<typeof billingProfilesSchema>;
+/** INTERNAL definition of `catalogs.listBillingProfiles`. */
+export declare const catalogsListBillingProfiles: OperationDefinition<CatalogsListBillingProfilesData, "catalogs.listBillingProfiles">;
+export {};

package/dist/operations/catalogs-list-nas.d.ts

@@ -0,0 +1,25 @@
+import { z } from "zod";
+import type { OperationDefinition } from "../operation.js";
+declare const nasListSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    descricao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    identificador: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    endereco_ip: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    ativo: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    pops: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        cidade: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        uf: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        codigo_ibge: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        ativo: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    }, z.core.$loose>>>>;
+}, z.core.$loose>>;
+/**
+ * The response of `POST /api/ura/nas/list/`, in SGP's own shape: a bare array with one entry per
+ * NAS (network access server) and the POPs each one serves. The route is not paginated, so there is
+ * no envelope and no total.
+ */
+export type CatalogsListNasData = z.output<typeof nasListSchema>;
+/** INTERNAL definition of `catalogs.listNas`. */
+export declare const catalogsListNas: OperationDefinition<CatalogsListNasData, "catalogs.listNas">;
+export {};