@sinnu-dev/sdk 0.0.0-stage → 0.2.1

package/dist/index.d.cts

@@ -0,0 +1,1285 @@
+import { Client, FetchResponse, ParseAsResponse } from 'openapi-fetch';
+import { SuccessResponse, ResponseObjectMap } from 'openapi-typescript-helpers';
+
+/**
+ * This file was auto-generated by openapi-typescript.
+ * Do not make direct changes to the file.
+ */
+
+interface paths {
+    "/api/customers/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Listar clientes
+         * @description Lista os clientes da empresa autenticada no envelope paginado `{ data, total, page, pageSize }`.
+         */
+        get: operations["customers_list"];
+        put?: never;
+        /**
+         * Cadastrar cliente
+         * @description Cadastra um cliente na empresa autenticada. O CPF ou CNPJ é único por empresa.
+         */
+        post: operations["customers_create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/customers/{id}/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Consultar cliente
+         * @description Retorna um cliente da empresa autenticada.
+         */
+        get: operations["customers_retrieve"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /**
+         * Atualizar cliente
+         * @description Atualiza parcialmente um cliente da empresa autenticada.
+         */
+        patch: operations["customers_partial_update"];
+        trace?: never;
+    };
+    "/api/payment-links": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Listar links de pagamento
+         * @description Lista os links de pagamento da empresa autenticada no envelope paginado do sinnu `{ data, total, page, pageSize }`.
+         */
+        get: operations["paymentLinks_list"];
+        put?: never;
+        /**
+         * Criar link de pagamento
+         * @description Cria um link de pagamento para a empresa autenticada. Use este recurso para gerar cobranças compartilháveis com suporte a Pix e cartão de crédito.
+         */
+        post: operations["paymentLinks_create"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/payment-links/{id}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Consultar link de pagamento
+         * @description Retorna os detalhes de um link de pagamento da empresa autenticada.
+         */
+        get: operations["paymentLinks_retrieve"];
+        put?: never;
+        post?: never;
+        /**
+         * Arquivar link de pagamento
+         * @description Arquiva um link de pagamento da empresa autenticada.
+         */
+        delete: operations["paymentLinks_destroy"];
+        options?: never;
+        head?: never;
+        /**
+         * Atualizar link de pagamento
+         * @description Atualiza um link de pagamento da empresa autenticada.
+         */
+        patch: operations["paymentLinks_partialUpdate"];
+        trace?: never;
+    };
+    "/api/payment-links/{id}/transactions": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Listar transações do link
+         * @description Lista as transações originadas por um link de pagamento da empresa autenticada.
+         */
+        get: operations["paymentLinks_transactions"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/transactions/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Listar transações
+         * @description Lista transações da empresa autenticada no envelope paginado `{ data, total, page, pageSize }`. Use `status`, `customer` e `search` para filtrar.
+         */
+        get: operations["transactions_list"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/transactions/{id}/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Consultar transação
+         * @description Retorna uma transação da empresa autenticada em formato flat.
+         */
+        get: operations["transactions_retrieve"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+    "/api/transactions/{id}/refund/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Estornar transação
+         * @description Solicita o estorno total de uma transação paga. Exige o escopo `transactions:refund` na chave de API; o `read` não concede estorno. `reason` e `note` são opcionais e servem para registro interno. Reenvios podem usar `Idempotency-Key`.
+         */
+        post: operations["transactions_refund"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
+}
+interface components {
+    schemas: {
+        /**
+         * @description * `absorb` - Eu absorvo
+         *     * `pass_to_customer` - Cliente paga
+         * @enum {string}
+         */
+        InterestModeEnum: "absorb" | "pass_to_customer";
+        PaginatedPaymentLink: {
+            total: number;
+            page: number;
+            pageSize: number;
+            data: components["schemas"]["PaymentLinkRead"][];
+        };
+        PaginatedPaymentLinkTransaction: {
+            total: number;
+            page: number;
+            pageSize: number;
+            data: components["schemas"]["PaymentLinkTransactionItem"][];
+        };
+        PaginatedSinnuCustomerList: {
+            data: components["schemas"]["SinnuCustomer"][];
+            /** @example 123 */
+            total: number;
+            /** @example 1 */
+            page: number;
+            /** @example 20 */
+            pageSize: number;
+        };
+        PaginatedSinnuTransactionList: {
+            data: components["schemas"]["SinnuTransaction"][];
+            /** @example 123 */
+            total: number;
+            /** @example 1 */
+            page: number;
+            /** @example 20 */
+            pageSize: number;
+        };
+        /** @description Body para atualizar parcialmente um link de pagamento. */
+        PatchedPaymentLinkWrite: {
+            /** @description Título exibido no checkout hospedado. */
+            title?: string;
+            /** @description Descrição exibida no checkout. */
+            description?: string;
+            /** Format: uri */
+            imageUrl?: string | null;
+            /** @description Modo de preço. No contrato público atual, use sempre `fixed`. */
+            priceMode?: components["schemas"]["PriceModeEnum"];
+            /** @description Valor fixo do link em centavos. Obrigatório para `priceMode: fixed`. */
+            amountCents?: number | null;
+            /** @description Reservado para modos de preço futuros. Não use no contrato público atual. */
+            minAmountCents?: number | null;
+            /** @description Reservado para modos de preço futuros. Não use no contrato público atual. */
+            maxAmountCents?: number | null;
+            /** @description Métodos aceitos no checkout. Envie `pix`, `credit_card` ou ambos. */
+            methods?: ("pix" | "credit_card")[];
+            /** @description Número máximo de parcelas para cartão. Use 1 quando o link aceitar apenas Pix. */
+            maxInstallments?: number;
+            /** @description Define quem absorve juros de parcelamento: `absorb` ou `pass_to_customer`. */
+            interestMode?: components["schemas"]["InterestModeEnum"];
+            /** @description Status do link: active, paused ou archived. */
+            status?: components["schemas"]["Status50eEnum"];
+            /** @description Modo de 3DS para cartão: `always` ou `contingency`. */
+            threeDsMode?: components["schemas"]["ThreeDsModeEnum"];
+            /** @description Tags livres para organização interna do link. */
+            tags?: string[];
+            /** @description Para onde o checkout leva o comprador depois do pagamento confirmado (cartão aprovado ou Pix pago), com `transactionId`, `reference` e `status=approved` na query. Aceita `https://` ou o esquema do seu app (`meuapp://pedido`). O retorno é liberado por empresa: confirme com a Sinnu se já está ativo para a sua. Confirme o pagamento pela API ou pelo webhook: os parâmetros da URL podem ser alterados pelo comprador. */
+            redirectUrl?: string | null;
+            /** @description Código do produto no seu sistema. Volta como `externalRef` do item em cada venda do link. */
+            externalReference?: string | null;
+            /**
+             * Format: uuid
+             * @description ID de um cliente já cadastrado para vincular ao link.
+             */
+            linkedCustomer?: string | null;
+        };
+        /** @description Cliente da sua empresa. Expõe apenas os dados principais de cadastro e um único documento principal (CPF ou CNPJ). */
+        PatchedSinnuCustomer: {
+            /** Format: uuid */
+            readonly id?: string;
+            name?: string;
+            /** Format: email */
+            email?: string;
+            phone?: string;
+            /** @description Documento principal do cliente: CPF ou CNPJ, somente dígitos ou formatado. */
+            document?: string | null;
+            /** @description Tipo do documento principal: `pf` para CPF ou `pj` para CNPJ. */
+            type?: components["schemas"]["SinnuCustomerTypeEnum"];
+            /** Format: date-time */
+            readonly createdAt?: string;
+            /** @description Endereço em linha livre, opcional. */
+            address?: string | null;
+            /** @description Observações internas sobre o cliente, opcionais. */
+            notes?: string | null;
+        };
+        /** @description Link de pagamento público da empresa autenticada. Use o `slug` para montar a URL do checkout hospedado. */
+        PaymentLinkRead: {
+            /** Format: uuid */
+            readonly id: string;
+            readonly slug: string;
+            /** @description Título exibido no checkout hospedado. */
+            readonly title: string;
+            /** @description Descrição exibida no checkout. */
+            readonly description: string;
+            /** Format: uri */
+            readonly imageUrl: string | null;
+            /** @description Modo de preço. No contrato público atual, use sempre `fixed`. */
+            readonly priceMode: components["schemas"]["PriceModeEnum"];
+            /** @description Valor fixo do link em centavos. Obrigatório para `priceMode: fixed`. */
+            readonly amountCents: number | null;
+            /** @description Reservado para modos de preço futuros. Não use no contrato público atual. */
+            readonly minAmountCents: number | null;
+            /** @description Reservado para modos de preço futuros. Não use no contrato público atual. */
+            readonly maxAmountCents: number | null;
+            /** @description Métodos aceitos no checkout. Envie `pix`, `credit_card` ou ambos. */
+            readonly methods: ("pix" | "credit_card")[];
+            /** @description Número máximo de parcelas para cartão. Use 1 quando o link aceitar apenas Pix. */
+            readonly maxInstallments: number;
+            /** @description Define quem absorve juros de parcelamento: `absorb` ou `pass_to_customer`. */
+            readonly interestMode: components["schemas"]["InterestModeEnum"];
+            /** @description Status do link: active, paused ou archived. */
+            readonly status: components["schemas"]["Status50eEnum"];
+            /** @description Modo de 3DS para cartão: `always` ou `contingency`. */
+            readonly threeDsMode: components["schemas"]["ThreeDsModeEnum"];
+            /** @description Tags livres para organização interna do link. */
+            readonly tags: string[];
+            /** @description Para onde o checkout leva o comprador depois do pagamento confirmado (cartão aprovado ou Pix pago), com `transactionId`, `reference` e `status=approved` na query. Aceita `https://` ou o esquema do seu app (`meuapp://pedido`). O retorno é liberado por empresa: confirme com a Sinnu se já está ativo para a sua. Confirme o pagamento pela API ou pelo webhook: os parâmetros da URL podem ser alterados pelo comprador. */
+            readonly redirectUrl: string | null;
+            /** @description Código do produto no seu sistema. Volta como `externalRef` do item em cada venda do link. */
+            readonly externalReference: string | null;
+            /** @description ID do cliente vinculado ao link, quando houver. */
+            readonly linkedCustomerId: string | null;
+            readonly companyId: number | null;
+            readonly companyName: string | null;
+            readonly sellerEmail: string | null;
+            /** Format: date-time */
+            readonly createdAt: string;
+            /** Format: date-time */
+            readonly updatedAt: string;
+        };
+        PaymentLinkTransactionCustomer: {
+            id: string;
+            name: string;
+            /** Format: email */
+            email: string;
+        };
+        PaymentLinkTransactionItem: {
+            /** Format: uuid */
+            id: string;
+            /** Format: double */
+            amount: number;
+            status: string;
+            paymentMethod: string;
+            installments: number;
+            customer: components["schemas"]["PaymentLinkTransactionCustomer"];
+            /** Format: date-time */
+            createdAt: string;
+            /** Format: date-time */
+            paidAt: string | null;
+        };
+        /** @description Body para criar um link de pagamento. Use `priceMode: fixed` e envie o valor em `amountCents`. */
+        PaymentLinkWrite: {
+            /** @description Título exibido no checkout hospedado. */
+            title: string;
+            /** @description Descrição exibida no checkout. */
+            description?: string;
+            /** Format: uri */
+            imageUrl?: string | null;
+            /** @description Modo de preço. No contrato público atual, use sempre `fixed`. */
+            priceMode?: components["schemas"]["PriceModeEnum"];
+            /** @description Valor fixo do link em centavos. Obrigatório para `priceMode: fixed`. */
+            amountCents?: number | null;
+            /** @description Reservado para modos de preço futuros. Não use no contrato público atual. */
+            minAmountCents?: number | null;
+            /** @description Reservado para modos de preço futuros. Não use no contrato público atual. */
+            maxAmountCents?: number | null;
+            /** @description Métodos aceitos no checkout. Envie `pix`, `credit_card` ou ambos. */
+            methods?: ("pix" | "credit_card")[];
+            /** @description Número máximo de parcelas para cartão. Use 1 quando o link aceitar apenas Pix. */
+            maxInstallments?: number;
+            /** @description Define quem absorve juros de parcelamento: `absorb` ou `pass_to_customer`. */
+            interestMode?: components["schemas"]["InterestModeEnum"];
+            /** @description Status do link: active, paused ou archived. */
+            status?: components["schemas"]["Status50eEnum"];
+            /** @description Modo de 3DS para cartão: `always` ou `contingency`. */
+            threeDsMode?: components["schemas"]["ThreeDsModeEnum"];
+            /** @description Tags livres para organização interna do link. */
+            tags?: string[];
+            /** @description Para onde o checkout leva o comprador depois do pagamento confirmado (cartão aprovado ou Pix pago), com `transactionId`, `reference` e `status=approved` na query. Aceita `https://` ou o esquema do seu app (`meuapp://pedido`). O retorno é liberado por empresa: confirme com a Sinnu se já está ativo para a sua. Confirme o pagamento pela API ou pelo webhook: os parâmetros da URL podem ser alterados pelo comprador. */
+            redirectUrl?: string | null;
+            /** @description Código do produto no seu sistema. Volta como `externalRef` do item em cada venda do link. */
+            externalReference?: string | null;
+            /**
+             * Format: uuid
+             * @description ID de um cliente já cadastrado para vincular ao link.
+             */
+            linkedCustomer?: string | null;
+        };
+        /**
+         * @description * `fixed` - Fixo
+         * @enum {string}
+         */
+        PriceModeEnum: "fixed";
+        /** @description Cliente da sua empresa. Expõe apenas os dados principais de cadastro e um único documento principal (CPF ou CNPJ). */
+        SinnuCustomer: {
+            /** Format: uuid */
+            readonly id: string;
+            name: string;
+            /** Format: email */
+            email: string;
+            phone: string;
+            /** @description Documento principal do cliente: CPF ou CNPJ, somente dígitos ou formatado. */
+            document?: string | null;
+            /** @description Tipo do documento principal: `pf` para CPF ou `pj` para CNPJ. */
+            type?: components["schemas"]["SinnuCustomerTypeEnum"];
+            /** Format: date-time */
+            readonly createdAt: string;
+            /** @description Endereço em linha livre, opcional. */
+            address?: string | null;
+            /** @description Observações internas sobre o cliente, opcionais. */
+            notes?: string | null;
+        };
+        /**
+         * @description * `pf` - pf
+         *     * `pj` - pj
+         * @enum {string}
+         */
+        SinnuCustomerTypeEnum: "pf" | "pj";
+        /** @description Pedido de estorno. O estorno é sempre do valor total; não há campo de valor. */
+        SinnuRefundRequest: {
+            /** @description Motivo do estorno, opcional. */
+            reason?: string;
+            /** @description Observação sobre o estorno, opcional. */
+            note?: string;
+        };
+        /** @description Transação da empresa autenticada. Valores monetários são inteiros em centavos. */
+        SinnuTransaction: {
+            readonly id: string;
+            /** @description Valor bruto cobrado do pagador, em centavos. */
+            readonly amount: number;
+            /** @description Valor líquido da empresa, em centavos. */
+            readonly net: number;
+            /** @description Preço do produto, em centavos, antes dos juros de parcelamento. */
+            readonly productAmount: number;
+            /** @description Juros do parcelamento, em centavos. */
+            readonly interestAmount: number;
+            /** @description Quem paga os juros do parcelamento: `absorb` ou `pass_to_customer`. */
+            readonly interestMode: string | null;
+            readonly mdrAmount: number;
+            readonly fixedFeeAmount: number;
+            readonly otherFeeAmount: number;
+            readonly totalFeeAmount: number;
+            /** @description Status da transação: pending, approved, refused, refunded ou chargeback. */
+            readonly status: string;
+            /** @description Método de pagamento: pix ou credit_card. */
+            readonly method: string;
+            /** @description Pagador da transação: `{ id, name, email }`. */
+            readonly customer: {
+                [key: string]: unknown;
+            };
+            /** @description Descrição da venda. Vazia quando não informada. */
+            readonly description: string;
+            readonly installments: number;
+            /** Format: date-time */
+            readonly createdAt: string;
+            /** Format: date-time */
+            readonly paidAt: string | null;
+            /** @description Pedido do seu sistema para esta venda: o `?ref=` com que o checkout foi aberto, ou o `exId` da cobrança criada pela API. `null` quando não informado. */
+            readonly reference: string | null;
+        };
+        /**
+         * @description * `active` - Ativo
+         *     * `paused` - Pausado
+         *     * `archived` - Arquivado
+         * @enum {string}
+         */
+        Status50eEnum: "active" | "paused" | "archived";
+        /**
+         * @description * `always` - Sempre
+         *     * `contingency` - Contingência
+         * @enum {string}
+         */
+        ThreeDsModeEnum: "always" | "contingency";
+    };
+    responses: never;
+    parameters: never;
+    requestBodies: never;
+    headers: never;
+    pathItems: never;
+}
+interface operations {
+    customers_list: {
+        parameters: {
+            query?: {
+                /** @description Which field to use when ordering the results. */
+                ordering?: string;
+                /** @description Número da página (1-based; default 1). */
+                page?: number;
+                /** @description Tamanho da página (default 20, máx. 100). */
+                pageSize?: number;
+                /** @description Busca por nome, e-mail, telefone ou documento. */
+                search?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaginatedSinnuCustomerList"];
+                };
+            };
+        };
+    };
+    customers_create: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["SinnuCustomer"];
+                "application/x-www-form-urlencoded": components["schemas"]["SinnuCustomer"];
+                "multipart/form-data": components["schemas"]["SinnuCustomer"];
+            };
+        };
+        responses: {
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SinnuCustomer"];
+                };
+            };
+        };
+    };
+    customers_retrieve: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SinnuCustomer"];
+                };
+            };
+        };
+    };
+    customers_partial_update: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["PatchedSinnuCustomer"];
+                "application/x-www-form-urlencoded": components["schemas"]["PatchedSinnuCustomer"];
+                "multipart/form-data": components["schemas"]["PatchedSinnuCustomer"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SinnuCustomer"];
+                };
+            };
+        };
+    };
+    paymentLinks_list: {
+        parameters: {
+            query?: {
+                page?: number;
+                pageSize?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaginatedPaymentLink"];
+                };
+            };
+            /** @description Sua chave de API não tem permissão para consultar este recurso. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    paymentLinks_create: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["PaymentLinkWrite"];
+                "application/x-www-form-urlencoded": components["schemas"]["PaymentLinkWrite"];
+                "multipart/form-data": components["schemas"]["PaymentLinkWrite"];
+            };
+        };
+        responses: {
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaymentLinkRead"];
+                };
+            };
+            /** @description Sua chave de API não tem permissão para criar ou alterar links de pagamento. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    paymentLinks_retrieve: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaymentLinkRead"];
+                };
+            };
+            /** @description Sua chave de API não tem permissão para consultar este recurso. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    paymentLinks_destroy: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description No response body */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @description Sua chave de API não tem permissão para criar ou alterar links de pagamento. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    paymentLinks_partialUpdate: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["PatchedPaymentLinkWrite"];
+                "application/x-www-form-urlencoded": components["schemas"]["PatchedPaymentLinkWrite"];
+                "multipart/form-data": components["schemas"]["PatchedPaymentLinkWrite"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaymentLinkRead"];
+                };
+            };
+            /** @description Sua chave de API não tem permissão para criar ou alterar links de pagamento. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    paymentLinks_transactions: {
+        parameters: {
+            query?: {
+                page?: number;
+                pageSize?: number;
+            };
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaginatedPaymentLinkTransaction"];
+                };
+            };
+            /** @description Sua chave de API não tem permissão para consultar este recurso. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    transactions_list: {
+        parameters: {
+            query?: {
+                /** @description Filtra as transações por ID do cliente (Customer.id, UUID). */
+                customer?: string;
+                /** @description Número da página (1-based, default 1). */
+                page?: number;
+                /** @description Itens por página (default 20, máx. 100). */
+                pageSize?: number;
+                /** @description Busca por nome/e-mail do cliente ou descrição. */
+                search?: string;
+                /** @description Filtra pelo status do painel: approved | pending | refused | refunded | chargeback. */
+                status?: string;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["PaginatedSinnuTransactionList"];
+                };
+            };
+            /** @description Sua chave de API não tem permissão para consultar transações. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    transactions_retrieve: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SinnuTransaction"];
+                };
+            };
+            /** @description Sua chave de API não tem permissão para consultar transações. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+    transactions_refund: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description Chave de idempotência: reenvios com a mesma chave numa transação já estornada retornam a transação atual sem reexecutar o estorno. */
+                "Idempotency-Key"?: string;
+            };
+            path: {
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: {
+            content: {
+                "application/json": components["schemas"]["SinnuRefundRequest"];
+                "application/x-www-form-urlencoded": components["schemas"]["SinnuRefundRequest"];
+                "multipart/form-data": components["schemas"]["SinnuRefundRequest"];
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["SinnuTransaction"];
+                };
+            };
+            /** @description Sua chave de API não tem o escopo `transactions:refund`, exigido para solicitar estorno. */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+        };
+    };
+}
+
+/** URL de produção padrão da API sinnu. */
+declare const DEFAULT_BASE_URL = "https://api.sinnu.com.br";
+interface SinnuOptions {
+    /**
+     * API key secreta do servidor (`sk_live_...`).
+     * Enviada como `Authorization: Bearer <apiKey>`.
+     */
+    apiKey: string;
+    /** Base URL da API. Default: {@link DEFAULT_BASE_URL}. */
+    baseUrl?: string;
+    /**
+     * Base URL do checkout hosted (`pay.sinnu.com.br`). Usada por
+     * `sinnu.checkout.url(slug)`. Default em produção.
+     */
+    checkoutBaseUrl?: string;
+    /** Headers extras enviados em toda requisição. */
+    headers?: Record<string, string>;
+    /** Implementação de fetch customizada (ex.: para Node < 18 ou testes). */
+    fetch?: typeof fetch;
+}
+/**
+ * Cria o client HTTP tipado (openapi-fetch) com a auth por API key já aplicada.
+ * Normalmente você usa a classe {@link SinnuClient} em vez desta função.
+ */
+declare function createTypedClient(options: SinnuOptions): Client<paths>;
+/**
+ * Desempacota uma resposta do openapi-fetch: devolve `data` em caso de sucesso
+ * ou lança um {@link SinnuError} tipado em caso de falha.
+ */
+declare function unwrap<T extends Record<string | number, unknown>, Options, Media extends `${string}/${string}`>(p: Promise<FetchResponse<T, Options, Media>>): Promise<ParseAsResponse<SuccessResponse<ResponseObjectMap<T>, Media>, Options>>;
+type TypedClient = Client<paths>;
+interface RawRequestOptions {
+    method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+    /** Query string params (valores serializados; undefined é omitido). */
+    query?: Record<string, string | number | boolean | undefined>;
+    /** Corpo JSON da requisição. */
+    body?: unknown;
+}
+/**
+ * Cliente de baixo nível para recursos do SDK que usam o contrato público atual.
+ * Aplica a mesma auth por API key e normaliza erros em {@link SinnuError}.
+ */
+declare class RawHttp {
+    private readonly baseUrl;
+    private readonly apiKey;
+    private readonly extraHeaders;
+    private readonly fetchImpl;
+    constructor(baseUrl: string, apiKey: string, extraHeaders: Record<string, string>, fetchImpl: typeof fetch);
+    request<T>(path: string, options?: RawRequestOptions): Promise<T>;
+}
+
+/** URL pública padrão do checkout hosted do sinnu. */
+declare const DEFAULT_CHECKOUT_BASE_URL = "https://pay.sinnu.com.br";
+interface CheckoutUrlOptions {
+    /**
+     * Base URL do checkout hosted. Default: {@link DEFAULT_CHECKOUT_BASE_URL}.
+     * Útil para apontar para staging/local.
+     */
+    checkoutBaseUrl?: string;
+    /**
+     * Pedido do seu sistema para ESTA venda. Vai como `?ref=` na URL, fica gravado
+     * na venda e volta como `reference` na transação, no webhook e no retorno para
+     * o `redirectUrl` do link. Até 255 caracteres.
+     */
+    reference?: string;
+    /**
+     * Query params extras anexados à URL (ex.: `utm_source`).
+     * Valores `undefined` são omitidos.
+     */
+    query?: Record<string, string | number | boolean | undefined>;
+}
+/** Recurso de checkout: construtor de URL pública hosted por slug. */
+declare class Checkout {
+    private readonly options;
+    constructor(options?: CheckoutUrlOptions);
+    /**
+     * Monta a URL pública do checkout hosted para um `slug` (8 chars) gerado
+     * ao criar um link (`sinnu.links.create(...).url` já vem pronto; este
+     * helper é útil quando você só tem o slug).
+     *
+     * @example
+     * const url = sinnu.checkout.url("abcd1234", { reference: "pedido-123" });
+     * // => "https://pay.sinnu.com.br/abcd1234?ref=pedido-123"
+     */
+    url(slug: string, options?: CheckoutUrlOptions): string;
+}
+
+/** Página de uma listagem da API sinnu. */
+interface Page<T> {
+    data: T[];
+    total: number;
+    page: number;
+    pageSize: number;
+}
+/** Parâmetros de paginação aceitos pelas listagens. */
+interface PageParams {
+    page?: number;
+    pageSize?: number;
+}
+/**
+ * Itera, página a página, sobre um endpoint paginado.
+ *
+ * @param fetchPage Função que recebe o número da página e devolve uma `Page<T>`.
+ * @example
+ * for await (const tx of paginate((page) => sinnu.transactions.list({ page }))) {
+ *   console.log(tx.id);
+ * }
+ */
+declare function paginate<T>(fetchPage: (page: number) => Promise<Page<T>>): AsyncGenerator<T, void, undefined>;
+/** Coleta todas as páginas em um único array (cuidado com listas muito grandes). */
+declare function collectAll<T>(fetchPage: (page: number) => Promise<Page<T>>): Promise<T[]>;
+
+type PaymentMethod = "pix" | "credit_card" | "applepay" | "googlepay";
+type PriceMode = "fixed";
+type InterestMode = "absorb" | "pass_to_customer";
+type PaymentLinkStatus = "active" | "paused" | "archived";
+type ThreeDsMode = "always" | "contingency";
+type TransactionStatus = "approved" | "pending" | "refused" | "refunded" | "chargeback" | (string & {});
+interface PaymentLink {
+    id: string;
+    slug: string;
+    title: string;
+    description: string;
+    imageUrl: string | null;
+    priceMode: PriceMode;
+    amountCents: number | null;
+    minAmountCents: number | null;
+    maxAmountCents: number | null;
+    methods: PaymentMethod[];
+    maxInstallments: number;
+    interestMode: InterestMode;
+    status: PaymentLinkStatus;
+    threeDsMode: ThreeDsMode;
+    tags: string[];
+    /** Retorno depois do pagamento confirmado: `https://` ou deep link do app. */
+    redirectUrl: string | null;
+    /** Código do produto no seu sistema; volta como `externalRef` do item. */
+    externalReference: string | null;
+    linkedCustomerId: string | null;
+    companyId?: number | null;
+    companyName?: string | null;
+    sellerEmail?: string | null;
+    createdAt: string;
+    updatedAt: string;
+}
+interface CreatePaymentLinkBody {
+    title: string;
+    description?: string;
+    imageUrl?: string | null;
+    priceMode?: PriceMode;
+    amountCents: number;
+    methods?: PaymentMethod[];
+    maxInstallments?: number;
+    interestMode?: InterestMode;
+    status?: PaymentLinkStatus;
+    threeDsMode?: ThreeDsMode;
+    tags?: string[];
+    /**
+     * Para onde o checkout leva o comprador depois do pagamento confirmado, com
+     * `transactionId`, `reference` e `status=approved` na query. `https://` ou o
+     * esquema do seu app (`meuapp://pedido`).
+     */
+    redirectUrl?: string | null;
+    /** Código do produto no seu sistema; volta como `externalRef` do item. */
+    externalReference?: string | null;
+    linkedCustomer?: string | null;
+}
+type UpdatePaymentLinkBody = Partial<CreatePaymentLinkBody>;
+interface PaymentLinkTransaction {
+    id: string;
+    amount: number;
+    status: string;
+    paymentMethod: string;
+    installments: number;
+    customer: {
+        id: string;
+        name: string;
+        email: string;
+    };
+    createdAt: string;
+    paidAt: string | null;
+}
+interface Transaction {
+    id: string;
+    amount: number;
+    net: number;
+    productAmount: number;
+    interestAmount: number;
+    interestMode: InterestMode | null;
+    mdrAmount: number;
+    fixedFeeAmount: number;
+    otherFeeAmount: number;
+    totalFeeAmount: number;
+    status: TransactionStatus;
+    method: PaymentMethod | (string & {});
+    customer: {
+        id?: string;
+        name?: string;
+        email?: string;
+        [key: string]: unknown;
+    };
+    description: string;
+    installments: number;
+    createdAt: string;
+    paidAt: string | null;
+    /** Pedido do seu sistema para esta venda (`?ref=` do checkout). */
+    reference: string | null;
+}
+
+interface ListPaymentLinksParams extends PageParams {
+}
+declare class Links {
+    private readonly http;
+    constructor(http: RawHttp);
+    /** Cria um link de pagamento (valor em centavos). */
+    create(body: CreatePaymentLinkBody): Promise<PaymentLink>;
+    /** Busca um link de pagamento pelo id. */
+    get(id: string): Promise<PaymentLink>;
+    /** Atualiza parcialmente um link de pagamento. */
+    update(id: string, body: UpdatePaymentLinkBody): Promise<PaymentLink>;
+    /** Arquiva um link de pagamento. */
+    archive(id: string): Promise<void>;
+    /** Lista links de pagamento (paginado). */
+    list(params?: ListPaymentLinksParams): Promise<Page<PaymentLink>>;
+    /** Lista transações de um link de pagamento (paginado). */
+    transactions(id: string, params?: PageParams): Promise<Page<PaymentLinkTransaction>>;
+    /** Itera todos os links de pagamento, página a página. */
+    listAll(params?: ListPaymentLinksParams): AsyncGenerator<PaymentLink>;
+}
+
+interface ListTransactionsParams extends PageParams {
+    /** Filtra por status (approved, pending, refused, refunded, chargeback). */
+    status?: string;
+    /** Busca por nome/e-mail do cliente ou descrição. */
+    search?: string;
+    /** Filtra por ID do cliente. */
+    customer?: string;
+}
+interface RefundTransactionBody {
+    reason?: string;
+    note?: string;
+}
+declare class Transactions {
+    private readonly http;
+    constructor(http: RawHttp);
+    /** Lista transações (paginado, com filtro opcional por status). */
+    list(params?: ListTransactionsParams): Promise<Page<Transaction>>;
+    /** Busca uma transação pelo id. */
+    get(id: string): Promise<Transaction>;
+    /** Estorna (refund) uma transação, sempre pelo valor total. Exige o escopo `transactions:refund` na chave. */
+    refund(id: string, body?: RefundTransactionBody): Promise<Transaction>;
+    /** Itera todas as transações, página a página. */
+    listAll(params?: ListTransactionsParams): AsyncGenerator<Transaction>;
+}
+
+/** Payload de erro padrão da API sinnu: `{ status: "error", message: "..." }`. */
+interface SinnuApiErrorBody {
+    status?: string;
+    message?: string;
+    [key: string]: unknown;
+}
+/** Erro base de qualquer resposta de falha da API sinnu. */
+declare class SinnuError extends Error {
+    /** Status HTTP da resposta (0 quando o erro é de rede/transporte). */
+    readonly statusCode: number;
+    /** Corpo de erro retornado pela API, quando houver. */
+    readonly body?: SinnuApiErrorBody;
+    /** Resposta `fetch` crua, quando disponível. */
+    readonly response?: Response;
+    constructor(message: string, statusCode: number, body?: SinnuApiErrorBody, response?: Response);
+}
+/** 401 (chave ausente, inválida ou expirada) ou 403 (chave sem permissão). */
+declare class SinnuAuthError extends SinnuError {
+    constructor(message: string, statusCode?: 401 | 403, body?: SinnuApiErrorBody, response?: Response);
+}
+/** 404: recurso não encontrado. */
+declare class SinnuNotFoundError extends SinnuError {
+    constructor(message: string, body?: SinnuApiErrorBody, response?: Response);
+}
+/** 400/422: payload inválido (validação). */
+declare class SinnuValidationError extends SinnuError {
+    constructor(message: string, statusCode: number, body?: SinnuApiErrorBody, response?: Response);
+}
+/** 429: limite de requisições atingido. */
+declare class SinnuRateLimitError extends SinnuError {
+    constructor(message: string, body?: SinnuApiErrorBody, response?: Response);
+}
+
+/** Header padrão onde a Sinnu envia a assinatura HMAC do webhook. */
+declare const SINNU_SIGNATURE_HEADER = "x-sinnu-signature";
+type SinnuWebhookEventType = "transaction.approved" | "transaction.declined" | "transaction.refunded" | "transaction.canceled" | "transaction.changed" | "transaction.chargeback" | "withdrawal.approved" | "account.changed" | "account.approved" | "account.declined" | (string & {});
+/** Envelope de um evento de webhook da Sinnu. */
+interface SinnuWebhookEvent<T = Record<string, unknown>> {
+    version?: string;
+    /** Tipo do evento, por exemplo `transaction.approved`. */
+    type: SinnuWebhookEventType;
+    /** Carga útil do evento. */
+    data: T;
+    [key: string]: unknown;
+}
+/** Link de pagamento que originou a venda. O título é o nome do produto. */
+interface SinnuWebhookLink {
+    id: string;
+    title: string;
+}
+/** Item vendido. `unitPrice` em reais, como `amount`. */
+interface SinnuWebhookItem {
+    title: string;
+    quantity: number;
+    unitPrice: number | null;
+    externalRef: string | null;
+}
+/** Membro da equipe responsável pela venda, escolhido no link. */
+interface SinnuWebhookSalesperson {
+    id: number;
+    name: string;
+    email: string;
+}
+/** Comprador. O documento sai sempre mascarado. */
+interface SinnuWebhookCustomer {
+    name: string;
+    email: string;
+    document: string | null;
+    phone: string | null;
+}
+/** `data` dos eventos `transaction.*`. Valores em reais. */
+interface SinnuTransactionWebhookData {
+    id: string;
+    status: string;
+    amount: number;
+    currency: string;
+    installments: number;
+    paymentMethod: string;
+    createdAt: string;
+    card: {
+        lastDigits: string;
+        brand: string;
+    } | null;
+    customer: SinnuWebhookCustomer;
+    /** `null` quando a cobrança foi criada pela API, sem link. */
+    link: SinnuWebhookLink | null;
+    /** Pedido do seu sistema para esta venda (`?ref=` do checkout). */
+    reference: string | null;
+    items: SinnuWebhookItem[];
+    /** `null` quando o link não tem vendedor responsável. */
+    salesperson: SinnuWebhookSalesperson | null;
+}
+/** Erro lançado quando a assinatura de um webhook é inválida ou ausente. */
+declare class SinnuWebhookSignatureError extends SinnuError {
+    constructor(message: string);
+}
+interface VerifyWebhookOptions {
+    /**
+     * Corpo cru da requisição, exatamente como recebido. Não use JSON já parseado.
+     */
+    payload: string | Buffer;
+    /**
+     * Valor do header de assinatura. Pode vir como `"<hex>"` ou `"sha256=<hex>"`.
+     */
+    signature: string | string[] | undefined;
+    /** Webhook secret do seller, gerado no painel em Integrações. */
+    secret: string;
+}
+/** Calcula a assinatura HMAC SHA-256 em hexadecimal. */
+declare function computeSignature(payload: string | Buffer, secret: string): string;
+/**
+ * Verifica a assinatura HMAC SHA-256 de um webhook da Sinnu.
+ *
+ * @returns `true` se a assinatura for válida.
+ * @throws {SinnuWebhookSignatureError} se o header estiver ausente ou vazio.
+ */
+declare function verifySignature(options: VerifyWebhookOptions): boolean;
+/**
+ * Verifica a assinatura e desserializa o evento de webhook da Sinnu.
+ *
+ * @example
+ * app.post("/webhooks/sinnu", express.raw({ type: "application/json" }), (req, res) => {
+ *   try {
+ *     const event = constructEvent({
+ *       payload: req.body,
+ *       signature: req.header("X-Sinnu-Signature"),
+ *       secret: process.env.SINNU_WEBHOOK_SECRET!,
+ *     });
+ *     if (event.type === "transaction.approved") liberarProduto(event.data);
+ *     res.sendStatus(200);
+ *   } catch {
+ *     res.sendStatus(400);
+ *   }
+ * });
+ *
+ * @throws {SinnuWebhookSignatureError} se a assinatura for inválida ou ausente.
+ */
+declare function constructEvent<T = Record<string, unknown>>(options: VerifyWebhookOptions): SinnuWebhookEvent<T>;
+/** Coleção de helpers de webhook, exposta também em `sinnu.webhooks`. */
+declare const webhooks: {
+    readonly signatureHeader: "x-sinnu-signature";
+    readonly computeSignature: typeof computeSignature;
+    readonly verifySignature: typeof verifySignature;
+    readonly constructEvent: typeof constructEvent;
+};
+type Webhooks = typeof webhooks;
+
+/** Client principal do SDK sinnu. */
+declare class Sinnu {
+    /** Client tipado de baixo nível (openapi-fetch): uso avançado. */
+    readonly http: TypedClient;
+    /** Links de pagamento. */
+    readonly links: Links;
+    /** Transações. */
+    readonly transactions: Transactions;
+    /** Checkout hosted (construtor de URL pública por slug). */
+    readonly checkout: Checkout;
+    /** Verificação de webhooks (HMAC SHA-256): não faz requisições. */
+    readonly webhooks: Webhooks;
+    constructor(options: SinnuOptions);
+}
+
+export { Checkout, type CheckoutUrlOptions, type CreatePaymentLinkBody, DEFAULT_BASE_URL, DEFAULT_CHECKOUT_BASE_URL, type ListPaymentLinksParams, type ListTransactionsParams, type Page, type PageParams, type PaymentLink, type PaymentLinkTransaction, type RawRequestOptions, type RefundTransactionBody, SINNU_SIGNATURE_HEADER, Sinnu, type SinnuApiErrorBody, SinnuAuthError, SinnuError, SinnuNotFoundError, type SinnuOptions, SinnuRateLimitError, type SinnuTransactionWebhookData, SinnuValidationError, type SinnuWebhookCustomer, type SinnuWebhookEvent, type SinnuWebhookEventType, type SinnuWebhookItem, type SinnuWebhookLink, type SinnuWebhookSalesperson, SinnuWebhookSignatureError, type Transaction, type TypedClient, type UpdatePaymentLinkBody, type VerifyWebhookOptions, type Webhooks, collectAll, type components, computeSignature, constructEvent, createTypedClient, Sinnu as default, paginate, type paths, unwrap, verifySignature, webhooks };