sgp-sdk 0.0.0-stage → 1.2.0

package/dist/endpoints/crm/create-contract.d.ts

@@ -0,0 +1,109 @@
+import { z } from "zod";
+import type { WriteEndpointDefinition } from "../../endpoint.js";
+import type { ParamValue } from "../../transport.js";
+import { type SgpAddress } from "./address.js";
+/** SGP's billing methods, by the `forma_cobranca_codigo` it takes. */
+export declare const formaCobrancaCodigo: {
+    readonly boleto: 1;
+    readonly debitoAutomatico: 2;
+    readonly carne: 3;
+    readonly cobrancaRecorrente: 4;
+    readonly pix: 6;
+};
+/** A valid `forma_cobranca_codigo` of `POST /api/crm/cliente/{cliente_id}/contratos/`. */
+export type FormaCobrancaCodigo = (typeof formaCobrancaCodigo)[keyof typeof formaCobrancaCodigo];
+/**
+ * SGP's equipment acquisition modes, by the `modoaquisicao` it takes: 0 Próprio and 1 Comodato.
+ * SGP rejects any other value (2 included), although its Postman collection lists 1 and 2.
+ */
+export declare const modoAquisicao: {
+    readonly proprio: 0;
+    readonly comodato: 1;
+};
+/** A valid `modoaquisicao` of `POST /api/crm/cliente/{cliente_id}/contratos/`. */
+export type ModoAquisicao = (typeof modoAquisicao)[keyof typeof modoAquisicao];
+/**
+ * Success body of `POST /api/crm/cliente/{cliente_id}/contratos/`: the new contract ID, SGP's
+ * message and the customer's name.
+ */
+export declare const createContractSchema: z.ZodObject<{
+    message: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    clientecontrato: z.ZodNumber;
+    cliente: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, z.core.$strip>;
+/** Key fields of `crm/cliente/{cliente_id}/contratos/`: required and strict; a 2xx without them is not a success. */
+export declare const createContractKeyFields: readonly ["clientecontrato"];
+/** Normalized path of the created contract in the response (the root object). */
+export declare const contractCreatedItemPath = "";
+/** Keys of the response holding secrets (none in `crm/cliente/{cliente_id}/contratos/`). */
+export declare const contractCreatedSecretKeys: readonly [];
+/** Keys of the response holding personal data: `cliente` is the customer's name. */
+export declare const contractCreatedPersonalKeys: readonly ["cliente"];
+/** Parsed response of `POST /api/crm/cliente/{cliente_id}/contratos/`. */
+export type CreateContractResponse = z.output<typeof createContractSchema>;
+/**
+ * Params of `POST /api/crm/cliente/{cliente_id}/contratos/`; `cliente_id` goes in the path.
+ * `login`, `senha`, `central_login`, `central_senha`, the addresses and the network fields
+ * (`ip`, `mac`, `mac_dhcp`) are secret or personal data.
+ */
+export interface CreateContractParams {
+    pop_id: number;
+    plano_id: number;
+    /** Payer or financial responsible. */
+    portador_id: number;
+    forma_cobranca_codigo: FormaCobrancaCodigo;
+    /** Due day registered in SGP. */
+    vencimento_dia: number;
+    /** Sent nested and also as the loose fields (`logradouro`, `numero`, ...) SGP reads. */
+    endereco_instalacao: SgpAddress;
+    endereco_cobranca: SgpAddress;
+    /** PPPoE login and password: SGP requires them for an internet service. */
+    login?: string;
+    senha?: string;
+    modoaquisicao?: ModoAquisicao;
+    /** Name of the NAS. */
+    nas?: string;
+    /** Exempt percentage. */
+    isento?: number;
+    autocobranca?: boolean;
+    servicodesc?: string;
+    observacao?: string;
+    vendedor_id?: number;
+    /** 1 = percentage, 2 = fixed amount. */
+    comissao_tipo?: 1 | 2;
+    comissao?: number;
+    /** Contract group for printing. */
+    contrato_id?: number;
+    fidelidade_id?: number;
+    midia_id?: number;
+    central_login?: string;
+    central_senha?: string;
+    ip?: string;
+    ippool_id?: number;
+    mac_dhcp?: string;
+    mac?: string;
+    logins_simult?: number;
+    splitter_id?: number;
+    splitter_port?: number;
+    tipo_equipamento?: string;
+    usuarioalt_id?: number;
+    /** Opens the installation service order, without a date. */
+    os_instalacao?: boolean;
+    /** Text of the installation occurrence. */
+    conteudo?: string;
+    instalacao_quantidade_parcelas?: number;
+    instalacao_preco?: number;
+    instalacao_desconto?: number;
+    instalacao_entrada?: number;
+    instalacao_entrada_forma?: number;
+    instalacao_parcela_forma?: number;
+    instalacao_portador?: number;
+}
+/**
+ * Request body of the contract route: the params, with both addresses nested and the installation
+ * one also as loose fields beside them (SGP describes those as "installation and billing").
+ * `undefined` address keys are omitted in both formats.
+ */
+export declare const toContractBody: (params: CreateContractParams) => Record<string, ParamValue | undefined>;
+/** Definition of `POST /api/crm/cliente/{cliente_id}/contratos/` (trailing slash required by the token whitelist). */
+export declare const createContractDefinition: WriteEndpointDefinition<typeof createContractSchema>;

package/dist/endpoints/crm/create-customer.d.ts

@@ -0,0 +1,65 @@
+import { z } from "zod";
+import type { WriteEndpointDefinition } from "../../endpoint.js";
+import type { ParamValue } from "../../transport.js";
+import { type SgpAddress } from "./address.js";
+/** Success body of `POST /api/crm/cliente/{F|J}`: the new CRM customer ID and SGP's message. */
+export declare const createCustomerSchema: z.ZodObject<{
+    cliente_id: z.ZodNumber;
+    message: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, z.core.$strip>;
+/** Key fields of `crm/cliente/{F|J}`: required and strict; a 2xx without them is not a success. */
+export declare const createCustomerKeyFields: readonly ["cliente_id"];
+/** Normalized path of the created customer in the response (the root object). */
+export declare const customerCreatedItemPath = "";
+/** Keys of the response holding secrets (none in `crm/cliente/{F|J}`). */
+export declare const customerCreatedSecretKeys: readonly [];
+/** Keys of the response holding personal data: SGP's message carries the name and CPF/CNPJ. */
+export declare const customerCreatedPersonalKeys: readonly ["message"];
+/** Parsed response of `POST /api/crm/cliente/F` and `POST /api/crm/cliente/J`. */
+export type CreateCustomerResponse = z.output<typeof createCustomerSchema>;
+/** Params of `POST /api/crm/cliente/F` (individual). Name, CPF and address are personal data. */
+export interface CreateIndividualCustomerParams {
+    nome: string;
+    cpfcnpj: string;
+    endereco: SgpAddress;
+    email?: string;
+    celular?: string;
+    /** `"DD/MM/AAAA"`. */
+    datanasc?: string;
+    observacao?: string;
+    rg?: string;
+    rg_emissor?: string;
+    sexo?: "M" | "F";
+    /** C = married, S = single, V = widowed, D = divorced. */
+    estadocivil?: "C" | "S" | "V" | "D";
+    nomemae?: string;
+    nomepai?: string;
+    profissao?: string;
+    nacionalidade?: string;
+    naturalidade?: string;
+}
+/** Params of `POST /api/crm/cliente/J` (company). Name, CNPJ and address are personal data. */
+export interface CreateCompanyCustomerParams {
+    nome: string;
+    cpfcnpj: string;
+    endereco: SgpAddress;
+    nomefantasia?: string;
+    respempresa?: string;
+    respcpf?: string;
+    insc_estadual?: string;
+    insc_municipal?: string;
+    email?: string;
+    celular?: string;
+    /** `"DD/MM/AAAA"`. */
+    datafundacao?: string;
+    observacao?: string;
+}
+/**
+ * Request body of the customer routes: the params, with the address nested (`endereco`) and also
+ * as loose fields beside them, as SGP reads both. `undefined` address keys are omitted in both.
+ */
+export declare const toCustomerBody: (params: CreateIndividualCustomerParams | CreateCompanyCustomerParams) => Record<string, ParamValue | undefined>;
+/** Definition of `POST /api/crm/cliente/F` (individual customer). */
+export declare const createIndividualCustomerDefinition: WriteEndpointDefinition<typeof createCustomerSchema>;
+/** Definition of `POST /api/crm/cliente/J` (company customer). */
+export declare const createCompanyCustomerDefinition: WriteEndpointDefinition<typeof createCustomerSchema>;

package/dist/endpoints/crm/update-customer-status.d.ts

@@ -0,0 +1,43 @@
+import { z } from "zod";
+import type { WriteEndpointDefinition } from "../../endpoint.js";
+/** SGP's CRM statuses, by the `status_id` it takes. */
+export declare const crmStatus: {
+    readonly emAnalise: 1;
+    readonly aprovado: 2;
+    readonly reprovado: 3;
+    readonly aguardandoContato: 4;
+    readonly tentandoContato: 5;
+    readonly contratoRealizadoNoSgp: 6;
+    readonly inviabilidadeTecnica: 7;
+    readonly contratoEmProspeccao: 8;
+    readonly reprovadoSpcSerasa: 9;
+    readonly analiseViabilidadeTecnica: 10;
+};
+/** A valid `status_id` of `POST /api/crm/cliente/{cliente_id}/status/`. */
+export type CrmStatusId = (typeof crmStatus)[keyof typeof crmStatus];
+/** Success body of `POST /api/crm/cliente/{cliente_id}/status/`: the customer and the status now set. */
+export declare const updateCustomerStatusSchema: z.ZodObject<{
+    cliente_id: z.ZodNumber;
+    message: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    novo_status: z.ZodObject<{
+        codigo: z.ZodNumber;
+        descricao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+/** Key fields of `crm/cliente/{cliente_id}/status/`: required and strict; a 2xx without them is not a success. */
+export declare const updateCustomerStatusKeyFields: readonly ["cliente_id", "novo_status.codigo"];
+/** Normalized path of the updated customer in the response (the root object). */
+export declare const customerStatusItemPath = "";
+/** Keys of the response holding secrets (none in `crm/cliente/{cliente_id}/status/`). */
+export declare const customerStatusSecretKeys: readonly [];
+/** Keys of the response holding personal data: SGP's message carries the customer's name. */
+export declare const customerStatusPersonalKeys: readonly ["message"];
+/** Parsed response of `POST /api/crm/cliente/{cliente_id}/status/`. */
+export type UpdateCustomerStatusResponse = z.output<typeof updateCustomerStatusSchema>;
+/** Params of `POST /api/crm/cliente/{cliente_id}/status/`; `cliente_id` goes in the path. */
+export interface UpdateCustomerStatusParams {
+    status_id: CrmStatusId;
+    motivo?: string;
+}
+/** Definition of `POST /api/crm/cliente/{cliente_id}/status/` (trailing slash required by the token whitelist). */
+export declare const updateCustomerStatusDefinition: WriteEndpointDefinition<typeof updateCustomerStatusSchema>;

package/dist/endpoints/os/list-occurrence-reasons.d.ts

@@ -0,0 +1,24 @@
+import { z } from "zod";
+import type { EndpointDefinition } from "../../endpoint.js";
+/** Response of `GET /api/os/ocorrencia/motivo/list/`: a bare array with the occurrence reasons. */
+export declare const listOccurrenceReasonsSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    codigo: z.ZodNumber;
+    descricao: z.ZodString;
+    ativo: z.ZodBoolean;
+    classificacoes: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{}, z.core.$strip>>>>;
+    classificacoes_obrigatorio: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    setores: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{}, z.core.$strip>>>>;
+}, z.core.$strip>>;
+/** Key fields of `os/ocorrencia/motivo/list`: required and strict; any mismatch is `SCHEMA_MISMATCH`. */
+export declare const listOccurrenceReasonsKeyFields: readonly ["[].id", "[].codigo", "[].descricao", "[].ativo"];
+/** Normalized path of each reason in the `os/ocorrencia/motivo/list` response (the root array). */
+export declare const occurrenceReasonItemPath = "[]";
+/** Keys of an occurrence reason holding secrets (none in `os/ocorrencia/motivo/list`). */
+export declare const occurrenceReasonSecretKeys: readonly [];
+/** Keys of an occurrence reason holding personal data (none in `os/ocorrencia/motivo/list`). */
+export declare const occurrenceReasonPersonalKeys: readonly [];
+/** Parsed response of `GET /api/os/ocorrencia/motivo/list/`. */
+export type ListOccurrenceReasonsResponse = z.output<typeof listOccurrenceReasonsSchema>;
+/** Definition of `GET /api/os/ocorrencia/motivo/list/`. */
+export declare const listOccurrenceReasonsDefinition: EndpointDefinition<typeof listOccurrenceReasonsSchema>;

package/dist/endpoints/os/list-occurrence-types.d.ts

@@ -0,0 +1,25 @@
+import { z } from "zod";
+import type { EndpointDefinition } from "../../endpoint.js";
+/** Response of `GET /api/os/ocorrencia/tipo/list/`: a bare array with the occurrence types. */
+export declare const listOccurrenceTypesSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    codigo: z.ZodNumber;
+    descricao: z.ZodString;
+    ativo: z.ZodBoolean;
+    classificacoes: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{}, z.core.$strip>>>>;
+    classificacoes_obrigatorio: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    setores: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{}, z.core.$strip>>>>;
+    classificacoes_obrigatorio_encerramento: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+}, z.core.$strip>>;
+/** Key fields of `os/ocorrencia/tipo/list`: required and strict; any mismatch is `SCHEMA_MISMATCH`. */
+export declare const listOccurrenceTypesKeyFields: readonly ["[].id", "[].codigo", "[].descricao", "[].ativo"];
+/** Normalized path of each type in the `os/ocorrencia/tipo/list` response (the root array). */
+export declare const occurrenceTypeItemPath = "[]";
+/** Keys of an occurrence type holding secrets (none in `os/ocorrencia/tipo/list`). */
+export declare const occurrenceTypeSecretKeys: readonly [];
+/** Keys of an occurrence type holding personal data (none in `os/ocorrencia/tipo/list`). */
+export declare const occurrenceTypePersonalKeys: readonly [];
+/** Parsed response of `GET /api/os/ocorrencia/tipo/list/`. */
+export type ListOccurrenceTypesResponse = z.output<typeof listOccurrenceTypesSchema>;
+/** Definition of `GET /api/os/ocorrencia/tipo/list/`. */
+export declare const listOccurrenceTypesDefinition: EndpointDefinition<typeof listOccurrenceTypesSchema>;

package/dist/endpoints/precadastro/list-due-days.d.ts

@@ -0,0 +1,19 @@
+import { z } from "zod";
+import type { EndpointDefinition } from "../../endpoint.js";
+/** Response of `POST /api/precadastro/vencimento/list`: a bare array with the due days. */
+export declare const listDueDaysSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    dia: z.ZodNumber;
+}, z.core.$strip>>;
+/** Key fields of `precadastro/vencimento/list`: required and strict; any mismatch is `SCHEMA_MISMATCH`. */
+export declare const listDueDaysKeyFields: readonly ["[].id", "[].dia"];
+/** Normalized path of each due day in the `precadastro/vencimento/list` response (the root array). */
+export declare const dueDayItemPath = "[]";
+/** Keys of a due day holding secrets (none in `precadastro/vencimento/list`). */
+export declare const dueDaySecretKeys: readonly [];
+/** Keys of a due day holding personal data (none in `precadastro/vencimento/list`). */
+export declare const dueDayPersonalKeys: readonly [];
+/** Parsed response of `POST /api/precadastro/vencimento/list`. */
+export type ListDueDaysResponse = z.output<typeof listDueDaysSchema>;
+/** Definition of `POST /api/precadastro/vencimento/list` (no trailing slash). */
+export declare const listDueDaysDefinition: EndpointDefinition<typeof listDueDaysSchema>;

package/dist/endpoints/precadastro/list-sellers.d.ts

@@ -0,0 +1,21 @@
+import { z } from "zod";
+import type { EndpointDefinition } from "../../endpoint.js";
+/** Response of `POST /api/precadastro/vendedor/list`: a bare array with the sellers. */
+export declare const listSellersSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    nome: z.ZodString;
+    cpf: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    email: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, z.core.$strip>>;
+/** Key fields of `precadastro/vendedor/list`: required and strict; any mismatch is `SCHEMA_MISMATCH`. */
+export declare const listSellersKeyFields: readonly ["[].id", "[].nome"];
+/** Normalized path of each seller in the `precadastro/vendedor/list` response (the root array). */
+export declare const sellerItemPath = "[]";
+/** Keys of a seller holding secrets (none in `precadastro/vendedor/list`). */
+export declare const sellerSecretKeys: readonly [];
+/** Keys of a seller holding personal data: sellers are employees, so name, CPF and e-mail are personal. */
+export declare const sellerPersonalKeys: readonly ["nome", "cpf", "email"];
+/** Parsed response of `POST /api/precadastro/vendedor/list`. */
+export type ListSellersResponse = z.output<typeof listSellersSchema>;
+/** Definition of `POST /api/precadastro/vendedor/list` (no trailing slash). */
+export declare const listSellersDefinition: EndpointDefinition<typeof listSellersSchema>;

package/dist/endpoints/suporte/add-customer-document.d.ts

@@ -0,0 +1,24 @@
+import { z } from "zod";
+import type { WriteEndpointDefinition } from "../../endpoint.js";
+/**
+ * Success body of `PUT /api/suporte/cliente/{cliente_id}/documento/add/`: none. SGP answers 200 with
+ * an empty body, which the transport yields as `null`; anything else is not a confirmed success.
+ */
+export declare const addCustomerDocumentSchema: z.ZodNull;
+/** Key fields of `suporte/cliente/{cliente_id}/documento/add/`: none, the success body is empty. */
+export declare const addCustomerDocumentKeyFields: readonly [];
+/** Normalized path of the success body in the response (the root: it is empty). */
+export declare const customerDocumentAddedItemPath = "";
+/** Keys of the response holding secrets (none: the response is empty). */
+export declare const customerDocumentAddedSecretKeys: readonly [];
+/** Keys of the response holding personal data (none: the response is empty). */
+export declare const customerDocumentAddedPersonalKeys: readonly [];
+/** Parsed response of `PUT /api/suporte/cliente/{cliente_id}/documento/add/`: always `null`. */
+export type AddCustomerDocumentResponse = z.output<typeof addCustomerDocumentSchema>;
+/** Params of `PUT /api/suporte/cliente/{cliente_id}/documento/add/`; `cliente_id` goes in the path. */
+export interface AddCustomerDocumentParams {
+    /** Description of the document; personal data when it names the customer. */
+    descricao?: string;
+}
+/** Definition of `PUT /api/suporte/cliente/{cliente_id}/documento/add/` (trailing slash required by the token whitelist). */
+export declare const addCustomerDocumentDefinition: WriteEndpointDefinition<typeof addCustomerDocumentSchema>;

package/dist/endpoints/suporte/list-customer-documents.d.ts

@@ -0,0 +1,25 @@
+import { z } from "zod";
+import type { EndpointDefinition } from "../../endpoint.js";
+/** Response of `GET /api/suporte/cliente/{cliente_id}/documento/list/`: a bare array with the customer's documents. */
+export declare const listCustomerDocumentsSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    cliente_id: z.ZodNumber;
+    arquivo: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    descricao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    usuario: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, z.core.$strip>>;
+/** Key fields of `suporte/cliente/{cliente_id}/documento/list/`: required and strict; any mismatch is `SCHEMA_MISMATCH`. */
+export declare const listCustomerDocumentsKeyFields: readonly ["[].id", "[].cliente_id"];
+/** Normalized path of each document in the response (the root array). */
+export declare const customerDocumentItemPath = "[]";
+/** Keys of a document holding secrets (none in `suporte/cliente/{cliente_id}/documento/list/`). */
+export declare const customerDocumentSecretKeys: readonly [];
+/** Keys of a document holding personal data: the file (a customer's document), its description and the operator. */
+export declare const customerDocumentPersonalKeys: readonly ["arquivo", "descricao", "usuario"];
+/** Parsed response of `GET /api/suporte/cliente/{cliente_id}/documento/list/`. */
+export type ListCustomerDocumentsResponse = z.output<typeof listCustomerDocumentsSchema>;
+/**
+ * Definition of `GET /api/suporte/cliente/{cliente_id}/documento/list/` (trailing slash required by
+ * the token whitelist). Not in the `endpointRegistry`: the route needs a customer ID in its path.
+ */
+export declare const listCustomerDocumentsDefinition: EndpointDefinition<typeof listCustomerDocumentsSchema>;

package/dist/endpoints/ura/check-coverage.d.ts

@@ -0,0 +1,46 @@
+import { z } from "zod";
+import type { EndpointDefinition } from "../../endpoint.js";
+/**
+ * Response of `GET /api/ura/viabilidadeinstalacao`: an array whose object is keyed by the
+ * gateway's `descricao` (data-defined: `"SGPMaps"`, `"Geogrid"`), holding either the CTOs within
+ * the radius (`lat`, `lng`, `distancia` in meters, `nome`, and `id` on Geogrid) or the message
+ * `"Localização inviável"` when there are none.
+ *
+ * `lat`, `lng` and `distancia` are always numbers: Geogrid sends them as numeric strings and the
+ * schema converts them, so both gateways look the same to the consumer. `id` is always a string:
+ * a numeric id is converted.
+ *
+ * A gateway entry that is neither CTOs nor a message (for example a CTO with a non-numeric `lat`)
+ * is a malformed answer: the result is `SCHEMA_MISMATCH`, never a success without that entry.
+ */
+export declare const checkCoverageSchema: z.ZodArray<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodArray<z.ZodObject<{
+    lat: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodPipe<z.ZodString, z.ZodTransform<number, string>>]>>>;
+    lng: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodPipe<z.ZodString, z.ZodTransform<number, string>>]>>>;
+    distancia: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodNumber, z.ZodPipe<z.ZodString, z.ZodTransform<number, string>>]>>>;
+    id: z.ZodNullable<z.ZodOptional<z.ZodUnion<readonly [z.ZodString, z.ZodPipe<z.ZodNumber, z.ZodTransform<string, number>>]>>>;
+    nome: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, z.core.$strip>>, z.ZodString]>>>;
+/**
+ * Key fields of `ura/viabilidadeinstalacao`: every gateway entry (`*` is its data-defined name),
+ * so a malformed gateway answer is `SCHEMA_MISMATCH`.
+ */
+export declare const checkCoverageKeyFields: readonly ["[].*"];
+/** Normalized path of each gateway answer in the `ura/viabilidadeinstalacao` response (the root array). */
+export declare const coverageItemPath = "[]";
+/** Keys of a gateway answer holding secrets (none in `ura/viabilidadeinstalacao`). */
+export declare const coverageSecretKeys: readonly [];
+/** Keys of a gateway answer holding personal data (none in `ura/viabilidadeinstalacao`). */
+export declare const coveragePersonalKeys: readonly [];
+/** Query parameters of `GET /api/ura/viabilidadeinstalacao` (besides credentials); all required. */
+export interface CheckCoverageParams {
+    /** ID of the map gateway, from `/api/ura/listgatewaymapa`. */
+    gateway: number;
+    /** Search radius in meters. */
+    raio: number;
+    /** Coordinate to check, `"lat,lng"`, e.g. `"-23.55,-46.63"`. */
+    coordenada: string;
+}
+/** Parsed response of `GET /api/ura/viabilidadeinstalacao`. */
+export type CheckCoverageResponse = z.output<typeof checkCoverageSchema>;
+/** Definition of `GET /api/ura/viabilidadeinstalacao`. */
+export declare const checkCoverageDefinition: EndpointDefinition<typeof checkCoverageSchema>;

package/dist/endpoints/ura/list-annotations.d.ts

@@ -0,0 +1,32 @@
+import { z } from "zod";
+import type { SgpResult } from "../../result.js";
+import { type SgpClientConfig } from "../../transport.js";
+/** Parsed, locally selected annotations; unknown fields are stripped. */
+export declare const listAnnotationsSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    cliente: z.ZodNumber;
+    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.$strip>>;
+/** Required strict fields of each selected annotation. */
+export declare const listAnnotationsKeyFields: readonly ["[].id", "[].cliente", "[].clientecontrato", "[].anotacao"];
+/** Normalized path of each annotation in the root array. */
+export declare const annotationItemPath = "[]";
+/** No declared credential fields; free text can still contain sensitive content. */
+export declare const annotationSecretKeys: readonly [];
+/** Free text and staff identity must be omitted before logging or forwarding. */
+export declare const annotationPersonalKeys: readonly ["anotacao", "usuario"];
+/** At least one positive safe-integer filter is required; both filters mean AND. */
+export interface ListAnnotationsParams {
+    cliente_id?: number;
+    contrato_id?: number;
+}
+/** Selected notes present in one SGP response, not a guarantee of source completeness. */
+export type ListAnnotationsResponse = z.output<typeof listAnnotationsSchema>;
+/** Special read: never add to the generic filterless probe registry. */
+export declare const listAnnotations: (config: SgpClientConfig, params: ListAnnotationsParams) => Promise<SgpResult<ListAnnotationsResponse>>;

package/dist/endpoints/ura/list-clients.d.ts

@@ -0,0 +1,58 @@
+import { z } from "zod";
+import type { EndpointDefinition } from "../../endpoint.js";
+/** Response of `POST /api/ura/clientes/`: one page of clients with their address and contacts. */
+export declare const listClientsSchema: 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.$strip>;
+    clientes: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        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.ZodNumber>>;
+            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.$strip>>>;
+        contratos: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{}, z.core.$strip>>>>;
+        titulos: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{}, z.core.$strip>>>>;
+        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.ZodString>>>;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/** Key fields of `ura/clientes`: required and strict; any mismatch is `SCHEMA_MISMATCH`. */
+export declare const listClientsKeyFields: readonly ["paginacao.total", "clientes", "clientes[].id", "clientes[].nome", "clientes[].cpfcnpj", "clientes[].tipo"];
+/** Normalized path of each client item in the `ura/clientes` response. */
+export declare const clientItemPath = "clientes[]";
+/** Keys of a client item holding secrets (none in `ura/clientes`). */
+export declare const clientSecretKeys: readonly [];
+/** Keys of a client item holding personal data. */
+export declare const clientPersonalKeys: readonly ["nome", "cpfcnpj", "sexo", "endereco", "contatos"];
+/** Body parameters of `POST /api/ura/clientes/` (besides credentials); all optional filters and paging. */
+export interface ListClientsParams {
+    offset?: number;
+    limit?: number;
+    cliente_id?: number;
+    cpfcnpj?: string;
+    cliente_nome?: string;
+}
+/** Parsed response of `POST /api/ura/clientes/`. */
+export type ListClientsResponse = z.output<typeof listClientsSchema>;
+/** Definition of `POST /api/ura/clientes/`. */
+export declare const listClientsDefinition: EndpointDefinition<typeof listClientsSchema>;

package/dist/endpoints/ura/list-contracts.d.ts

@@ -0,0 +1,45 @@
+import { z } from "zod";
+import type { EndpointDefinition } from "../../endpoint.js";
+/** Response of `POST /api/ura/listacontrato/`: a bare array with one summary per contract. */
+export declare const listContractsSchema: z.ZodArray<z.ZodObject<{
+    id_contrato: z.ZodNumber;
+    id_cliente: z.ZodNumber;
+    status: z.ZodString;
+    pop_id: 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.$strip>>;
+/** Key fields of `ura/listacontrato`: required and strict; any mismatch is `SCHEMA_MISMATCH`. */
+export declare const listContractsKeyFields: readonly ["[].id_contrato", "[].id_cliente", "[].status", "[].pop_id"];
+/** Normalized path of each contract item in the `ura/listacontrato` response (the root array). */
+export declare const contractSummaryItemPath = "[]";
+/** Keys of a contract summary holding secrets (none in `ura/listacontrato`). */
+export declare const contractSummarySecretKeys: readonly [];
+/** Keys of a contract summary holding personal data. */
+export declare const contractSummaryPersonalKeys: readonly ["nome", "cpfcnpj", "email", "telefone", "motivo_status"];
+/**
+ * Body parameters of `POST /api/ura/listacontrato/` (besides credentials); all optional filters.
+ *
+ * Without any filter the response may carry the whole contract base.
+ */
+export interface ListContractsParams {
+    /** Contract ID. */
+    contrato?: number;
+    /** ID of the plan linked to the contract. */
+    plano?: number;
+    /** Person type (see the public SGP documentation for the values). */
+    tipo?: string;
+    /** Contract status ID (see the public SGP documentation for the values). */
+    status?: number;
+    /** Ask SGP to include the address; address fields are not transcribed yet, so the schema drops them. */
+    exibir_endereco?: boolean;
+}
+/** Parsed response of `POST /api/ura/listacontrato/`. */
+export type ListContractsResponse = z.output<typeof listContractsSchema>;
+/** Definition of `POST /api/ura/listacontrato/`. */
+export declare const listContractsDefinition: EndpointDefinition<typeof listContractsSchema>;