sgp-sdk 1.2.0 → 2.0.0-beta.2

package/dist/operations/customers-list.d.ts

@@ -0,0 +1,104 @@
+import { z } from "zod";
+import { type CustomerId } from "../ids.js";
+import type { OperationDefinition } from "../operation.js";
+declare const pageSchema: z.ZodObject<{
+    paginacao: z.ZodObject<{
+        offset: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        limit: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        parcial: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        total: z.ZodNumber;
+    }, z.core.$loose>;
+    clientes: z.ZodArray<z.ZodObject<{
+        id: z.core.$ZodBranded<z.ZodNumber, "CustomerId", "out">;
+        nome: z.ZodString;
+        tipo: z.ZodString;
+        cpfcnpj: z.ZodString;
+        sexo: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        dataCadastro: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        endereco: z.ZodNullable<z.ZodOptional<z.ZodObject<{
+            logradouro: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            numero: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>;
+            bairro: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            cidade: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            uf: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            cep: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            complemento: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            latitude: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            longitude: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        }, z.core.$loose>>>;
+        contratos: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+            id: z.ZodNumber;
+            status: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            endereco: z.ZodNullable<z.ZodOptional<z.ZodObject<{
+                logradouro: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                numero: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>;
+                bairro: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                cidade: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                uf: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                cep: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                complemento: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                latitude: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                longitude: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            }, z.core.$loose>>>;
+            servicos: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+                id: z.ZodNumber;
+                tipo: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                plano: z.ZodNullable<z.ZodOptional<z.ZodObject<{
+                    id: z.core.$ZodBranded<z.ZodNumber, "PlanId", "out">;
+                    descricao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                }, z.core.$loose>>>;
+                status: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                endereco: z.ZodNullable<z.ZodOptional<z.ZodObject<{
+                    logradouro: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                    numero: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>;
+                    bairro: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                    cidade: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                    uf: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                    cep: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                    complemento: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                    latitude: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                    longitude: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+                }, z.core.$loose>>>;
+            }, z.core.$loose>>>>;
+        }, z.core.$loose>>>>;
+        titulos: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{}, z.core.$loose>>>>;
+        contatos: z.ZodNullable<z.ZodOptional<z.ZodObject<{
+            telefones: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodString>>>;
+            celulares: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodString>>>;
+            emails: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodString>>>;
+            outros: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodUnknown>>>;
+        }, z.core.$loose>>>;
+    }, z.core.$loose>>;
+}, z.core.$loose>;
+/** One page of `POST /api/ura/clientes/`, with SGP's own `paginacao`. */
+export type CustomersListData = z.output<typeof pageSchema>;
+/** Filters and paging of `customers.list`, named as SGP names them. */
+export interface CustomersListInput {
+    /** Index of the first customer of the page. Non-negative integer. */
+    offset?: number;
+    /** Customers per page. Non-negative integer; SGP decides the cap. */
+    limit?: number;
+    /** Only the customer with this id, a `CustomerId` (never the id of a contract). */
+    cliente_id?: CustomerId;
+    /** Only customers with this CPF/CNPJ, in the format SGP stores it. */
+    cpfcnpj?: string;
+    /** Customers whose name matches, as SGP matches it. */
+    cliente_nome?: string;
+    /**
+     * Only the customer whose service has exactly this PPPoE login (exact match, observed live: a
+     * different or partial login lists nothing). Secret: never log it.
+     */
+    login?: string;
+}
+/** INTERNAL. Validation of the input, exported so a test can check its keys are classified. */
+export declare const customersListInputSchema: z.ZodObject<{
+    offset: z.ZodOptional<z.ZodNumber>;
+    limit: z.ZodOptional<z.ZodNumber>;
+    cliente_id: z.ZodOptional<z.core.$ZodBranded<z.ZodNumber, "CustomerId", "out">>;
+    cpfcnpj: z.ZodOptional<z.ZodString>;
+    cliente_nome: z.ZodOptional<z.ZodString>;
+    login: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/** INTERNAL definition of `customers.list`. */
+export declare const customersList: OperationDefinition<CustomersListData, "customers.list">;
+export {};

package/dist/{endpoints/ura/lookup-customer.d.ts → operations/customers-search.d.ts}

@@ -1,16 +1,15 @@
 import { z } from "zod";
-import type { EndpointDefinition } from "../../endpoint.js";
-/** Response of `POST /api/ura/consultacliente/`: the contracts that match the filter. */
-export declare const lookupCustomerSchema: z.ZodObject<{
+import type { OperationDefinition } from "../operation.js";
+declare const searchSchema: z.ZodObject<{
     msg: z.ZodNullable<z.ZodOptional<z.ZodString>>;
     contratos: z.ZodArray<z.ZodObject<{
         contratoId: z.ZodNumber;
-        clienteId: z.ZodNumber;
-        contratoStatus: z.ZodNumber;
-        contratoStatusDisplay: z.ZodString;
-        contratoValorAberto: z.ZodNumber;
-        contratoTitulosAReceber: z.ZodNumber;
-        cobVencimento: z.ZodNumber;
+        clienteId: z.core.$ZodBranded<z.ZodNumber, "CustomerId", "out">;
+        contratoStatus: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        contratoStatusDisplay: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        contratoValorAberto: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        contratoTitulosAReceber: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        cobVencimento: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
         contratoStatusModo: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
         motivo_status: z.ZodNullable<z.ZodOptional<z.ZodString>>;
         dataCadastro: z.ZodNullable<z.ZodOptional<z.ZodString>>;
@@ -26,17 +25,17 @@ export declare const lookupCustomerSchema: z.ZodObject<{
             data_inicio: z.ZodNullable<z.ZodOptional<z.ZodString>>;
             descricao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
             data_fim: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>;
-        contrato_unificado_principal: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
-        contrato_unificado_filhos: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodNumber>>>;
+        }, z.core.$loose>>>;
+        contrato_unificado_principal: z.ZodOptional<z.ZodUnknown>;
+        contrato_unificado_filhos: z.ZodOptional<z.ZodUnknown>;
         tags: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
             color: z.ZodNullable<z.ZodOptional<z.ZodString>>;
             font: z.ZodNullable<z.ZodOptional<z.ZodString>>;
             tag: z.ZodNullable<z.ZodOptional<z.ZodString>>;
             id: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
-            categoria_id: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
-        }, z.core.$strip>>>>;
-        anotacoes: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{}, z.core.$strip>>>>;
+            categoria_id: z.ZodOptional<z.ZodUnknown>;
+        }, z.core.$loose>>>>;
+        anotacoes: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodUnknown>>>;
         contratoCentralLogin: z.ZodNullable<z.ZodOptional<z.ZodString>>;
         contratoCentralSenha: z.ZodNullable<z.ZodOptional<z.ZodString>>;
         servico_login: z.ZodNullable<z.ZodOptional<z.ZodString>>;
@@ -60,62 +59,73 @@ export declare const lookupCustomerSchema: z.ZodObject<{
             inscricoes: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodString>>>;
             tipoContato: z.ZodNullable<z.ZodOptional<z.ZodString>>;
             contato: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>>;
-        telefones_cargos: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{}, z.core.$strip>>>>;
+        }, z.core.$loose>>>>;
+        telefones_cargos: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodUnknown>>>;
         emails: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
             inscricoes: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodString>>>;
             tipoContato: z.ZodNullable<z.ZodOptional<z.ZodString>>;
             contato: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>>;
-        outros: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{}, z.core.$strip>>>>;
+        }, z.core.$loose>>>>;
+        outros: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodUnknown>>>;
         endereco_logradouro: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        endereco_numero: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        endereco_numero: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>;
         endereco_complemento: z.ZodNullable<z.ZodOptional<z.ZodString>>;
         endereco_bairro: z.ZodNullable<z.ZodOptional<z.ZodString>>;
         endereco_cidade: z.ZodNullable<z.ZodOptional<z.ZodString>>;
         endereco_uf: z.ZodNullable<z.ZodOptional<z.ZodString>>;
         endereco_cep: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        endereco_pontoreferencia: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        endereco_pontoreferencia: z.ZodOptional<z.ZodUnknown>;
         endereco_ll: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-    }, z.core.$strip>>;
-}, z.core.$strip>;
-/** Key fields of `ura/consultacliente`: required and strict; any mismatch is `SCHEMA_MISMATCH`. */
-export declare const lookupCustomerKeyFields: readonly ["contratos", "contratos[].contratoId", "contratos[].clienteId", "contratos[].contratoStatus", "contratos[].contratoStatusDisplay", "contratos[].contratoValorAberto", "contratos[].contratoTitulosAReceber", "contratos[].cobVencimento"];
-/** Normalized path of each contract item in the `ura/consultacliente` response. */
-export declare const customerContractItemPath = "contratos[]";
-/** Keys of a contract item holding secrets: Central and PPPoE credentials, Wi-Fi, MACs, payoff link. */
-export declare const customerContractSecretKeys: readonly ["contratoCentralLogin", "contratoCentralSenha", "servico_login", "servico_senha", "servico_wifi_password", "servico_wifi_password_5", "servico_wifi_ssid", "servico_wifi_ssid_5", "servico_mac", "servico_mac2", "link_quitacao"];
-/** Keys of a contract item holding personal data: name, CPF/CNPJ, birth date, contacts, address, notes, status reason. */
-export declare const customerContractPersonalKeys: readonly ["motivo_status", "razaoSocial", "cpfCnpj", "dataNascimento", "telefones", "telefones_cargos", "emails", "outros", "anotacoes", "endereco_logradouro", "endereco_numero", "endereco_complemento", "endereco_bairro", "endereco_cidade", "endereco_uf", "endereco_cep", "endereco_pontoreferencia", "endereco_ll"];
-interface LookupCustomerFilters {
-    /** CPF or CNPJ of the customer. */
+    }, z.core.$loose>>;
+}, z.core.$loose>;
+/**
+ * The response of `POST /api/ura/consultacliente/`, in SGP's own shape. `contratos` holds the
+ * CANDIDATES: one entry per contract that matches the criteria, each carrying its customer's data
+ * flattened (`clienteId`, `razaoSocial`, `cpfCnpj`...) and the service's credentials. It is never
+ * one customer picked for you: see {@link CustomersSearchInput}.
+ */
+export type CustomersSearchData = z.output<typeof searchSchema>;
+interface CustomersSearchCriteria {
+    /** Customer or company document (CPF/CNPJ), in the format SGP stores it. */
     cpfcnpj?: string;
-    /** Contract ID. */
+    /** Contract id. */
     contrato?: number;
-    /** Customer name. */
+    /** Customer name, as SGP matches it. */
     nome?: string;
     /** Service login (PPPoE). */
     login?: string;
+    /** Phone number, as SGP matches it. */
     telefone?: string;
 }
 /**
- * Body parameters of `POST /api/ura/consultacliente/` (besides credentials).
+ * Criteria of `customers.search`, named as SGP names them. At least one is required, and a text
+ * criterion cannot be an empty string (parameter validation: a string of spaces is not empty and
+ * goes to SGP as given): otherwise the call is refused locally (`INVALID_INPUT`, nothing sent). How criteria combine and how names and phones are matched is SGP's decision, not the SDK's.
  *
- * At least one of `cpfcnpj`, `contrato`, `nome`, `login` or `telefone` is required; the others are optional.
+ * It is a search, not a lookup by key: any criterion other than `contrato` may match several
+ * contracts, of one customer or of different customers (the same document may belong to more than
+ * one customer). The result is the list of candidates, possibly empty or long; the SDK never
+ * narrows it to one.
  */
-export type LookupCustomerParams = (LookupCustomerFilters & {
+export type CustomersSearchInput = (CustomersSearchCriteria & {
     cpfcnpj: string;
-}) | (LookupCustomerFilters & {
+}) | (CustomersSearchCriteria & {
     contrato: number;
-}) | (LookupCustomerFilters & {
+}) | (CustomersSearchCriteria & {
     nome: string;
-}) | (LookupCustomerFilters & {
+}) | (CustomersSearchCriteria & {
     login: string;
-}) | (LookupCustomerFilters & {
+}) | (CustomersSearchCriteria & {
     telefone: string;
 });
-/** Parsed response of `POST /api/ura/consultacliente/`. */
-export type LookupCustomerResponse = z.output<typeof lookupCustomerSchema>;
-/** Definition of `POST /api/ura/consultacliente/`. */
-export declare const lookupCustomerDefinition: EndpointDefinition<typeof lookupCustomerSchema>;
+/** INTERNAL. Validation of the input, exported so a test can check its keys are classified. */
+export declare const customersSearchInputSchema: z.ZodObject<{
+    cpfcnpj: z.ZodOptional<z.ZodString>;
+    contrato: z.ZodOptional<z.ZodNumber>;
+    nome: z.ZodOptional<z.ZodString>;
+    login: z.ZodOptional<z.ZodString>;
+    telefone: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/** INTERNAL definition of `customers.search`. */
+export declare const customersSearch: OperationDefinition<CustomersSearchData, "customers.search">;
 export {};

package/dist/operations/documents-add.d.ts

@@ -0,0 +1,29 @@
+import { z } from "zod";
+import { type CustomerId } from "../ids.js";
+import type { FilePart, OperationDefinition } from "../operation.js";
+/**
+ * A file to upload: its bytes, the name SGP sees and, optionally, the MIME type. Without
+ * `contentType`, a `Blob` keeps its own `type` and raw bytes get none.
+ */
+export type DocumentFile = FilePart;
+/** Input of `documents.add`, named as SGP names the fields. */
+export interface DocumentAddInput {
+    /** ID of the customer the document is attached to. Goes in the path. */
+    cliente_id: CustomerId;
+    /** The document, sent as the multipart part `file`. */
+    file: DocumentFile;
+    /** Description of the document. Personal data when it names the customer. */
+    descricao?: string;
+}
+/** INTERNAL. Validation of the input, exported so a test can check it against the public type. */
+export declare const documentsAddInputSchema: z.ZodObject<{
+    cliente_id: z.core.$ZodBranded<z.ZodNumber, "CustomerId", "out">;
+    file: z.ZodObject<{
+        data: z.ZodCustom<ArrayBuffer | Blob | Uint8Array<ArrayBufferLike>, ArrayBuffer | Blob | Uint8Array<ArrayBufferLike>>;
+        filename: z.ZodString;
+        contentType: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>;
+    descricao: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/** INTERNAL definition of `documents.add`. */
+export declare const documentsAdd: OperationDefinition<null, "documents.add">;

package/dist/operations/documents-list.d.ts

@@ -0,0 +1,31 @@
+import { z } from "zod";
+import { type CustomerId } from "../ids.js";
+import type { OperationDefinition } from "../operation.js";
+/** Input of `documents.list`, named as SGP names the field. */
+export interface DocumentsListInput {
+    /**
+     * Exercised. ID of the customer whose documents to list, a `CustomerId` (the `id` of
+     * `customers.list`, the `clienteId` of `customers.search`), never the id of a contract.
+     */
+    cliente_id: CustomerId;
+}
+/** INTERNAL. Validation of the input, exported so a test can check it against the public type. */
+export declare const documentsListInputSchema: z.ZodObject<{
+    cliente_id: z.core.$ZodBranded<z.ZodNumber, "CustomerId", "out">;
+}, z.core.$strict>;
+declare const documentsSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    cliente_id: z.core.$ZodBranded<z.ZodNumber, "CustomerId", "out">;
+    arquivo: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    descricao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    usuario: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, z.core.$loose>>;
+/**
+ * The response of `GET /api/suporte/cliente/{cliente_id}/documento/list/`, in SGP's own shape: a
+ * bare array with one entry per document attached to the customer. The route is not paginated, so
+ * there is no envelope and no total. An empty array means no document.
+ */
+export type DocumentsListData = z.output<typeof documentsSchema>;
+/** INTERNAL definition of `documents.list`. */
+export declare const documentsList: OperationDefinition<DocumentsListData, "documents.list">;
+export {};

package/dist/operations/experimental-annotations-list.d.ts

@@ -0,0 +1,67 @@
+import { z } from "zod";
+import { type CustomerId } from "../ids.js";
+import type { OperationDefinition } from "../operation.js";
+declare const annotationSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    cliente: z.core.$ZodBranded<z.ZodNumber, "CustomerId", "out">;
+    clientecontrato: z.ZodNullable<z.ZodNumber>;
+    anotacao: z.ZodString;
+    usuario: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+    tipo: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+    alerta_modo: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+    data_cadastro: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    data_alteracao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, z.core.$loose>;
+/**
+ * One note SGP holds about a customer, as the local selection let it through: the typed fields
+ * (unknown keys included) plus `raw`, a deep copy of that one record exactly as SGP sent it, so a
+ * field that left its typed position with a warning stays recoverable there. A key named `raw` in
+ * SGP's record is shadowed by this one and is found at `raw.raw`. Free text and staff identity:
+ * see `getSensitivity("experimental.annotations.list")`; `raw` mirrors them and is personal data.
+ */
+export type ExperimentalAnnotation = z.output<typeof annotationSchema> & {
+    raw: Record<string, unknown>;
+};
+/**
+ * Notes of `experimental.annotations.list` that match the requested customer and/or contract, in
+ * the order and with the duplicates SGP sent. Empty when none matches.
+ */
+export type ExperimentalAnnotationsListData = ExperimentalAnnotation[];
+/**
+ * Filters of `experimental.annotations.list`, named as SGP names them. At least one is required,
+ * and both together mean AND (the intersection); nothing is ever sent without a filter.
+ */
+export type ExperimentalAnnotationsListInput = {
+    /** Only notes of this customer, those without a contract included. Positive safe integer. */
+    cliente_id: CustomerId;
+    /** Only notes of this contract. Positive safe integer. */
+    contrato_id?: number;
+} | {
+    /** Only notes of this customer, those without a contract included. Positive safe integer. */
+    cliente_id?: CustomerId;
+    /** Only notes of this contract. Positive safe integer. */
+    contrato_id: number;
+};
+/**
+ * INTERNAL. Validation of the input, exported so a test can check its keys are classified. A key it
+ * does not name is refused, not forwarded: the request can never be widened by the caller.
+ */
+export declare const experimentalAnnotationsListInputSchema: z.ZodObject<{
+    cliente_id: z.ZodOptional<z.core.$ZodBranded<z.ZodNumber, "CustomerId", "out">>;
+    contrato_id: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+declare const NAME = "experimental.annotations.list";
+/**
+ * INTERNAL. The registered face of `experimental.annotations.list`, which `getSensitivity` reads. It
+ * has no filters, so it fails closed: it refuses every input and decodes nothing. A call runs on
+ * {@link annotationsListFor}, which binds the filters the local selection needs.
+ */
+export declare const experimentalAnnotationsList: OperationDefinition<ExperimentalAnnotationsListData, typeof NAME>;
+/**
+ * INTERNAL. The definition of one call. The decoder selects locally, so it needs the filters of the
+ * call; the executor hands a decoder the body only. `buildRequest` receives the executor's snapshot
+ * of the caller's input and binds the filters of valid input here; anything else leaves the
+ * definition failing closed: it refuses the input and decodes nothing. One definition per call.
+ */
+export declare const annotationsListForCall: () => OperationDefinition<ExperimentalAnnotationsListData, typeof NAME>;
+export {};

package/dist/operations/invoices-list.d.ts

@@ -0,0 +1,148 @@
+import { z } from "zod";
+import { type CustomerId } from "../ids.js";
+import type { OperationDefinition } from "../operation.js";
+declare const pageSchema: z.ZodObject<{
+    paginacao: z.ZodObject<{
+        offset: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        limit: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        parcial: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        total: z.ZodNumber;
+    }, z.core.$loose>;
+    titulos: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        status: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        valor: z.ZodOptional<z.ZodPipe<z.ZodUnknown, z.ZodTransform<number | null, unknown>>>;
+        dataVencimento: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        clienteNome: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        clienteCpfcnpj: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        clienteContrato: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        portador: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        numeroDocumento: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>;
+        nossoNumero: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        link: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        link_cobranca: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        valorDesconto: z.ZodOptional<z.ZodPipe<z.ZodUnknown, z.ZodTransform<number | null, unknown>>>;
+        valorCorrigido: z.ZodOptional<z.ZodPipe<z.ZodUnknown, z.ZodTransform<number | null, unknown>>>;
+        valorPago: z.ZodOptional<z.ZodPipe<z.ZodUnknown, z.ZodTransform<number | null, unknown>>>;
+        valorPagoParcial: z.ZodOptional<z.ZodPipe<z.ZodUnknown, z.ZodTransform<number | null, unknown>>>;
+        codigoBarras: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        linhaDigitavel: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        codigoPix: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        dataEmissao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        dataPagamento: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        dataCancelamento: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        demonstrativo: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        acordoPagamento: z.ZodNullable<z.ZodOptional<z.ZodObject<{
+            acordados: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodUnknown>>>;
+            cobrados: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodUnknown>>>;
+        }, z.core.$loose>>>;
+        formaPagamento: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        usuario_baixa: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    }, z.core.$loose>>;
+}, z.core.$loose>;
+/**
+ * One page of `POST /api/ura/titulos/`, with SGP's own `paginacao`, returned as received:
+ *
+ * - `offset`: index of the first invoice of the page (SGP starts at 0);
+ * - `limit`: page size SGP applied, which may differ from the one requested (SGP caps it);
+ * - `parcial`: how many invoices this page holds (observed equal to `titulos.length`);
+ * - `total`: how many invoices match the filters in all, across every page.
+ *
+ * Money is normalized: `valor`, `valorDesconto`, `valorCorrigido`, `valorPago` and
+ * `valorPagoParcial` are a `number` (reais) or `null`. SGP sends `valor` as a number or as `""` for an
+ * absent amount (`null`, never `0`); numeric text with `.` is read as a number; formatted text such
+ * as `"1.234,56"` is never guessed: the field leaves `data` with a warning and stays in
+ * `response.body`. Changed versus 2.0.0-beta.1 (where `""` dropped the field).
+ *
+ * `total` is SGP's and never computed by the SDK: a page without a numeric `total` is
+ * `INVALID_RESPONSE`. Nothing here fetches the next page: ask for it with `offset`.
+ */
+export type InvoicesListData = z.output<typeof pageSchema>;
+/**
+ * Filters, paging and ordering of `invoices.list`, named as SGP names them (the choices are those
+ * of SGP's public collection). All optional; SGP decides how filters combine.
+ */
+export interface InvoicesListInput {
+    /** Index of the first invoice of the page; SGP starts at 0. Non-negative integer. */
+    offset?: number;
+    /** Invoices per page. Non-negative integer; SGP documents a maximum of 250 and caps larger values. */
+    limit?: number;
+    /** Only the invoice with this id. */
+    titulo_id?: number;
+    /** Only invoices of the customer with this id, a `CustomerId` (never the id of a contract). */
+    cliente_id?: CustomerId;
+    /** Only invoices of the customer with this CPF/CNPJ. */
+    cpfcnpj?: string;
+    /** Only invoices of this contract. */
+    contrato?: number;
+    /** Only open (`abertos`), paid (`pagos`) or cancelled (`cancelados`) invoices. */
+    status?: "abertos" | "pagos" | "cancelados";
+    /** Only invoices issued through this billing profile (portador) id. */
+    portador?: number;
+    /** Field the invoices are ordered by. */
+    ordenar?: "data_documento" | "data_vencimento" | "data_pagamento";
+    /** Ascending or descending order. */
+    ordenar_ordem?: "asc" | "desc";
+    /** CNPJ of the company that issued the invoices; several allowed, separated by comma. */
+    empresa_cnpj?: string;
+    /** Person type: F (individual), J (company), E (foreign individual), EJ (foreign company). */
+    tipo_pessoa?: "F" | "J" | "E" | "EJ";
+    /** Initial due date, `AAAA-MM-DD`; SGP requires it when `data_vencimento_fim` is sent. */
+    data_vencimento_inicio?: string;
+    /** Final due date, `AAAA-MM-DD`. */
+    data_vencimento_fim?: string;
+    /** Initial payment date, `AAAA-MM-DD`; SGP requires it when `data_pagamento_fim` is sent. */
+    data_pagamento_inicio?: string;
+    /** Final payment date, `AAAA-MM-DD`. */
+    data_pagamento_fim?: string;
+    /** Initial cancellation date, `AAAA-MM-DD`; alone, SGP matches invoices cancelled that day. */
+    data_cancelamento_inicio?: string;
+    /** Final cancellation date, `AAAA-MM-DD`; use with the initial one. */
+    data_cancelamento_fim?: string;
+    /** Initial date payment-agreement invoices were generated, `AAAA-MM-DD`; alone, matches that day. */
+    data_acordo_inicio?: string;
+    /** Final date payment-agreement invoices were generated, `AAAA-MM-DD`. */
+    data_acordo_fim?: string;
+}
+/** INTERNAL. Validation of the input, exported so a test can check its keys are classified. */
+export declare const invoicesListInputSchema: z.ZodObject<{
+    offset: z.ZodOptional<z.ZodNumber>;
+    limit: z.ZodOptional<z.ZodNumber>;
+    titulo_id: z.ZodOptional<z.ZodNumber>;
+    cliente_id: z.ZodOptional<z.core.$ZodBranded<z.ZodNumber, "CustomerId", "out">>;
+    cpfcnpj: z.ZodOptional<z.ZodString>;
+    contrato: z.ZodOptional<z.ZodNumber>;
+    status: z.ZodOptional<z.ZodEnum<{
+        abertos: "abertos";
+        cancelados: "cancelados";
+        pagos: "pagos";
+    }>>;
+    portador: z.ZodOptional<z.ZodNumber>;
+    ordenar: z.ZodOptional<z.ZodEnum<{
+        data_documento: "data_documento";
+        data_pagamento: "data_pagamento";
+        data_vencimento: "data_vencimento";
+    }>>;
+    ordenar_ordem: z.ZodOptional<z.ZodEnum<{
+        asc: "asc";
+        desc: "desc";
+    }>>;
+    empresa_cnpj: z.ZodOptional<z.ZodString>;
+    tipo_pessoa: z.ZodOptional<z.ZodEnum<{
+        E: "E";
+        EJ: "EJ";
+        F: "F";
+        J: "J";
+    }>>;
+    data_vencimento_inicio: z.ZodOptional<z.ZodString>;
+    data_vencimento_fim: z.ZodOptional<z.ZodString>;
+    data_pagamento_inicio: z.ZodOptional<z.ZodString>;
+    data_pagamento_fim: z.ZodOptional<z.ZodString>;
+    data_cancelamento_inicio: z.ZodOptional<z.ZodString>;
+    data_cancelamento_fim: z.ZodOptional<z.ZodString>;
+    data_acordo_inicio: z.ZodOptional<z.ZodString>;
+    data_acordo_fim: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/** INTERNAL definition of `invoices.list`. */
+export declare const invoicesList: OperationDefinition<InvoicesListData, "invoices.list">;
+export {};

package/dist/operations/maintenance-list.d.ts

@@ -0,0 +1,35 @@
+import { z } from "zod";
+import type { OperationDefinition } from "../operation.js";
+declare const maintenancesSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    descricao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    data_inicial: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    data_final: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    observacoes: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    mensagem_central: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    mensagem_ura: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    enviar_sms: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    ativa: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    severidade: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    status: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    pops: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodUnknown>>>;
+    nas: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodUnknown>>>;
+    aps: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodUnknown>>>;
+    sources: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodUnknown>>>;
+    switches: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodUnknown>>>;
+    olts: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodUnknown>>>;
+    oltpons: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodUnknown>>>;
+    ctos: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodUnknown>>>;
+    vlans: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodUnknown>>>;
+}, z.core.$loose>>;
+/**
+ * The response of `GET /api/ura/manutencao/list/`, in SGP's own shape: a bare array with one entry
+ * per maintenance notice (SGP "manutenção"), INACTIVE ONES INCLUDED (the one capture held three
+ * past notices, all with `ativa: false`). The route takes no filter, is not paginated and has no
+ * envelope or total: filter by `ativa` and by the period (`data_inicial`, `data_final`) yourself.
+ * An empty array means no notice.
+ */
+export type MaintenanceListData = z.output<typeof maintenancesSchema>;
+/** INTERNAL definition of `maintenance.list`. */
+export declare const maintenanceList: OperationDefinition<MaintenanceListData, "maintenance.list">;
+export {};