sgp-sdk 1.1.3 → 2.0.0-beta.1

package/dist/operations/crm-customers-create.d.ts

@@ -0,0 +1,155 @@
+import { z } from "zod";
+import { type SgpAddress } from "../address.js";
+import type { OperationDefinition } from "../operation.js";
+/** The address of a CRM customer: the vendor requires these five keys. */
+interface CrmCustomerAddress extends SgpAddress {
+    logradouro: string;
+    bairro: string;
+    cidade: string;
+    cep: string;
+    uf: string;
+}
+/**
+ * Fields common to both person types. All of them are personal data. Each field says "Exercised"
+ * when a live call sent it or "Documented" when only the vendor's documentation lists it.
+ */
+interface CrmCustomerCreateCommon {
+    /** Exercised. Customer name; for a company, its corporate name. Required. SGP refuses digits in it (400). */
+    nome: string;
+    /** Exercised. CPF (`F`) or CNPJ (`J`), in the format SGP stores it. Required. */
+    cpfcnpj: string;
+    /** Exercised. Required. Sent nested (`endereco`) and also as loose fields beside it, the two formats the route reads. */
+    endereco: CrmCustomerAddress;
+    /** Documented. Contact e-mail. */
+    email?: string;
+    /** Documented. Contact phone. */
+    celular?: string;
+    /** Documented. Free-text note. */
+    observacao?: string;
+}
+/** `POST /api/crm/cliente/F`: a natural person. */
+export interface CrmCustomerCreateIndividualInput extends CrmCustomerCreateCommon {
+    /** Selects the route `/F`; not sent as a field. */
+    personType: "F";
+    /** Documented. Birth date, `DD/MM/AAAA`. */
+    datanasc?: string;
+    /** Documented. Identity document number. */
+    rg?: string;
+    /** Documented. Issuer of the identity document. */
+    rg_emissor?: string;
+    /** Documented. `M` male, `F` female. */
+    sexo?: "M" | "F";
+    /** Documented. `C` married, `S` single, `V` widowed, `D` divorced. */
+    estadocivil?: "C" | "S" | "V" | "D";
+    /** Documented. Mother's name. */
+    nomemae?: string;
+    /** Documented. Father's name. */
+    nomepai?: string;
+    /** Documented. Occupation. */
+    profissao?: string;
+    /** Documented. Nationality. */
+    nacionalidade?: string;
+    /** Documented. Place of birth. */
+    naturalidade?: string;
+}
+/** `POST /api/crm/cliente/J`: a company. Documented only: never exercised against SGP. */
+export interface CrmCustomerCreateCompanyInput extends CrmCustomerCreateCommon {
+    /** Selects the route `/J`; not sent as a field. */
+    personType: "J";
+    /** Documented. Trade name. */
+    nomefantasia?: string;
+    /** Documented. Name of the person responsible for the company. */
+    respempresa?: string;
+    /** Documented. CPF of the person responsible for the company. */
+    respcpf?: string;
+    /** Documented. State registration. */
+    insc_estadual?: string;
+    /** Documented. Municipal registration. */
+    insc_municipal?: string;
+    /** Documented. Foundation date, `DD/MM/AAAA`. */
+    datafundacao?: string;
+}
+/**
+ * Input of `crm.customers.create`. `personType` picks the route (`F` or `J`) and is not sent as a
+ * field; every other key is sent under its own name, absent ones omitted. Unknown keys are refused.
+ */
+export type CrmCustomerCreateInput = CrmCustomerCreateIndividualInput | CrmCustomerCreateCompanyInput;
+/** INTERNAL. Validation of the input, exported so a test can check it against the public types. */
+export declare const crmCustomersCreateInputSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    nome: z.ZodString;
+    cpfcnpj: z.ZodString;
+    endereco: z.ZodObject<{
+        numero: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+        complemento: z.ZodOptional<z.ZodString>;
+        pais: z.ZodOptional<z.ZodString>;
+        pontoreferencia: z.ZodOptional<z.ZodString>;
+        map_ll: z.ZodOptional<z.ZodString>;
+        condominio: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+        logradouro: z.ZodString;
+        bairro: z.ZodString;
+        cidade: z.ZodString;
+        cep: z.ZodString;
+        uf: z.ZodString;
+    }, z.core.$strict>;
+    email: z.ZodOptional<z.ZodString>;
+    celular: z.ZodOptional<z.ZodString>;
+    observacao: z.ZodOptional<z.ZodString>;
+    personType: z.ZodLiteral<"F">;
+    datanasc: z.ZodOptional<z.ZodString>;
+    rg: z.ZodOptional<z.ZodString>;
+    rg_emissor: z.ZodOptional<z.ZodString>;
+    sexo: z.ZodOptional<z.ZodEnum<{
+        F: "F";
+        M: "M";
+    }>>;
+    estadocivil: z.ZodOptional<z.ZodEnum<{
+        C: "C";
+        D: "D";
+        S: "S";
+        V: "V";
+    }>>;
+    nomemae: z.ZodOptional<z.ZodString>;
+    nomepai: z.ZodOptional<z.ZodString>;
+    profissao: z.ZodOptional<z.ZodString>;
+    nacionalidade: z.ZodOptional<z.ZodString>;
+    naturalidade: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>, z.ZodObject<{
+    nome: z.ZodString;
+    cpfcnpj: z.ZodString;
+    endereco: z.ZodObject<{
+        numero: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+        complemento: z.ZodOptional<z.ZodString>;
+        pais: z.ZodOptional<z.ZodString>;
+        pontoreferencia: z.ZodOptional<z.ZodString>;
+        map_ll: z.ZodOptional<z.ZodString>;
+        condominio: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+        logradouro: z.ZodString;
+        bairro: z.ZodString;
+        cidade: z.ZodString;
+        cep: z.ZodString;
+        uf: z.ZodString;
+    }, z.core.$strict>;
+    email: z.ZodOptional<z.ZodString>;
+    celular: z.ZodOptional<z.ZodString>;
+    observacao: z.ZodOptional<z.ZodString>;
+    personType: z.ZodLiteral<"J">;
+    nomefantasia: z.ZodOptional<z.ZodString>;
+    respempresa: z.ZodOptional<z.ZodString>;
+    respcpf: z.ZodOptional<z.ZodString>;
+    insc_estadual: z.ZodOptional<z.ZodString>;
+    insc_municipal: z.ZodOptional<z.ZodString>;
+    datafundacao: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>], "personType">;
+/**
+ * Success body of `POST /api/crm/cliente/{F|J}`: the new customer's `cliente_id` and SGP's
+ * `message`, which echoes the customer's name and document. Other keys SGP may add are kept.
+ */
+declare const createdSchema: z.ZodObject<{
+    cliente_id: z.core.$ZodBranded<z.ZodNumber, "CustomerId", "out">;
+    message: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, z.core.$loose>;
+/** Response of `crm.customers.create`. */
+export type CrmCustomerCreateData = z.output<typeof createdSchema>;
+/** INTERNAL definition of `crm.customers.create`. */
+export declare const crmCustomersCreate: OperationDefinition<CrmCustomerCreateData, "crm.customers.create">;
+export {};

package/dist/operations/crm-customers-update-status.d.ts

@@ -0,0 +1,41 @@
+import { z } from "zod";
+import { type CustomerId } from "../ids.js";
+import type { OperationDefinition } from "../operation.js";
+/**
+ * Input of `crm.customers.updateStatus`, named as SGP names the fields. The status code is sent as
+ * given: SGP decides what it takes and which transitions it allows.
+ */
+export interface CrmCustomerUpdateStatusInput {
+    /** ID of the CRM customer: the `cliente_id` of `crm.customers.create`. Goes in the path. */
+    cliente_id: CustomerId;
+    /**
+     * Exercised with 6. Status code to move to (`CRM_STATUS`: 6 is "Contrato realizado no SGP"); any
+     * number is sent.
+     */
+    status_id: number;
+    /** Documented, never sent. Free-text reason of the change. Personal data when it names the customer. */
+    motivo?: string;
+}
+/** INTERNAL. Validation of the input, exported so a test can check it against the public type. */
+export declare const crmCustomersUpdateStatusInputSchema: z.ZodObject<{
+    cliente_id: z.core.$ZodBranded<z.ZodNumber, "CustomerId", "out">;
+    status_id: z.ZodNumber;
+    motivo: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+/**
+ * Success body of `POST /api/crm/cliente/{cliente_id}/status/`: the customer, SGP's `message`
+ * (which echoes the customer's name) and the status now set. Other keys SGP may add are kept.
+ */
+declare const statusUpdatedSchema: z.ZodObject<{
+    cliente_id: z.core.$ZodBranded<z.ZodNumber, "CustomerId", "out">;
+    message: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    novo_status: z.ZodObject<{
+        codigo: z.ZodNumber;
+        descricao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    }, z.core.$loose>;
+}, z.core.$loose>;
+/** Response of `crm.customers.updateStatus`. */
+export type CrmCustomerUpdateStatusData = z.output<typeof statusUpdatedSchema>;
+/** INTERNAL definition of `crm.customers.updateStatus`. */
+export declare const crmCustomersUpdateStatus: OperationDefinition<CrmCustomerUpdateStatusData, "crm.customers.updateStatus">;
+export {};

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

@@ -0,0 +1,98 @@
+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;
+}
+/** 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>;
+}, 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 {};