sgp-sdk 1.1.3 → 2.0.0-beta.1

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

@@ -0,0 +1,14 @@
+import { z } from "zod";
+import type { OperationDefinition } from "../operation.js";
+declare const popsSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    pop: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, z.core.$loose>>;
+/**
+ * The response of `POST /api/ura/pops/`, in SGP's own shape: a bare array with one entry per POP
+ * (point of presence). The route is not paginated, so there is no envelope and no total.
+ */
+export type CatalogsListPopsData = z.output<typeof popsSchema>;
+/** INTERNAL definition of `catalogs.listPops`. */
+export declare const catalogsListPops: OperationDefinition<CatalogsListPopsData, "catalogs.listPops">;
+export {};

package/dist/operations/contracts-list-status-reasons.d.ts

@@ -0,0 +1,15 @@
+import { z } from "zod";
+import type { OperationDefinition } from "../operation.js";
+declare const statusReasonsSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    motivo: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, z.core.$loose>>;
+/**
+ * The response of `POST /api/ura/contrato/status/motivos/`, in SGP's own shape: a bare array of
+ * `{ id, motivo }`, one entry per reason the provider can register with a status change. Each
+ * provider has its own list. The route is not paginated, so there is no envelope and no total.
+ */
+export type ContractsListStatusReasonsData = z.output<typeof statusReasonsSchema>;
+/** INTERNAL definition of `contracts.listStatusReasons`. */
+export declare const contractsListStatusReasons: OperationDefinition<ContractsListStatusReasonsData, "contracts.listStatusReasons">;
+export {};

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

@@ -0,0 +1,52 @@
+import { z } from "zod";
+import type { OperationDefinition } from "../operation.js";
+import type { PlanId } from "./plans-list.js";
+declare const contractsSchema: z.ZodArray<z.ZodObject<{
+    id_contrato: z.ZodNumber;
+    id_cliente: z.core.$ZodBranded<z.ZodNumber, "CustomerId", "out">;
+    status: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    pop_id: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+    nome: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    cpfcnpj: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    email: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    telefone: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    data_status: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    data_cadastro: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    motivo_status: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, z.core.$loose>>;
+/**
+ * The response of `POST /api/ura/listacontrato/`, in SGP's own shape: a bare array with one summary
+ * per matching contract. The route is not paginated, so there is no `paginacao`, no total and no
+ * envelope. An empty array means no contract matched.
+ */
+export type ContractsListData = z.output<typeof contractsSchema>;
+/** Filters of `contracts.list`, named as SGP names them. All optional. */
+export interface ContractsListInput {
+    /** Only the contract with this id. */
+    contrato?: number;
+    /**
+     * Only contracts linked to this plan. The id comes from `plans.list` (the catalog of existing
+     * services and contracts), never from `preRegistrations.listPlans`.
+     */
+    plano?: PlanId;
+    /** Person type, as SGP names it (see SGP's public documentation for the values). */
+    tipo?: string;
+    /** Contract status code (see `CONTRACT_STATUS`; any number is sent). */
+    status?: number;
+    /**
+     * Ask SGP to include the address. The address fields were never captured: they reach `data` as
+     * received but untyped, and they are personal data (see `getSensitivity`; use `pick`).
+     */
+    exibir_endereco?: boolean;
+}
+/** INTERNAL. Validation of the input, exported so a test can check its keys are classified. */
+export declare const contractsListInputSchema: z.ZodObject<{
+    contrato: z.ZodOptional<z.ZodNumber>;
+    plano: z.ZodOptional<z.ZodNumber>;
+    tipo: z.ZodOptional<z.ZodString>;
+    status: z.ZodOptional<z.ZodNumber>;
+    exibir_endereco: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+/** INTERNAL definition of `contracts.list`. */
+export declare const contractsList: OperationDefinition<ContractsListData, "contracts.list">;
+export {};

package/dist/operations/contracts-update-status.d.ts

@@ -0,0 +1,41 @@
+import { z } from "zod";
+import type { OperationDefinition } from "../operation.js";
+/**
+ * Input of `contracts.updateStatus`, named as SGP names the fields. Both codes are sent as given:
+ * SGP decides what it takes and which transitions it allows.
+ */
+export interface ContractUpdateStatusInput {
+    /** Exercised. ID of the contract (the `id` of `customers.list` -> `contratos[]`). */
+    contrato: number;
+    /** Exercised with 1 and 4. Status code to move to (`CONTRACT_STATUS`); any number is sent. */
+    status: number;
+    /**
+     * Documented, always sent in observed calls (1 and 5); a call without it was never exercised.
+     * ID of the reason (motivo de status) registered with the change. The list is the provider's
+     * own: read it with `contracts.listStatusReasons`, never assume a value. Omitted: no `motivo`
+     * is sent.
+     */
+    motivo?: number;
+}
+/** INTERNAL. Validation of the input, exported so a test can check it against the public type. */
+export declare const contractsUpdateStatusInputSchema: z.ZodObject<{
+    contrato: z.ZodNumber;
+    status: z.ZodNumber;
+    motivo: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+/**
+ * Success body of `POST /api/ura/contrato/status/edit/`: SGP's `resposta`, which names the contract
+ * and the status it is in now. Other keys SGP may add are kept.
+ */
+declare const statusChangedSchema: z.ZodObject<{
+    resposta: z.ZodObject<{
+        mensagem: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        contrato: z.ZodNumber;
+        contrato_status: z.ZodString;
+    }, z.core.$loose>;
+}, z.core.$loose>;
+/** Response of `contracts.updateStatus`. */
+export type ContractUpdateStatusData = z.output<typeof statusChangedSchema>;
+/** INTERNAL definition of `contracts.updateStatus`. */
+export declare const contractsUpdateStatus: OperationDefinition<ContractUpdateStatusData, "contracts.updateStatus">;
+export {};

package/dist/operations/contracts-update.d.ts

@@ -0,0 +1,39 @@
+import { z } from "zod";
+import type { OperationDefinition } from "../operation.js";
+/**
+ * Input of `contracts.update`. Only the field whose format and behavior are known is accepted: the
+ * other keys the vendor documents (`portador`, `debito_*`, `sms_desativado`, `tag_add`,
+ * `tag_remove`) have no known types, so they stay reachable through `request()` until documented.
+ */
+export interface ContractUpdateInput {
+    /** Exercised. ID of the contract (the `id` of `customers.list` -> `contratos[]`). */
+    contrato: number;
+    /**
+     * Exercised with 3 and 1. Billing-method code (`BILLING_METHOD`: 1 boleto, 2 automatic debit, 3
+     * booklet, 4 recurring charge, 6 PIX); any number is sent as given. Code 5 appears in SGP's panel
+     * select for this route only and was never confirmed, so it has no constant. Changing it changes
+     * how the contract is billed.
+     */
+    forma_cobranca: number;
+}
+/** INTERNAL. Validation of the input, exported so a test can check it against the public type. */
+export declare const contractsUpdateInputSchema: z.ZodObject<{
+    contrato: z.ZodNumber;
+    forma_cobranca: z.ZodNumber;
+}, z.core.$strict>;
+/**
+ * Success body of `POST /api/ura/contrato/edit/`: SGP's `resposta`, with the contract and the list
+ * of fields SGP says it applied (`alterados`, returned as-is). Other keys SGP may add are kept.
+ */
+declare const contractUpdatedSchema: z.ZodObject<{
+    resposta: z.ZodObject<{
+        mensagem: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        contrato: z.ZodNumber;
+        alterados: z.ZodArray<z.ZodString>;
+    }, z.core.$loose>;
+}, z.core.$loose>;
+/** Response of `contracts.update`. */
+export type ContractUpdateData = z.output<typeof contractUpdatedSchema>;
+/** INTERNAL definition of `contracts.update`. */
+export declare const contractsUpdate: OperationDefinition<ContractUpdateData, "contracts.update">;
+export {};

package/dist/operations/coverage-check.d.ts

@@ -0,0 +1,42 @@
+import { z } from "zod";
+import type { OperationDefinition } from "../operation.js";
+/** Input of `coverage.check`, named as SGP names the fields. All three are required. */
+export interface CoverageCheckInput {
+    /**
+     * Exercised. ID of the map gateway SGP checks against. SGP lists them at
+     * `/api/ura/listgatewaymapa`, which has no method here yet (use `request()`).
+     */
+    gateway: number;
+    /** Exercised. Search radius in meters. */
+    raio: number;
+    /**
+     * Exercised. The coordinate to check, `"lat,lng"` (for example `"-23.55,-46.63"`). The SDK does
+     * not geocode: bring the coordinate yourself. Sent as given; SGP decides what it accepts.
+     */
+    coordenada: string;
+}
+/** INTERNAL. Validation of the input, exported so a test can check it against the public type. */
+export declare const coverageCheckInputSchema: z.ZodObject<{
+    gateway: z.ZodNumber;
+    raio: z.ZodNumber;
+    coordenada: z.ZodString;
+}, z.core.$strict>;
+declare const ctoSchema: z.ZodObject<{
+    lat: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>;
+    lng: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>;
+    distancia: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>;
+    id: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodString]>>>;
+    nome: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, z.core.$loose>;
+/** One CTO (the nearest network box) within the radius, as the gateway reports it. */
+export type CoverageCto = z.output<typeof ctoSchema>;
+/**
+ * The response of `GET /api/ura/viabilidadeinstalacao`, in SGP's own shape: an array whose
+ * element is an object keyed by the gateway's own name (`"SGPMaps"`, `"Geogrid"`: data-defined),
+ * holding either the CTOs within the radius or a message (`"Localização inviável"`) when there
+ * are none. Nothing is converted: Geogrid's numeric strings stay strings.
+ */
+export type CoverageCheckData = Array<Record<string, string | CoverageCto[]>>;
+/** INTERNAL definition of `coverage.check`. */
+export declare const coverageCheck: OperationDefinition<CoverageCheckData, "coverage.check">;
+export {};

package/dist/operations/crm-contracts-create-by-cpf-cnpj.d.ts

@@ -0,0 +1,97 @@
+import type { OperationDefinition } from "../operation.js";
+import { type CrmContractCreateData, type CrmContractCreateInput } from "./crm-contracts-create.js";
+/**
+ * Input of `crm.contracts.createByCpfCnpj`: the contract of `crm.contracts.create`
+ * (see `CrmContractCreateInput` for every field and whether it was exercised) addressed by the
+ * customer's document instead of the customer id, so there is no `cliente_id`. The "Exercised"
+ * markers of those fields come from the by-id route: NO field of this input ever reached a success
+ * on this route (its only live call was refused).
+ */
+export interface CrmContractCreateByCpfCnpjInput extends Omit<CrmContractCreateInput, "cliente_id"> {
+    /**
+     * Exercised (live, with a CPF in digits only). Required. The document of the CRM customer, sent
+     * in the query string of the POST as `cpfcnpj`, SGP's own name for a field that takes either
+     * kind: the API decides whether it is a CPF or a CNPJ. Only a CPF was ever sent; a CNPJ is
+     * accepted by the field's name and was never exercised. Sent as given: digits or formatted
+     * (`123.456.789-00`). Personal data: never log it.
+     */
+    cpfcnpj: string;
+}
+/** INTERNAL. Validation of the input, exported so a test can check it against the public type. */
+export declare const crmContractsCreateByCpfCnpjInputSchema: import("zod").ZodObject<{
+    pop_id: import("zod").ZodNumber;
+    plano_id: import("zod/v4/core").$ZodBranded<import("zod").ZodNumber, "PlanId", "out">;
+    portador_id: import("zod").ZodNumber;
+    forma_cobranca_codigo: import("zod").ZodNumber;
+    vencimento_dia: import("zod").ZodNumber;
+    endereco_instalacao: import("zod").ZodObject<{
+        numero: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodString, import("zod").ZodNumber]>>;
+        complemento: import("zod").ZodOptional<import("zod").ZodString>;
+        pais: import("zod").ZodOptional<import("zod").ZodString>;
+        pontoreferencia: import("zod").ZodOptional<import("zod").ZodString>;
+        map_ll: import("zod").ZodOptional<import("zod").ZodString>;
+        condominio: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodString, import("zod").ZodNumber]>>;
+        logradouro: import("zod").ZodString;
+        bairro: import("zod").ZodString;
+        cidade: import("zod").ZodString;
+        cep: import("zod").ZodString;
+        uf: import("zod").ZodString;
+    }, import("zod/v4/core").$strict>;
+    endereco_cobranca: import("zod").ZodObject<{
+        numero: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodString, import("zod").ZodNumber]>>;
+        complemento: import("zod").ZodOptional<import("zod").ZodString>;
+        pais: import("zod").ZodOptional<import("zod").ZodString>;
+        pontoreferencia: import("zod").ZodOptional<import("zod").ZodString>;
+        map_ll: import("zod").ZodOptional<import("zod").ZodString>;
+        condominio: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodString, import("zod").ZodNumber]>>;
+        logradouro: import("zod").ZodString;
+        bairro: import("zod").ZodString;
+        cidade: import("zod").ZodString;
+        cep: import("zod").ZodString;
+        uf: import("zod").ZodString;
+    }, import("zod/v4/core").$strict>;
+    login: import("zod").ZodOptional<import("zod").ZodString>;
+    senha: import("zod").ZodOptional<import("zod").ZodString>;
+    modoaquisicao: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<0>, import("zod").ZodLiteral<1>]>>;
+    nas: import("zod").ZodOptional<import("zod").ZodString>;
+    isento: import("zod").ZodOptional<import("zod").ZodNumber>;
+    autocobranca: import("zod").ZodOptional<import("zod").ZodBoolean>;
+    servicodesc: import("zod").ZodOptional<import("zod").ZodString>;
+    observacao: import("zod").ZodOptional<import("zod").ZodString>;
+    vendedor_id: import("zod").ZodOptional<import("zod").ZodNumber>;
+    comissao_tipo: import("zod").ZodOptional<import("zod").ZodUnion<readonly [import("zod").ZodLiteral<1>, import("zod").ZodLiteral<2>]>>;
+    comissao: import("zod").ZodOptional<import("zod").ZodNumber>;
+    contrato_id: import("zod").ZodOptional<import("zod").ZodNumber>;
+    fidelidade_id: import("zod").ZodOptional<import("zod").ZodNumber>;
+    midia_id: import("zod").ZodOptional<import("zod").ZodNumber>;
+    central_login: import("zod").ZodOptional<import("zod").ZodString>;
+    central_senha: import("zod").ZodOptional<import("zod").ZodString>;
+    ip: import("zod").ZodOptional<import("zod").ZodString>;
+    ippool_id: import("zod").ZodOptional<import("zod").ZodNumber>;
+    mac_dhcp: import("zod").ZodOptional<import("zod").ZodString>;
+    mac: import("zod").ZodOptional<import("zod").ZodString>;
+    logins_simult: import("zod").ZodOptional<import("zod").ZodNumber>;
+    splitter_id: import("zod").ZodOptional<import("zod").ZodNumber>;
+    splitter_port: import("zod").ZodOptional<import("zod").ZodNumber>;
+    tipo_equipamento: import("zod").ZodOptional<import("zod").ZodString>;
+    usuarioalt_id: import("zod").ZodOptional<import("zod").ZodNumber>;
+    os_instalacao: import("zod").ZodOptional<import("zod").ZodBoolean>;
+    conteudo: import("zod").ZodOptional<import("zod").ZodString>;
+    instalacao_quantidade_parcelas: import("zod").ZodOptional<import("zod").ZodNumber>;
+    instalacao_preco: import("zod").ZodOptional<import("zod").ZodNumber>;
+    instalacao_desconto: import("zod").ZodOptional<import("zod").ZodNumber>;
+    instalacao_entrada: import("zod").ZodOptional<import("zod").ZodNumber>;
+    instalacao_entrada_forma: import("zod").ZodOptional<import("zod").ZodNumber>;
+    instalacao_parcela_forma: import("zod").ZodOptional<import("zod").ZodNumber>;
+    instalacao_portador: import("zod").ZodOptional<import("zod").ZodNumber>;
+    cpfcnpj: import("zod").ZodString;
+}, import("zod/v4/core").$strict>;
+/**
+ * Response of `crm.contracts.createByCpfCnpj`. DOCUMENTED, NOT OBSERVED: the only call ever made to
+ * this route was refused (400), so a success was never seen. It is assumed to answer like
+ * `crm.contracts.create` (`{ message, clientecontrato, cliente }`), which is what the vendor's
+ * route family does; a 2xx without a numeric `clientecontrato` is `INVALID_RESPONSE`.
+ */
+export type CrmContractCreateByCpfCnpjData = CrmContractCreateData;
+/** INTERNAL definition of `crm.contracts.createByCpfCnpj`. */
+export declare const crmContractsCreateByCpfCnpj: OperationDefinition<CrmContractCreateByCpfCnpjData, "crm.contracts.createByCpfCnpj">;

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

@@ -0,0 +1,221 @@
+import { z } from "zod";
+import { type SgpAddress } from "../address.js";
+import type { AcquisitionMode } from "../constants.js";
+import { type CustomerId } from "../ids.js";
+import type { OperationDefinition } from "../operation.js";
+import type { OperationSensitivity } from "../sensitivity.js";
+import type { PlanId } from "./plans-list.js";
+/** The address of a CRM contract: the vendor requires these five keys, for both addresses. */
+interface CrmContractAddress extends SgpAddress {
+    logradouro: string;
+    bairro: string;
+    cidade: string;
+    cep: string;
+    uf: string;
+}
+/**
+ * Input of `crm.contracts.create`, named as SGP names the fields. Only the fields the vendor's
+ * documentation marks as required are required here; the rest is optional. Each field says
+ * "Exercised" when a live call sent it (a live contract call and the 1.x live-tested contract) or
+ * "Documented" when only the vendor's documentation lists it and it was never sent.
+ */
+export interface CrmContractCreateInput {
+    /** ID of the CRM customer (the `cliente_id` of `crm.customers.create`). Goes in the path. */
+    cliente_id: CustomerId;
+    /** Exercised. Required. POP ID. */
+    pop_id: number;
+    /** Exercised. Required. Plan ID of the URA catalog (`plans.list`), a `PlanId`. */
+    plano_id: PlanId;
+    /** Exercised. Required. Payer or financial responsible (billing profile, `portador`) ID. */
+    portador_id: number;
+    /**
+     * Exercised with 1. Required. Billing-method code (`BILLING_METHOD`: 1 boleto, 2 automatic debit, 3 booklet, 4
+     * recurring charge, 6 PIX); any number is sent as given.
+     */
+    forma_cobranca_codigo: number;
+    /** Exercised. Required. Due day of the month (a day, not an ID). */
+    vencimento_dia: number;
+    /** Exercised. Required. Sent nested (`endereco_instalacao`) and also as loose fields, as SGP reads both. */
+    endereco_instalacao: CrmContractAddress;
+    /** Exercised. Required. Sent nested (`endereco_cobranca`) only. */
+    endereco_cobranca: CrmContractAddress;
+    /**
+     * Exercised. PPPoE login. The vendor requires it, with `senha` and `modoaquisicao`, for an
+     * Internet service; the SDK cannot tell a plan's type, so it leaves them optional (the refusal
+     * for their absence was never observed). Secret: never log it.
+     */
+    login?: string;
+    /** Exercised. PPPoE password; see `login`. Secret: never log it. */
+    senha?: string;
+    /**
+     * Exercised with 1. Equipment situation: `ACQUISITION_MODE` (0 owned, 1 loan), the constant shared with
+     * `preRegistrations.create`. The vendor's CRM documentation lists 1 and 2, but SGP refused 2 on
+     * this route (live, 31/10: `{ errors: { modoaquisicao: "Modo de aquisição inválido." } }`); no
+     * other value is known to be valid, so the SDK accepts only 0 and 1.
+     */
+    modoaquisicao?: AcquisitionMode;
+    /**
+     * Exercised. NAS name (text, not `nas_id`). SGP requires it for an Internet service (live: 400
+     * `{ errors: { nas: "O campo 'nas' é obrigatório para serviço de Internet." } }`).
+     */
+    nas?: string;
+    /** Exercised with 100. Exempt percentage. */
+    isento?: number;
+    /** Exercised with `false`. Whether SGP charges the contract automatically. */
+    autocobranca?: boolean;
+    /** Documented. Details of the requested service. Free text: personal data. */
+    servicodesc?: string;
+    /** Documented. Free-text note. Personal data. */
+    observacao?: string;
+    /** Documented. Seller ID. */
+    vendedor_id?: number;
+    /** Documented. `1` percentage, `2` fixed amount. */
+    comissao_tipo?: 1 | 2;
+    /** Documented. Commission, in the unit of `comissao_tipo`. */
+    comissao?: number;
+    /** Documented. Contract group for printing. */
+    contrato_id?: number;
+    /** Documented. Loyalty (fidelidade) ID. */
+    fidelidade_id?: number;
+    /** Documented. "How did you hear about us" ID. */
+    midia_id?: number;
+    /** Documented. Login of the customer's central. Secret: never log it. */
+    central_login?: string;
+    /** Documented. Password of the customer's central. Secret: never log it. */
+    central_senha?: string;
+    /** Documented. Fixed IP of the contract. Network identifier: secret. */
+    ip?: string;
+    /** Documented. IP pool ID. */
+    ippool_id?: number;
+    /** Documented. MAC address for DHCP. Network identifier: secret. */
+    mac_dhcp?: string;
+    /** Documented. MAC address of the equipment. Network identifier: secret. */
+    mac?: string;
+    /** Documented. Number of simultaneous logins. */
+    logins_simult?: number;
+    /** Documented. Splitter ID. */
+    splitter_id?: number;
+    /** Documented. Splitter port. */
+    splitter_port?: number;
+    /** Documented. Equipment type. */
+    tipo_equipamento?: string;
+    /** Documented. ID of the user responsible for the change. */
+    usuarioalt_id?: number;
+    /** Exercised with `true`. Opens the installation work order, without a date. */
+    os_instalacao?: boolean;
+    /** Exercised. Text of the installation occurrence. */
+    conteudo?: string;
+    /** Exercised with 0. Number of installments of the installation. */
+    instalacao_quantidade_parcelas?: number;
+    /** Exercised with 0. Installation price, in reais. */
+    instalacao_preco?: number;
+    /** Documented. Discount over the installation price. */
+    instalacao_desconto?: number;
+    /** Documented. Down payment of the installation. */
+    instalacao_entrada?: number;
+    /** Documented. Payment form of the down payment. */
+    instalacao_entrada_forma?: number;
+    /** Documented. Payment form of the installments. */
+    instalacao_parcela_forma?: number;
+    /** Documented. Billing profile (portador) ID of the installation. */
+    instalacao_portador?: number;
+}
+/** INTERNAL. Validation of the input, exported so a test can check it against the public type. */
+export declare const crmContractsCreateInputSchema: z.ZodObject<{
+    cliente_id: z.core.$ZodBranded<z.ZodNumber, "CustomerId", "out">;
+    pop_id: z.ZodNumber;
+    plano_id: z.core.$ZodBranded<z.ZodNumber, "PlanId", "out">;
+    portador_id: z.ZodNumber;
+    forma_cobranca_codigo: z.ZodNumber;
+    vencimento_dia: z.ZodNumber;
+    endereco_instalacao: 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>;
+    endereco_cobranca: 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>;
+    login: z.ZodOptional<z.ZodString>;
+    senha: z.ZodOptional<z.ZodString>;
+    modoaquisicao: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<1>]>>;
+    nas: z.ZodOptional<z.ZodString>;
+    isento: z.ZodOptional<z.ZodNumber>;
+    autocobranca: z.ZodOptional<z.ZodBoolean>;
+    servicodesc: z.ZodOptional<z.ZodString>;
+    observacao: z.ZodOptional<z.ZodString>;
+    vendedor_id: z.ZodOptional<z.ZodNumber>;
+    comissao_tipo: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<1>, z.ZodLiteral<2>]>>;
+    comissao: z.ZodOptional<z.ZodNumber>;
+    contrato_id: z.ZodOptional<z.ZodNumber>;
+    fidelidade_id: z.ZodOptional<z.ZodNumber>;
+    midia_id: z.ZodOptional<z.ZodNumber>;
+    central_login: z.ZodOptional<z.ZodString>;
+    central_senha: z.ZodOptional<z.ZodString>;
+    ip: z.ZodOptional<z.ZodString>;
+    ippool_id: z.ZodOptional<z.ZodNumber>;
+    mac_dhcp: z.ZodOptional<z.ZodString>;
+    mac: z.ZodOptional<z.ZodString>;
+    logins_simult: z.ZodOptional<z.ZodNumber>;
+    splitter_id: z.ZodOptional<z.ZodNumber>;
+    splitter_port: z.ZodOptional<z.ZodNumber>;
+    tipo_equipamento: z.ZodOptional<z.ZodString>;
+    usuarioalt_id: z.ZodOptional<z.ZodNumber>;
+    os_instalacao: z.ZodOptional<z.ZodBoolean>;
+    conteudo: z.ZodOptional<z.ZodString>;
+    instalacao_quantidade_parcelas: z.ZodOptional<z.ZodNumber>;
+    instalacao_preco: z.ZodOptional<z.ZodNumber>;
+    instalacao_desconto: z.ZodOptional<z.ZodNumber>;
+    instalacao_entrada: z.ZodOptional<z.ZodNumber>;
+    instalacao_entrada_forma: z.ZodOptional<z.ZodNumber>;
+    instalacao_parcela_forma: z.ZodOptional<z.ZodNumber>;
+    instalacao_portador: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+/**
+ * INTERNAL. The JSON body of a CRM contract, shared by the two routes that take it: both addresses
+ * nested, the installation one also as loose fields beside them (as 1.x). `fields` is the validated
+ * input without the customer reference (the path id of this route, the query document of the other).
+ */
+export declare const crmContractBody: ({ endereco_instalacao, endereco_cobranca, ...fields }: Omit<z.output<typeof crmContractsCreateInputSchema>, "cliente_id">) => Record<string, unknown>;
+/**
+ * Success body of `POST /api/crm/cliente/{cliente_id}/contratos/`: SGP's `message`, the new
+ * contract's id (`clientecontrato`) and the customer's name. Other keys SGP may add are kept.
+ * INTERNAL: `crm.contracts.createByCpfCnpj` takes the same shape (documented, never observed there).
+ */
+export declare const crmContractCreatedSchema: z.ZodObject<{
+    message: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    clientecontrato: z.ZodNumber;
+    cliente: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, z.core.$loose>;
+/** The one key a 200 must have to be taken as the creation answer. */
+export declare const crmContractCreatedInvariants: readonly ["clientecontrato"];
+/** Response of `crm.contracts.create`. */
+export type CrmContractCreateData = z.output<typeof crmContractCreatedSchema>;
+/**
+ * PPPoE and Central logins and passwords and the network identifiers (IP, MAC) are secrets; the
+ * addresses, the free texts and the customer's name in the 200 are personal. The rest are ids,
+ * codes, flags and money. INTERNAL: shared with `crm.contracts.createByCpfCnpj`, which sends the
+ * same body.
+ */
+export declare const crmContractsCreateSensitivity: OperationSensitivity;
+/** INTERNAL definition of `crm.contracts.create`. */
+export declare const crmContractsCreate: OperationDefinition<CrmContractCreateData, "crm.contracts.create">;
+export {};

package/dist/operations/crm-contracts-list.d.ts

@@ -0,0 +1,50 @@
+import { z } from "zod";
+import type { OperationDefinition } from "../operation.js";
+/** Input of `crm.contracts.list`, named as SGP names the field. */
+export interface CrmContractsListInput {
+    /**
+     * Exercised (live, with a CPF in digits only). Required. The document of the CRM customer, sent as
+     * `cpfcnpj`, SGP's own name for a field that takes either kind: the API decides whether it is a
+     * CPF or a CNPJ. Only a CPF was ever sent; a CNPJ is accepted by the field's name and was never
+     * exercised. Sent as given: digits or formatted (`123.456.789-00`). Personal data: never log it.
+     */
+    cpfcnpj: string;
+}
+/** INTERNAL. Validation of the input, exported so a test can check it against the public type. */
+export declare const crmContractsListInputSchema: z.ZodObject<{
+    cpfcnpj: z.ZodString;
+}, z.core.$strict>;
+declare const contractsSchema: z.ZodObject<{
+    cliente: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    cpf_cnpj: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    contratos: z.ZodArray<z.ZodObject<{
+        cliente_contrato_id: z.ZodNumber;
+        data_cadastro: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        vencimento_dia: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        pop: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        endereco: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        forma_cobranca: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        status: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        data_status: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        modo_status: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        motivo_status: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        vendedor: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        servicos: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+            plano: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            login: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            contrato_tipo: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            situacao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            aquisicao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        }, z.core.$loose>>>>;
+    }, z.core.$loose>>;
+}, z.core.$loose>;
+/**
+ * Response of `GET /api/crm/cliente/contratos/`, in SGP's own shape: the customer's `cliente` and
+ * `cpf_cnpj` (personal data) and `contratos`, one summary per contract, empty when the CRM customer
+ * has none. `data_cadastro` and `data_status` are `DD/MM/AAAA` strings, kept as SGP writes them.
+ * Unknown keys reach `data` as received.
+ */
+export type CrmContractsListData = z.output<typeof contractsSchema>;
+/** INTERNAL definition of `crm.contracts.list`. */
+export declare const crmContractsList: OperationDefinition<CrmContractsListData, "crm.contracts.list">;
+export {};