sgp-sdk 0.0.0-stage → 1.2.0

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

@@ -0,0 +1,107 @@
+import { z } from "zod";
+import type { EndpointDefinition } from "../../endpoint.js";
+/** Response of `POST /api/ura/titulos/`: one page of invoices (titulos). */
+export declare const listInvoicesSchema: 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>;
+    titulos: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        status: z.ZodString;
+        valor: z.ZodNumber;
+        dataVencimento: 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.ZodNumber>>;
+        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.ZodObject<{}, z.core.$strip>>>>;
+            cobrados: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{}, z.core.$strip>>>>;
+        }, z.core.$strip>>>;
+        formaPagamento: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        usuario_baixa: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/** Key fields of `ura/titulos`: required and strict; any mismatch is `SCHEMA_MISMATCH`. */
+export declare const listInvoicesKeyFields: readonly ["paginacao.total", "titulos", "titulos[].id", "titulos[].status", "titulos[].valor", "titulos[].dataVencimento"];
+/** Normalized path of each invoice in the `ura/titulos` response. */
+export declare const invoiceItemPath = "titulos[]";
+/** Keys of an invoice holding secrets (none in `ura/titulos`). */
+export declare const invoiceSecretKeys: readonly [];
+/**
+ * Keys of an invoice holding personal data: customer name and CPF/CNPJ, the statement text, the
+ * payment links and the PIX code.
+ *
+ * `link` and `link_cobranca` open the boleto, which prints the payer's name, CPF/CNPJ and address,
+ * and a dynamic PIX code may resolve to the debtor. `codigoBarras`, `linhaDigitavel`, `nossoNumero`
+ * and `usuario_baixa` are deliberately not classified.
+ */
+export declare const invoicePersonalKeys: readonly ["clienteNome", "clienteCpfcnpj", "demonstrativo", "link", "link_cobranca", "codigoPix"];
+/**
+ * Body parameters of `POST /api/ura/titulos/` (besides credentials); all optional filters, paging
+ * and ordering, with the names and choices of SGP's public Postman collection.
+ */
+export interface ListInvoicesParams {
+    /** Offset of the query; SGP starts at 0. */
+    offset?: number;
+    /** Page size; SGP documents a maximum of 250. */
+    limit?: number;
+    /** Invoice (titulo) ID. */
+    titulo_id?: number;
+    /** ID of the client linked to the invoices. */
+    cliente_id?: number;
+    /** CPF or CNPJ of the client linked to the invoices. */
+    cpfcnpj?: string;
+    /** ID of the service contract linked to the invoices. */
+    contrato?: number;
+    /** Invoice status filter. */
+    status?: "abertos" | "pagos" | "cancelados";
+    /** ID of the payment carrier (portador) that generated the invoices. */
+    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 linked to the invoices: F (individual), J (company), E (foreign individual), EJ (foreign company). */
+    tipo_pessoa?: "F" | "J" | "E" | "EJ";
+    /** Initial due date, `AAAA-MM-DD`; required 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`; required 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, matches invoices cancelled on that day. */
+    data_cancelamento_inicio?: string;
+    /** Final cancellation date, `AAAA-MM-DD`; use with the initial one. */
+    data_cancelamento_fim?: string;
+    /** Initial date on which payment-agreement invoices were generated, `AAAA-MM-DD`; alone, matches that day. */
+    data_acordo_inicio?: string;
+    /** Final date on which payment-agreement invoices were generated, `AAAA-MM-DD`. */
+    data_acordo_fim?: string;
+}
+/** Parsed response of `POST /api/ura/titulos/`. */
+export type ListInvoicesResponse = z.output<typeof listInvoicesSchema>;
+/** Definition of `POST /api/ura/titulos/`. */
+export declare const listInvoicesDefinition: EndpointDefinition<typeof listInvoicesSchema>;

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

@@ -0,0 +1,29 @@
+import { z } from "zod";
+import type { EndpointDefinition } from "../../endpoint.js";
+/** Response of `POST /api/ura/nas/list/`: a bare array with the NAS (network access servers) and the POPs each serves. */
+export declare const listNasSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    descricao: z.ZodString;
+    identificador: z.ZodString;
+    endereco_ip: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    ativo: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    pops: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+        id: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        cidade: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        uf: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        codigo_ibge: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        ativo: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    }, z.core.$strip>>>>;
+}, z.core.$strip>>;
+/** Key fields of `ura/nas/list`: required and strict; any mismatch is `SCHEMA_MISMATCH`. */
+export declare const listNasKeyFields: readonly ["[].id", "[].descricao", "[].identificador"];
+/** Normalized path of each NAS in the `ura/nas/list` response (the root array). */
+export declare const nasItemPath = "[]";
+/** Keys of a NAS holding secrets: its IP address, which is network infrastructure. */
+export declare const nasSecretKeys: readonly ["endereco_ip"];
+/** Keys of a NAS holding personal data (none in `ura/nas/list`). */
+export declare const nasPersonalKeys: readonly [];
+/** Parsed response of `POST /api/ura/nas/list/`. */
+export type ListNasResponse = z.output<typeof listNasSchema>;
+/** Definition of `POST /api/ura/nas/list/`. */
+export declare const listNasDefinition: EndpointDefinition<typeof listNasSchema>;

package/dist/endpoints/ura/list-occurrence-methods.d.ts

@@ -0,0 +1,19 @@
+import { z } from "zod";
+import type { EndpointDefinition } from "../../endpoint.js";
+/** Response of `GET /api/ura/ocorrencia/metodo/list/`: a bare array with the occurrence methods. */
+export declare const listOccurrenceMethodsSchema: z.ZodArray<z.ZodObject<{
+    codigo: z.ZodNumber;
+    descricao: z.ZodString;
+}, z.core.$strip>>;
+/** Key fields of `ura/ocorrencia/metodo/list`: required and strict; any mismatch is `SCHEMA_MISMATCH`. */
+export declare const listOccurrenceMethodsKeyFields: readonly ["[].codigo", "[].descricao"];
+/** Normalized path of each method in the `ura/ocorrencia/metodo/list` response (the root array). */
+export declare const occurrenceMethodItemPath = "[]";
+/** Keys of an occurrence method holding secrets (none in `ura/ocorrencia/metodo/list`). */
+export declare const occurrenceMethodSecretKeys: readonly [];
+/** Keys of an occurrence method holding personal data (none in `ura/ocorrencia/metodo/list`). */
+export declare const occurrenceMethodPersonalKeys: readonly [];
+/** Parsed response of `GET /api/ura/ocorrencia/metodo/list/`. */
+export type ListOccurrenceMethodsResponse = z.output<typeof listOccurrenceMethodsSchema>;
+/** Definition of `GET /api/ura/ocorrencia/metodo/list/`. */
+export declare const listOccurrenceMethodsDefinition: EndpointDefinition<typeof listOccurrenceMethodsSchema>;

package/dist/endpoints/ura/list-payment-carriers.d.ts

@@ -0,0 +1,20 @@
+import { z } from "zod";
+import type { EndpointDefinition } from "../../endpoint.js";
+/** Response of `GET /api/ura/portador/`: a bare array with the payment carriers (portadores). */
+export declare const listPaymentCarriersSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    descricao: z.ZodString;
+    codigo_banco: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+}, z.core.$strip>>;
+/** Key fields of `ura/portador`: required and strict; any mismatch is `SCHEMA_MISMATCH`. */
+export declare const listPaymentCarriersKeyFields: readonly ["[].id", "[].descricao"];
+/** Normalized path of each carrier in the `ura/portador` response (the root array). */
+export declare const paymentCarrierItemPath = "[]";
+/** Keys of a payment carrier holding secrets (none in `ura/portador`). */
+export declare const paymentCarrierSecretKeys: readonly [];
+/** Keys of a payment carrier holding personal data (none in `ura/portador`). */
+export declare const paymentCarrierPersonalKeys: readonly [];
+/** Parsed response of `GET /api/ura/portador/`. */
+export type ListPaymentCarriersResponse = z.output<typeof listPaymentCarriersSchema>;
+/** Definition of `GET /api/ura/portador/`. */
+export declare const listPaymentCarriersDefinition: EndpointDefinition<typeof listPaymentCarriersSchema>;

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

@@ -0,0 +1,70 @@
+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<{
+    planos: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        descricao: z.ZodString;
+        preco: z.ZodNumber;
+        ativo: z.ZodBoolean;
+        grupo: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        tipo: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        pos_pago: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+        desconto: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        desconto_venc: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        desconto_venc_modo: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        valor_desconto_temporario: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        desconto_temporario_modo: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        desconto_temporario_quantidade: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        descricao_desconto_temporario: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        desconto_temporario_proporcional: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+        observacao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        instalacao_qtd_parcelas: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        instalacao_valor: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        instalacao_desconto_max: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        instalacao_desconto_min: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        disponivel_pre_cadastro: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+        disponivel_pre_cadastro_publico: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+        data_validade: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        pops: z.ZodNullable<z.ZodOptional<z.ZodArray<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>>>>;
+        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>>;
+        dias_reducao_velocidade: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        download: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        upload: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        trafego_mensal: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        contabilizacao_trafego_mensal: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        trafego_excedente_acao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        valor_trafego_excedido: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        duplicacao_noturna: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+        inicio_duplicacao_noturna: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        fim_duplicacao_noturna: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        modo_velocidade_reduzida: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        download_red_financeiro: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        upload_red_financeiro: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        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>>>>;
+        qtd_servicos: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+    }, z.core.$strip>>;
+    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>;

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

@@ -0,0 +1,19 @@
+import { z } from "zod";
+import type { EndpointDefinition } from "../../endpoint.js";
+/** Response of `POST /api/ura/pops/`: a bare array with the POPs (points of presence). */
+export declare const listPopsSchema: z.ZodArray<z.ZodObject<{
+    id: z.ZodNumber;
+    pop: z.ZodString;
+}, z.core.$strip>>;
+/** Key fields of `ura/pops`: required and strict; any mismatch is `SCHEMA_MISMATCH`. */
+export declare const listPopsKeyFields: readonly ["[].id", "[].pop"];
+/** Normalized path of each POP in the `ura/pops` response (the root array). */
+export declare const popItemPath = "[]";
+/** Keys of a POP holding secrets (none in `ura/pops`). */
+export declare const popSecretKeys: readonly [];
+/** Keys of a POP holding personal data (none in `ura/pops`). */
+export declare const popPersonalKeys: readonly [];
+/** Parsed response of `POST /api/ura/pops/`. */
+export type ListPopsResponse = z.output<typeof listPopsSchema>;
+/** Definition of `POST /api/ura/pops/`. */
+export declare const listPopsDefinition: EndpointDefinition<typeof listPopsSchema>;

package/dist/endpoints/ura/list-service-orders.d.ts

@@ -0,0 +1,64 @@
+import { z } from "zod";
+import type { EndpointDefinition } from "../../endpoint.js";
+/** Response of `POST /api/ura/ordemservico/list/`: one page of service orders (OS). */
+export declare const listServiceOrdersSchema: 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>;
+    ordens_servicos: z.ZodArray<z.ZodObject<{
+        id: z.ZodNumber;
+        contrato: z.ZodNumber;
+        status_id: z.ZodNumber;
+        status: z.ZodString;
+        tipo_id: z.ZodNumber;
+        data_cadastro: z.ZodString;
+        cliente: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        contrato_status: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        contrato_status_id: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        ocorrencia: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        hora_cadastro: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        data_agendamento: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        hora_agendamento: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        data_finalizacao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        hora_finalizacao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        tipo: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        motivo: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        pop: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        conteudo: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        responsavel: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        tecnicos_auxiliares: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{}, z.core.$strip>>>>;
+        usuario: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        usuario_finalizacao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        classificacoes: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{}, z.core.$strip>>>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/** Key fields of `ura/ordemservico/list`: required and strict; any mismatch is `SCHEMA_MISMATCH`. */
+export declare const listServiceOrdersKeyFields: readonly ["paginacao.total", "ordens_servicos", "ordens_servicos[].id", "ordens_servicos[].contrato", "ordens_servicos[].status_id", "ordens_servicos[].status", "ordens_servicos[].tipo_id", "ordens_servicos[].data_cadastro"];
+/** Normalized path of each service order in the `ura/ordemservico/list` response. */
+export declare const serviceOrderItemPath = "ordens_servicos[]";
+/** Keys of a service order holding secrets (none in `ura/ordemservico/list`). */
+export declare const serviceOrderSecretKeys: readonly [];
+/** Keys of a service order holding personal data: customer name and the free-text content. */
+export declare const serviceOrderPersonalKeys: readonly ["cliente", "conteudo"];
+/** Body parameters of `POST /api/ura/ordemservico/list/` (besides credentials); all optional filters and paging. */
+export interface ListServiceOrdersParams {
+    offset?: number;
+    limit?: number;
+    /** ID of the occurrence (the OS). */
+    ordem_servico?: number;
+    /** Service order status ID. */
+    status?: number;
+    /** POP ID. */
+    pop?: number;
+    /** Occurrence reason ID. */
+    motivo?: number;
+    /** Contract ID. */
+    contrato?: number;
+}
+/** Parsed response of `POST /api/ura/ordemservico/list/`. */
+export type ListServiceOrdersResponse = z.output<typeof listServiceOrdersSchema>;
+/** Definition of `POST /api/ura/ordemservico/list/`. */
+export declare const listServiceOrdersDefinition: EndpointDefinition<typeof listServiceOrdersSchema>;

package/dist/endpoints/ura/lookup-customer.d.ts

@@ -0,0 +1,121 @@
+import { z } from "zod";
+import type { EndpointDefinition } from "../../endpoint.js";
+/** Response of `POST /api/ura/consultacliente/`: the contracts that match the filter. */
+export declare const lookupCustomerSchema: z.ZodObject<{
+    msg: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    contratos: z.ZodArray<z.ZodObject<{
+        contratoId: z.ZodNumber;
+        clienteId: z.ZodNumber;
+        contratoStatus: z.ZodNumber;
+        contratoStatusDisplay: z.ZodString;
+        contratoValorAberto: z.ZodNumber;
+        contratoTitulosAReceber: z.ZodNumber;
+        cobVencimento: z.ZodNumber;
+        contratoStatusModo: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        motivo_status: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        dataCadastro: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        dataAlteracao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        popId: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        popNome: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        cobPermuta: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+        cobIsento: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        promessasPagamentoMes: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        link_quitacao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        planointernet: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        fidelidade: z.ZodNullable<z.ZodOptional<z.ZodObject<{
+            data_inicio: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            descricao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            data_fim: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        }, z.core.$strip>>>;
+        contrato_unificado_principal: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        contrato_unificado_filhos: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodNumber>>>;
+        tags: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+            color: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            font: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            tag: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            id: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+            categoria_id: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        }, z.core.$strip>>>>;
+        anotacoes: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{}, z.core.$strip>>>>;
+        contratoCentralLogin: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        contratoCentralSenha: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        servico_login: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        servico_senha: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        servico_plano: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        servico_grupo: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        servico_tipo_conexao: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        servico_vlan: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        servico_mac: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        servico_mac2: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        servico_wifi_ssid: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        servico_wifi_ssid_5: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        servico_wifi_password: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        servico_wifi_password_5: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        servico_wifi_channel: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        servico_wifi_channel_5: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        razaoSocial: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        cpfCnpj: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        dataNascimento: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        telefones: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+            inscricoes: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodString>>>;
+            tipoContato: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            contato: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        }, z.core.$strip>>>>;
+        telefones_cargos: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{}, z.core.$strip>>>>;
+        emails: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{
+            inscricoes: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodString>>>;
+            tipoContato: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+            contato: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        }, z.core.$strip>>>>;
+        outros: z.ZodNullable<z.ZodOptional<z.ZodArray<z.ZodObject<{}, z.core.$strip>>>>;
+        endereco_logradouro: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        endereco_numero: z.ZodNullable<z.ZodOptional<z.ZodNumber>>;
+        endereco_complemento: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        endereco_bairro: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        endereco_cidade: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        endereco_uf: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        endereco_cep: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        endereco_pontoreferencia: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+        endereco_ll: z.ZodNullable<z.ZodOptional<z.ZodString>>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+/** Key fields of `ura/consultacliente`: required and strict; any mismatch is `SCHEMA_MISMATCH`. */
+export declare const lookupCustomerKeyFields: readonly ["contratos", "contratos[].contratoId", "contratos[].clienteId", "contratos[].contratoStatus", "contratos[].contratoStatusDisplay", "contratos[].contratoValorAberto", "contratos[].contratoTitulosAReceber", "contratos[].cobVencimento"];
+/** Normalized path of each contract item in the `ura/consultacliente` response. */
+export declare const customerContractItemPath = "contratos[]";
+/** Keys of a contract item holding secrets: Central and PPPoE credentials, Wi-Fi, MACs, payoff link. */
+export declare const customerContractSecretKeys: readonly ["contratoCentralLogin", "contratoCentralSenha", "servico_login", "servico_senha", "servico_wifi_password", "servico_wifi_password_5", "servico_wifi_ssid", "servico_wifi_ssid_5", "servico_mac", "servico_mac2", "link_quitacao"];
+/** Keys of a contract item holding personal data: name, CPF/CNPJ, birth date, contacts, address, notes, status reason. */
+export declare const customerContractPersonalKeys: readonly ["motivo_status", "razaoSocial", "cpfCnpj", "dataNascimento", "telefones", "telefones_cargos", "emails", "outros", "anotacoes", "endereco_logradouro", "endereco_numero", "endereco_complemento", "endereco_bairro", "endereco_cidade", "endereco_uf", "endereco_cep", "endereco_pontoreferencia", "endereco_ll"];
+interface LookupCustomerFilters {
+    /** CPF or CNPJ of the customer. */
+    cpfcnpj?: string;
+    /** Contract ID. */
+    contrato?: number;
+    /** Customer name. */
+    nome?: string;
+    /** Service login (PPPoE). */
+    login?: string;
+    telefone?: string;
+}
+/**
+ * Body parameters of `POST /api/ura/consultacliente/` (besides credentials).
+ *
+ * At least one of `cpfcnpj`, `contrato`, `nome`, `login` or `telefone` is required; the others are optional.
+ */
+export type LookupCustomerParams = (LookupCustomerFilters & {
+    cpfcnpj: string;
+}) | (LookupCustomerFilters & {
+    contrato: number;
+}) | (LookupCustomerFilters & {
+    nome: string;
+}) | (LookupCustomerFilters & {
+    login: string;
+}) | (LookupCustomerFilters & {
+    telefone: string;
+});
+/** Parsed response of `POST /api/ura/consultacliente/`. */
+export type LookupCustomerResponse = z.output<typeof lookupCustomerSchema>;
+/** Definition of `POST /api/ura/consultacliente/`. */
+export declare const lookupCustomerDefinition: EndpointDefinition<typeof lookupCustomerSchema>;
+export {};

package/dist/endpoints/ura/open-ticket.d.ts

@@ -0,0 +1,81 @@
+import { z } from "zod";
+import type { WriteEndpointDefinition } from "../../endpoint.js";
+/**
+ * Success body of `POST /api/ura/chamado/`: `status` 1, the ticket protocol and the ID of the
+ * occurrence, plus the contract and customer SGP echoes back. `status` 0 is SGP's refusal.
+ */
+export declare const openTicketSchema: 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.$strip>;
+/**
+ * Key fields of `ura/chamado`: required and strict. A 2xx is only a success with `status` 1 and a
+ * `protocolo`; anything else (e.g. `status` 0 with a `msg`) is `VALIDATION` with `outcome: "unknown"`.
+ */
+export declare const openTicketKeyFields: readonly ["status", "protocolo", "id"];
+/** Normalized path of the opened ticket in the response (the root object). */
+export declare const ticketOpenedItemPath = "";
+/** Keys of the response holding secrets (none in `ura/chamado`). */
+export declare const ticketOpenedSecretKeys: readonly [];
+/** Keys of the response holding personal data: the customer's name and CPF/CNPJ. */
+export declare const ticketOpenedPersonalKeys: readonly ["razaoSocial", "cpfCnpj"];
+/** Parsed response of `POST /api/ura/chamado/`. */
+export type OpenTicketResponse = z.output<typeof openTicketSchema>;
+/**
+ * Params of `POST /api/ura/chamado/`; only `contrato` is required. `contato_nome` and
+ * `contato_telefone` are personal data.
+ */
+export interface OpenTicketParams {
+    /** Contract ID. */
+    contrato: number;
+    /** Content of the occurrence and the service order. */
+    conteudo?: string;
+    /** 1 removes SGP's default opening message ("via URA"). */
+    conteudolimpo?: 0 | 1;
+    observacao?: string;
+    /** Occurrence type code (SGP's default is 5). */
+    ocorrenciatipo?: number;
+    /** Classification IDs linked to the occurrence. */
+    tipoclassificacoes?: number[];
+    /** Occurrence method code (see `ura.listOccurrenceMethods`). */
+    metodo?: number;
+    /** Sector ID. */
+    setor?: number;
+    /** Username shown as who opened the occurrence. */
+    usuario?: string;
+    /** Username of the occurrence's responsible. */
+    responsaveloc?: string;
+    contato_nome?: string;
+    contato_telefone?: string;
+    /** 1 does not open a service order. */
+    desativa_os?: 0 | 1;
+    /** 1 creates the occurrence and the service order already closed. */
+    status_encerrado?: 0 | 1;
+    /** 1 notifies the customer of the closing, when created already closed. */
+    notificar_cliente?: 0 | 1;
+    /** Service order reason code; each SGP instance has its own (see `os.listOccurrenceReasons`). */
+    motivoos?: number;
+    /** Classification IDs linked to the service order. */
+    motivoclassificacoes?: number[];
+    /** Username of the service order's responsible technician. */
+    responsavel?: string;
+    /** Usernames of the auxiliary technicians. */
+    tecnicos?: string[];
+    /** Schedules the occurrence and the service order: `"AAAA-MM-DD HH:MM"`. */
+    data_hora_agendamento?: string;
+    /** 1 warns the responsible technician of the new service order; needs `data_hora_agendamento` and a messaging gateway in SGP. */
+    sms_tecnico?: 0 | 1;
+    /** With `servico_id`, links a specific contract service 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;
+}
+/** Definition of `POST /api/ura/chamado/` (trailing slash required by the token whitelist). */
+export declare const openTicketDefinition: WriteEndpointDefinition<typeof openTicketSchema>;

package/dist/errors.d.ts

@@ -0,0 +1,59 @@
+import type { SgpError, SgpErrorCode, SgpWriteError } from "./result.js";
+/** SGP `detail` for 401/403 caused by wrong token/app credentials. */
+export declare const DETAIL_UNAUTHORIZED = "Credenciais de autentica\u00E7\u00E3o incorretas.";
+/** SGP `detail` for 401/403 when the app has no permission for the route (credentials "not provided"). */
+export declare const DETAIL_ROUTE_NOT_ALLOWED = "As credenciais de autentica\u00E7\u00E3o n\u00E3o foram fornecidas.";
+/** `message` of a write whose 2xx answer does not confirm it: the write may have been applied. */
+export declare const MESSAGE_WRITE_NOT_CONFIRMED = "SGP answered with a success status but the response does not confirm the write; it may have been applied.";
+/** `message` of a write SGP answered with its generic exception wrapper (a 4xx `errors` list): it may have been applied. */
+export declare const MESSAGE_WRITE_FAILED_GENERICALLY = "SGP reported an error while processing the write; it may have been applied.";
+/** `message` of a request the SDK refused before sending it (nothing left the process). */
+export declare const MESSAGE_REJECTED_LOCALLY = "The SDK rejected the request before sending it.";
+/**
+ * Reads the SGP error text from a response body: a string `detail`, else a non-empty string `msg`,
+ * else `errors`, else a non-empty string `error` (see {@link mapHttpFailure}). `undefined` when the
+ * body carries none.
+ */
+export declare const readSgpDetail: (body: unknown) => string | undefined;
+/**
+ * Whether the body is SGP's generic exception wrapper: `errors` is an array (e.g.
+ * `{"errors":["Ocorreu um erro: ..."]}`), as opposed to an object of field messages.
+ */
+export declare const hasErrorList: (body: unknown) => boolean;
+/**
+ * Builds a normalized error with the SDK-authored message for `code`, or with `message` when given.
+ *
+ * The `detail` key is omitted when `detail` is undefined.
+ */
+export declare const createError: (code: SgpErrorCode, status: number, endpoint: string, detail?: string, message?: string) => SgpError;
+/**
+ * Maps a non-2xx SGP response to a normalized error.
+ *
+ * `detail` is read from the first of these that yields text: a string `detail` (SGP's DRF message),
+ * a non-empty string `msg` (e.g. `{"msg":"Informe um Raio válido."}`), then `errors` (the CRM format):
+ * an array of strings joined by `"; "`, or an object of string values as `"key: value"` joined by
+ * `"; "` in key order. Non-string items and values are ignored. Last, a non-empty string `error`
+ * (e.g. `{"error":"Cadastro não encontrado"}`, a 404 on CRM routes). A body with none of these
+ * leaves `detail` undefined. The raw body is never retained.
+ */
+export declare const mapHttpFailure: (status: number, body: unknown, endpoint: string) => SgpError;
+/**
+ * Maps an exception thrown by `fetch` to a normalized error (status 0).
+ *
+ * `TimeoutError` and `AbortError` become `TIMEOUT`; anything else becomes `NETWORK`.
+ * The cause's message is never copied, since it can embed the request URL with credentials.
+ */
+export declare const mapFetchFailure: (cause: unknown, endpoint: string) => SgpError;
+/**
+ * Tags a failed write with whether SGP applied it: `"not_applied"` for a 4xx (SGP rejected the
+ * request) and for a `VALIDATION` with status 0 (rejected locally, nothing was sent), `"unknown"`
+ * for anything else (timeout/network, 5xx, 2xx that failed validation, 1xx/3xx).
+ *
+ * `isErrorListBody` (the {@link hasErrorList} result for the response body) marks a 4xx body that is
+ * SGP's generic exception wrapper: SGP may have failed after applying part of the write, so that 4xx
+ * is `"unknown"` too and carries {@link MESSAGE_WRITE_FAILED_GENERICALLY} as its `message`, except
+ * 401/403/404/405/422, which stay `"not_applied"`. Omit it when the body is not known.
+ *
+ * Returns a new object; the input is not mutated.
+ */
+export declare const toWriteError: (error: SgpError, isErrorListBody?: boolean) => SgpWriteError;