sgp-sdk 1.2.0 → 2.0.0-beta.1

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

@@ -0,0 +1,142 @@
+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.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        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.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        valorCorrigido: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        valorPago: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        valorPagoParcial: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        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.
+ *
+ * `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/occurrences-create.d.ts

@@ -0,0 +1,116 @@
+import { z } from "zod";
+import type { OperationDefinition } from "../operation.js";
+/**
+ * Input of `occurrences.create`, named as SGP names the fields. An occurrence (SGP "chamado" or
+ * "ocorrência") is the support ticket; SGP opens a work order (OS) with it unless told not to
+ * (`desativa_os`). Only `contrato` is required.
+ */
+export interface OccurrenceCreateInput {
+    /** ID of the contract. Required. */
+    contrato: number;
+    /** Content of the occurrence and of the work order. Free text: personal data. */
+    conteudo?: string;
+    /** `1` removes SGP's default opening message ("via URA"). */
+    conteudolimpo?: 0 | 1;
+    /** Free text: personal data. */
+    observacao?: string;
+    /**
+     * Occurrence type code (SGP's default is 5): the `codigo` of `occurrences.listTypes`, not its
+     * `id`.
+     */
+    ocorrenciatipo?: number;
+    /** IDs of the classifications linked to the occurrence. */
+    tipoclassificacoes?: number[];
+    /** Occurrence method code: the `codigo` of `occurrences.listMethods`. */
+    metodo?: number;
+    /** Sector ID. */
+    setor?: number;
+    /** Username shown as who opened the occurrence. Staff username: personal data. */
+    usuario?: string;
+    /** Username of the occurrence's responsible. Staff username: personal data. */
+    responsaveloc?: string;
+    /** Contact name. Personal data. */
+    contato_nome?: string;
+    /** Contact phone. Personal data. */
+    contato_telefone?: string;
+    /** `1` opens no work order. */
+    desativa_os?: 0 | 1;
+    /** `1` creates the occurrence and the work order already closed. */
+    status_encerrado?: 0 | 1;
+    /** `1` notifies the customer of the closing, when created already closed. */
+    notificar_cliente?: 0 | 1;
+    /**
+     * Work-order reason code: the `codigo` of `workOrders.listReasons` (not its `id`; live, 10 was
+     * the reason whose `codigo` is 10 and `id` 1). Each SGP instance has its own: read them there,
+     * never assume a value.
+     */
+    motivoos?: number;
+    /** IDs of the classifications linked to the work order. */
+    motivoclassificacoes?: number[];
+    /** Username of the work order's responsible technician. Staff username: personal data. */
+    responsavel?: string;
+    /** Usernames of the auxiliary technicians. Staff usernames: personal data. */
+    tecnicos?: string[];
+    /** Schedules the occurrence and the work order: `AAAA-MM-DD HH:MM`. */
+    data_hora_agendamento?: string;
+    /** `1` warns the responsible technician; needs `data_hora_agendamento` and a messaging gateway in SGP. */
+    sms_tecnico?: 0 | 1;
+    /** With `servico_id`, links a service of the contract to the occurrence. */
+    tipo_servico?: "internet" | "telefonia" | "tv" | "multimidia" | "generico";
+    /** ID of the contract's service; use with `tipo_servico`. */
+    servico_id?: number;
+    /** ID of the company to link. */
+    empresa_id?: number;
+}
+/** INTERNAL. Validation of the input, exported so a test can check it against the public type. */
+export declare const occurrencesCreateInputSchema: z.ZodObject<{
+    contrato: z.ZodNumber;
+    conteudo: z.ZodOptional<z.ZodString>;
+    conteudolimpo: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<1>]>>;
+    observacao: z.ZodOptional<z.ZodString>;
+    ocorrenciatipo: z.ZodOptional<z.ZodNumber>;
+    tipoclassificacoes: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    metodo: z.ZodOptional<z.ZodNumber>;
+    setor: z.ZodOptional<z.ZodNumber>;
+    usuario: z.ZodOptional<z.ZodString>;
+    responsaveloc: z.ZodOptional<z.ZodString>;
+    contato_nome: z.ZodOptional<z.ZodString>;
+    contato_telefone: z.ZodOptional<z.ZodString>;
+    desativa_os: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<1>]>>;
+    status_encerrado: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<1>]>>;
+    notificar_cliente: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<1>]>>;
+    motivoos: z.ZodOptional<z.ZodNumber>;
+    motivoclassificacoes: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
+    responsavel: z.ZodOptional<z.ZodString>;
+    tecnicos: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    data_hora_agendamento: z.ZodOptional<z.ZodString>;
+    sms_tecnico: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<1>]>>;
+    tipo_servico: z.ZodOptional<z.ZodEnum<{
+        generico: "generico";
+        internet: "internet";
+        multimidia: "multimidia";
+        telefonia: "telefonia";
+        tv: "tv";
+    }>>;
+    servico_id: z.ZodOptional<z.ZodNumber>;
+    empresa_id: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+/**
+ * Success body of `POST /api/ura/chamado/`: `status` 1, the ticket's `protocolo` and `id`, plus the
+ * contract and the customer SGP echoes back. `id` is the ID of the OCCURRENCE: a work order, when
+ * one is opened, has another ID that this body does not carry. Other keys SGP may add are kept.
+ */
+declare const openedSchema: z.ZodObject<{
+    status: z.ZodLiteral<1>;
+    protocolo: z.ZodString;
+    id: z.ZodNumber;
+    contratoId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+    razaoSocial: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    cpfCnpj: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    msg: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, z.core.$loose>;
+/** Response of `occurrences.create`. */
+export type OccurrenceCreateData = z.output<typeof openedSchema>;
+/** INTERNAL definition of `occurrences.create`. */
+export declare const occurrencesCreate: OperationDefinition<OccurrenceCreateData, "occurrences.create">;
+export {};

package/dist/operations/occurrences-list-methods.d.ts

@@ -0,0 +1,14 @@
+import { z } from "zod";
+import type { OperationDefinition } from "../operation.js";
+declare const occurrenceMethodsSchema: z.ZodArray<z.ZodObject<{
+    codigo: z.ZodNumber;
+    descricao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, z.core.$loose>>;
+/**
+ * The response of `GET /api/ura/ocorrencia/metodo/list/`, in SGP's own shape: a bare array with one
+ * entry per occurrence method. The route is not paginated, so there is no envelope and no total.
+ */
+export type OccurrencesListMethodsData = z.output<typeof occurrenceMethodsSchema>;
+/** INTERNAL definition of `occurrences.listMethods`. */
+export declare const occurrencesListMethods: OperationDefinition<OccurrencesListMethodsData, "occurrences.listMethods">;
+export {};

package/dist/operations/occurrences-list-types.d.ts

@@ -0,0 +1,20 @@
+import { z } from "zod";
+import type { OperationDefinition } from "../operation.js";
+declare const occurrenceTypesSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    codigo: z.ZodNumber;
+    descricao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    ativo: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    classificacoes: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodUnknown>>>;
+    classificacoes_obrigatorio: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    setores: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodUnknown>>>;
+    classificacoes_obrigatorio_encerramento: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+}, z.core.$loose>>;
+/**
+ * The response of `GET /api/os/ocorrencia/tipo/list/`, in SGP's own shape: a bare array with one
+ * entry per occurrence type. The route is not paginated, so there is no envelope and no total.
+ */
+export type OccurrencesListTypesData = z.output<typeof occurrenceTypesSchema>;
+/** INTERNAL definition of `occurrences.listTypes`. */
+export declare const occurrencesListTypes: OperationDefinition<OccurrencesListTypesData, "occurrences.listTypes">;
+export {};

package/dist/{endpoints/ura/list-plans.d.ts → operations/plans-list.d.ts}

@@ -1,12 +1,25 @@
 import { z } from "zod";
-import type { EndpointDefinition } from "../../endpoint.js";
-/** Response of `GET /api/ura/consultaplano/`: the plan catalog with its totals. */
-export declare const listPlansSchema: z.ZodObject<{
+import type { OperationDefinition } from "../operation.js";
+/**
+ * Identifier of a plan (SGP "plano") in the URA catalog `plans.list` reads (`GET
+ * /api/ura/consultaplano/`).
+ *
+ * This is the ID space of the operations on existing services and contracts: the `plano` filter of
+ * `contracts.list`, `plano_id` of `services.changePlan` and `planobase_id` of `services.addTv`. It
+ * is what `customers.list` returns as `servicos[].plano.id` too. It is NOT the ID space of the
+ * pré-cadastro catalog (`preRegistrations.listPlans`, used by `preRegistrations.create`), typed as
+ * `PreRegistrationPlanId`: the same commercial plan may carry another id there, and the live
+ * evidence shows an id accepted by one route refused by the other. The two brands make the
+ * compiler refuse one where the other belongs, and a plain number where either belongs. They are
+ * type-only: on the wire and at runtime an id is a plain number.
+ */
+export type PlanId = number & z.core.$brand<"PlanId">;
+declare const catalogSchema: z.ZodObject<{
     planos: z.ZodArray<z.ZodObject<{
-        id: z.ZodNumber;
-        descricao: z.ZodString;
-        preco: z.ZodNumber;
-        ativo: z.ZodBoolean;
+        id: z.core.$ZodBranded<z.ZodNumber, "PlanId", "out">;
+        descricao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        preco: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        ativo: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
         grupo: z.ZodNullable<z.ZodOptional<z.ZodString>>;
         tipo: z.ZodNullable<z.ZodOptional<z.ZodString>>;
         pos_pago: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
@@ -30,7 +43,7 @@ export declare const listPlansSchema: z.ZodObject<{
             id: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
             uf: z.ZodNullable<z.ZodOptional<z.ZodString>>;
             pop: z.ZodNullable<z.ZodOptional<z.ZodString>>;
-        }, z.core.$strip>>>>;
+        }, z.core.$loose>>>>;
         auto_bloqueio: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
         dias_bloqueio_pos_venc: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
         dias_bloqueio_aviso: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
@@ -50,21 +63,18 @@ export declare const listPlansSchema: z.ZodObject<{
         modo_velocidade_red_franquia: z.ZodNullable<z.ZodOptional<z.ZodString>>;
         download_red_franquia: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
         upload_red_franquia: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
-        combo: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{}, z.core.$strip>>>>;
+        combo: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodUnknown>>>;
         qtd_servicos: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
-    }, z.core.$strip>>;
+    }, z.core.$loose>>;
     total_planos: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
     total_qtd_servicos: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
-}, z.core.$strip>;
-/** Key fields of `ura/consultaplano`: required and strict; any mismatch is `SCHEMA_MISMATCH`. */
-export declare const listPlansKeyFields: readonly ["planos", "planos[].id", "planos[].descricao", "planos[].preco", "planos[].ativo"];
-/** Normalized path of each plan in the `ura/consultaplano` response. */
-export declare const planItemPath = "planos[]";
-/** Keys of a plan holding secrets (none in `ura/consultaplano`). */
-export declare const planSecretKeys: readonly [];
-/** Keys of a plan holding personal data (none in `ura/consultaplano`). */
-export declare const planPersonalKeys: readonly [];
-/** Parsed response of `GET /api/ura/consultaplano/`. */
-export type ListPlansResponse = z.output<typeof listPlansSchema>;
-/** Definition of `GET /api/ura/consultaplano/`. */
-export declare const listPlansDefinition: EndpointDefinition<typeof listPlansSchema>;
+}, z.core.$loose>;
+/**
+ * The whole plan catalog of `GET /api/ura/consultaplano/`, in SGP's own shape. The route is not
+ * paginated: there is no `paginacao`, and `total_planos` / `total_qtd_servicos` are SGP's own
+ * totals of the catalog, returned as received.
+ */
+export type PlansListData = z.output<typeof catalogSchema>;
+/** INTERNAL definition of `plans.list`. */
+export declare const plansList: OperationDefinition<PlansListData, "plans.list">;
+export {};

package/dist/operations/pre-registrations-create.d.ts

@@ -0,0 +1,253 @@
+import { z } from "zod";
+import { type SgpAddress } from "../address.js";
+import type { AcquisitionMode } from "../constants.js";
+import type { OperationDefinition } from "../operation.js";
+/**
+ * Identifier of a plan (SGP "plano") in the pré-cadastro catalog (`preRegistrations.listPlans`,
+ * `POST /api/precadastro/plano/list`), the one `preRegistrations.create` takes `plano_id` from.
+ *
+ * It is NOT a `PlanId` (the URA catalog of `plans.list`): the same commercial plan may carry another
+ * id here. The brand is type-only; on the wire an id is a plain number. `preRegistrations.listPlans`
+ * returns this type: take the id from there.
+ */
+export type PreRegistrationPlanId = number & z.core.$brand<"PreRegistrationPlanId">;
+/**
+ * The address fields of a pré-cadastro, loose at the top level of the input with SGP's own names.
+ * `logradouro`, `numero`, `bairro`, `cidade`, `uf` and `cep` are Exercised; the other keys are
+ * Documented. Only `logradouro` is required (the vendor's documentation marks no other).
+ */
+interface PreRegistrationAddress extends SgpAddress {
+    logradouro: string;
+}
+/** Fields common to both person types. Money is a number of reais; ids are SGP's own. */
+interface PreRegistrationCreateCommon extends PreRegistrationAddress {
+    /** Exercised. Customer name; for a company, its corporate name. Required by SGP. */
+    nome: string;
+    /** Exercised. CPF (`F`) or CNPJ (`J`), in the format SGP stores it. */
+    cpfcnpj?: string;
+    /** Exercised. Contact e-mail. */
+    email?: string;
+    /** Documented. Contact phone. */
+    celular?: string;
+    /** Documented. `AAAA-MM-DD`: birth date of a person, foundation date of a company. */
+    datanasc?: string;
+    /** Exercised. Free-text note. */
+    observacao?: string;
+    /** Documented. User responsible for the pré-cadastro. */
+    usuariocad_id?: number;
+    /**
+     * Exercised with `1`. Turns the pré-cadastro into a definitive customer. Omit it to leave only
+     * the pré-cadastro. The domain beyond `1` is undocumented, so the SDK sends only `1`.
+     */
+    precadastro_ativar?: 1;
+    /** Exercised. POP ID. */
+    pop_id?: number;
+    /** Exercised. Billing profile (portador) ID. */
+    portador_id?: number;
+    /** Exercised. NAS ID. */
+    nas_id?: number;
+    /**
+     * Exercised. Plan ID of the pré-cadastro catalog (`preRegistrations.listPlans`), typed
+     * `PreRegistrationPlanId`; not a `PlanId` of `plans.list`: the same commercial plan has another ID
+     * here.
+     */
+    plano_id?: PreRegistrationPlanId;
+    /** Exercised. Due-day ID. */
+    vencimento_id?: number;
+    /**
+     * Exercised with `1`. Billing-method code (`BILLING_METHOD`: 1 boleto, 2 automatic debit, 3
+     * booklet, 4 recurring charge, 6 PIX); any number is sent as given.
+     */
+    formacobranca_id?: number;
+    /** Documented. Loyalty (fidelidade) ID. */
+    fidelidade_id?: number;
+    /** Exercised. Secret (PPPoE credential); may be an e-mail. Never log it. */
+    login?: string;
+    /** Exercised. Password of the contract. Secret: never log it. */
+    senha?: string;
+    /** Exercised. Password of the customer's central. Secret: never log it. */
+    central_senha?: string;
+    /** Exercised with `1`. Equipment situation: `ACQUISITION_MODE` (0 owned, 1 loan). */
+    modoaquisicao?: AcquisitionMode;
+    /** Documented. Details of the requested service. */
+    servicodesc?: string;
+    /** Documented. "How did you hear about us" ID. */
+    midia_id?: number;
+    /** Documented. Seller ID. */
+    vendedor_id?: number;
+    /** Documented. Technician ID for the installation. */
+    tecnico_id?: number;
+    /** Documented. Send `1` to generate the installation work order. */
+    os_instalacao?: 1;
+    /** Exercised with `0`. Installation price. */
+    instalacao_preco?: number;
+    /** Documented. Discount over the installation price. */
+    instalacao_desconto?: number;
+    /** Documented. Down payment of the installation. */
+    instalacao_entrada?: number;
+    /** Documented. Number of installments of the installation. */
+    instalacao_quantidade_parcelas?: number;
+    /** Exercised with `1`. Payment form of the down payment; SGP's documentation lists the values. */
+    instalacao_entrada_forma?: number;
+    /** Exercised with `1`. Payment form of the installments; SGP's documentation lists the values. */
+    instalacao_parcela_forma?: number;
+}
+/** `POST /api/precadastro/F`: a natural person. Only this route was exercised against SGP. */
+export interface PreRegistrationCreateIndividualInput extends PreRegistrationCreateCommon {
+    /** Selects the route `/F`; not sent as a field. */
+    personType: "F";
+    /** Documented. Identity document number. */
+    rg?: string;
+    /** Documented. Issuer of the identity document. */
+    rg_emissor?: string;
+    /** Documented. Father's name. */
+    nomepai?: string;
+    /** Documented. Mother's name. */
+    nomemae?: string;
+    /** Documented. Nationality. */
+    nacionalidade?: string;
+    /** Documented. Place of birth. */
+    naturalidade?: string;
+    /** Documented. `S` single, `C` married, `D` divorced, `V` widowed. */
+    estadocivil?: "S" | "C" | "D" | "V";
+    /** Documented. `M` male, `F` female. */
+    sexo?: "M" | "F";
+    /** Documented. Occupation. */
+    profissao?: string;
+}
+/** `POST /api/precadastro/J`: a company. Documented only: never exercised against SGP. */
+export interface PreRegistrationCreateCompanyInput extends PreRegistrationCreateCommon {
+    /** 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;
+}
+/**
+ * Input of `preRegistrations.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 PreRegistrationCreateInput = PreRegistrationCreateIndividualInput | PreRegistrationCreateCompanyInput;
+/** INTERNAL. Validation of the input, exported so a test can check it against the public types. */
+export declare const preRegistrationsCreateInputSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    numero: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+    complemento: z.ZodOptional<z.ZodString>;
+    bairro: z.ZodOptional<z.ZodString>;
+    cidade: z.ZodOptional<z.ZodString>;
+    cep: z.ZodOptional<z.ZodString>;
+    uf: 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]>>;
+    nome: z.ZodString;
+    cpfcnpj: z.ZodOptional<z.ZodString>;
+    logradouro: z.ZodString;
+    email: z.ZodOptional<z.ZodString>;
+    celular: z.ZodOptional<z.ZodString>;
+    datanasc: z.ZodOptional<z.ZodString>;
+    observacao: z.ZodOptional<z.ZodString>;
+    usuariocad_id: z.ZodOptional<z.ZodNumber>;
+    precadastro_ativar: z.ZodOptional<z.ZodLiteral<1>>;
+    pop_id: z.ZodOptional<z.ZodNumber>;
+    portador_id: z.ZodOptional<z.ZodNumber>;
+    nas_id: z.ZodOptional<z.ZodNumber>;
+    plano_id: z.ZodOptional<z.core.$ZodBranded<z.ZodNumber, "PreRegistrationPlanId", "out">>;
+    vencimento_id: z.ZodOptional<z.ZodNumber>;
+    formacobranca_id: z.ZodOptional<z.ZodNumber>;
+    fidelidade_id: z.ZodOptional<z.ZodNumber>;
+    login: z.ZodOptional<z.ZodString>;
+    senha: z.ZodOptional<z.ZodString>;
+    central_senha: z.ZodOptional<z.ZodString>;
+    modoaquisicao: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<1>]>>;
+    servicodesc: z.ZodOptional<z.ZodString>;
+    midia_id: z.ZodOptional<z.ZodNumber>;
+    vendedor_id: z.ZodOptional<z.ZodNumber>;
+    tecnico_id: z.ZodOptional<z.ZodNumber>;
+    os_instalacao: z.ZodOptional<z.ZodLiteral<1>>;
+    instalacao_preco: z.ZodOptional<z.ZodNumber>;
+    instalacao_desconto: z.ZodOptional<z.ZodNumber>;
+    instalacao_entrada: z.ZodOptional<z.ZodNumber>;
+    instalacao_quantidade_parcelas: z.ZodOptional<z.ZodNumber>;
+    instalacao_entrada_forma: z.ZodOptional<z.ZodNumber>;
+    instalacao_parcela_forma: z.ZodOptional<z.ZodNumber>;
+    personType: z.ZodLiteral<"F">;
+    rg: z.ZodOptional<z.ZodString>;
+    rg_emissor: z.ZodOptional<z.ZodString>;
+    nomepai: z.ZodOptional<z.ZodString>;
+    nomemae: z.ZodOptional<z.ZodString>;
+    nacionalidade: z.ZodOptional<z.ZodString>;
+    naturalidade: z.ZodOptional<z.ZodString>;
+    estadocivil: z.ZodOptional<z.ZodEnum<{
+        C: "C";
+        D: "D";
+        S: "S";
+        V: "V";
+    }>>;
+    sexo: z.ZodOptional<z.ZodEnum<{
+        F: "F";
+        M: "M";
+    }>>;
+    profissao: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>, z.ZodObject<{
+    numero: z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodNumber]>>;
+    complemento: z.ZodOptional<z.ZodString>;
+    bairro: z.ZodOptional<z.ZodString>;
+    cidade: z.ZodOptional<z.ZodString>;
+    cep: z.ZodOptional<z.ZodString>;
+    uf: 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]>>;
+    nome: z.ZodString;
+    cpfcnpj: z.ZodOptional<z.ZodString>;
+    logradouro: z.ZodString;
+    email: z.ZodOptional<z.ZodString>;
+    celular: z.ZodOptional<z.ZodString>;
+    datanasc: z.ZodOptional<z.ZodString>;
+    observacao: z.ZodOptional<z.ZodString>;
+    usuariocad_id: z.ZodOptional<z.ZodNumber>;
+    precadastro_ativar: z.ZodOptional<z.ZodLiteral<1>>;
+    pop_id: z.ZodOptional<z.ZodNumber>;
+    portador_id: z.ZodOptional<z.ZodNumber>;
+    nas_id: z.ZodOptional<z.ZodNumber>;
+    plano_id: z.ZodOptional<z.core.$ZodBranded<z.ZodNumber, "PreRegistrationPlanId", "out">>;
+    vencimento_id: z.ZodOptional<z.ZodNumber>;
+    formacobranca_id: z.ZodOptional<z.ZodNumber>;
+    fidelidade_id: z.ZodOptional<z.ZodNumber>;
+    login: z.ZodOptional<z.ZodString>;
+    senha: z.ZodOptional<z.ZodString>;
+    central_senha: z.ZodOptional<z.ZodString>;
+    modoaquisicao: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<0>, z.ZodLiteral<1>]>>;
+    servicodesc: z.ZodOptional<z.ZodString>;
+    midia_id: z.ZodOptional<z.ZodNumber>;
+    vendedor_id: z.ZodOptional<z.ZodNumber>;
+    tecnico_id: z.ZodOptional<z.ZodNumber>;
+    os_instalacao: z.ZodOptional<z.ZodLiteral<1>>;
+    instalacao_preco: z.ZodOptional<z.ZodNumber>;
+    instalacao_desconto: z.ZodOptional<z.ZodNumber>;
+    instalacao_entrada: z.ZodOptional<z.ZodNumber>;
+    instalacao_quantidade_parcelas: z.ZodOptional<z.ZodNumber>;
+    instalacao_entrada_forma: z.ZodOptional<z.ZodNumber>;
+    instalacao_parcela_forma: z.ZodOptional<z.ZodNumber>;
+    personType: z.ZodLiteral<"J">;
+    nomefantasia: z.ZodOptional<z.ZodString>;
+    respempresa: z.ZodOptional<z.ZodString>;
+    respcpf: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>], "personType">;
+/**
+ * Success body of `POST /api/precadastro/{F|J}`: SGP's `message`. It carries no ID of the customer,
+ * the contract or the pré-cadastro. Other keys SGP may add are kept.
+ */
+declare const createdSchema: z.ZodObject<{
+    message: z.ZodString;
+}, z.core.$loose>;
+/** Response of `preRegistrations.create`. */
+export type PreRegistrationCreateData = z.output<typeof createdSchema>;
+/** INTERNAL definition of `preRegistrations.create`. */
+export declare const preRegistrationsCreate: OperationDefinition<PreRegistrationCreateData, "preRegistrations.create">;
+export {};

package/dist/operations/pre-registrations-list-due-days.d.ts

@@ -0,0 +1,15 @@
+import { z } from "zod";
+import type { OperationDefinition } from "../operation.js";
+declare const dueDaysSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    dia: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+}, z.core.$loose>>;
+/**
+ * The response of `POST /api/precadastro/vencimento/list`, in SGP's own shape: a bare array with
+ * one entry per due day, `id` plus the `dia` it stands for. The route is not paginated, so there is
+ * no envelope and no total.
+ */
+export type PreRegistrationsListDueDaysData = z.output<typeof dueDaysSchema>;
+/** INTERNAL definition of `preRegistrations.listDueDays`. */
+export declare const preRegistrationsListDueDays: OperationDefinition<PreRegistrationsListDueDaysData, "preRegistrations.listDueDays">;
+export {};