@cabrapi/sdk 1.0.0-alpha.0 → 1.0.0-alpha.2

package/dist/index.d.ts

@@ -1,23 +1,43 @@
-import { AxiosInstance as AxiosInstance$1 } from 'axios';
-
 /**
- * Configurações para criação da instância Axios.
+ * Adapter HTTP simples usando fetch (nativo).
+ * Exporta `createAxios` para compatibilidade com restante do código.
  */
 type AxiosConfig = {
-    /**
-     * URL base da API.
-     * @default "https://api.cabrapi.com.br"
-     */
     baseURL?: string;
-    /**
-     * Chave da API (modo privado).
-     */
     apiKey?: string;
+    timeout?: number;
+};
+type AxiosRequestConfig = {
+    url?: string;
+    params?: Record<string, unknown>;
+    headers?: Record<string, string>;
+    data?: unknown;
+    timeout?: number;
+};
+type AxiosResponse<T = unknown> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: Record<string, string>;
+    config?: AxiosRequestConfig;
+};
+declare function createAxios(cfg?: AxiosConfig): {
+    interceptors: {
+        request: {
+            use(fulfilled: (c: AxiosRequestConfig) => AxiosRequestConfig | Promise<AxiosRequestConfig>, rejected?: (e: unknown) => unknown): void;
+        };
+        response: {
+            use(fulfilled: (r: AxiosResponse) => AxiosResponse | Promise<AxiosResponse>, rejected?: (e: unknown) => unknown): void;
+        };
+    };
+    get<T = unknown>(url: string, options?: AxiosRequestConfig): Promise<AxiosResponse<T>>;
+    post<T = unknown>(url: string, data?: unknown, options?: AxiosRequestConfig): Promise<AxiosResponse<T>>;
+    put<T = unknown>(url: string, data?: unknown, options?: AxiosRequestConfig): Promise<AxiosResponse<T>>;
+    delete<T = unknown>(url: string, options?: AxiosRequestConfig): Promise<AxiosResponse<T>>;
+    request<T = unknown>(options: AxiosRequestConfig & {
+        method: string;
+    }): Promise<AxiosResponse<T>>;
 };
-/**
- * Cria uma instância HTTP configurada para a caBRAPI.
- */
-declare function createAxios(config?: AxiosConfig): AxiosInstance$1;
 
 /**
  * Tipo derivado da instância do Axios
@@ -35,6 +55,7 @@ type ClientOptions = {
     type: ClientMode;
     config?: {
         key?: string;
+        baseURL?: string;
     };
 };
 /**
@@ -59,8 +80,181 @@ declare class CoreClient {
     assertPrivate(): void;
 }
 
+type Category = {
+    id: string;
+    name: string;
+    description: string | null;
+    image: string | null;
+    metadata: Record<string, unknown> | null;
+    position: number;
+    storeId: string;
+    createdAt: string;
+    updatedAt: string;
+};
+type CategoryDetails = Category & {
+    products?: unknown[];
+    coupons?: unknown[];
+};
+type Pagination$4 = {
+    page: number;
+    limit: number;
+    total: number;
+    totalPages: number;
+};
+type GetCategoriesInput = {
+    page?: number;
+    limit?: number;
+};
+type CreateCategoryInput = {
+    name?: string;
+    description?: string | null;
+    image?: string | null;
+    metadata?: Record<string, unknown> | null;
+};
+type UpdateCategoryInput = {
+    name?: string;
+    description?: string | null;
+    image?: string | null;
+    metadata?: Record<string, unknown> | null;
+    position?: number;
+};
+type GetCategoriesResponse = {
+    status: boolean;
+    code: string;
+    categories: Category[];
+    pagination: Pagination$4;
+};
+type GetCategoryByIdResponse = {
+    status: boolean;
+    code: string;
+    category: CategoryDetails;
+};
+type CreateCategoryResponse = {
+    status: boolean;
+    code?: string;
+    category: Category;
+};
+type UpdateCategoryResponse = {
+    status: boolean;
+    code: string;
+    category: Category;
+};
+type DeleteCategoryResponse = {
+    status: boolean;
+    code: string;
+};
+type ReorderCategoriesResponse = {
+    status: boolean;
+    code: string;
+};
+declare class Categories {
+    private core;
+    constructor(core: CoreClient);
+    get(storeId: string, input?: GetCategoriesInput): Promise<GetCategoriesResponse>;
+    getById(storeId: string, categoryId: string): Promise<GetCategoryByIdResponse>;
+    post(storeId: string, input: CreateCategoryInput): Promise<CreateCategoryResponse>;
+    put(storeId: string, categoryId: string, input: UpdateCategoryInput): Promise<UpdateCategoryResponse>;
+    delete(storeId: string, categoryId: string): Promise<DeleteCategoryResponse>;
+    reorder(storeId: string, categoryIds: string[]): Promise<ReorderCategoriesResponse>;
+}
+
+type CouponRelationRef = {
+    id: string;
+    name: string;
+};
+type Coupon = {
+    id: string;
+    code: string;
+    position: number;
+    discount: number;
+    useLimit: number;
+    expiredAt: string | null;
+    storeId?: string;
+    products: CouponRelationRef[];
+    categories: CouponRelationRef[];
+    createdAt?: string;
+    updatedAt?: string;
+};
+type Pagination$3 = {
+    page: number;
+    limit: number;
+    total: number;
+    totalPages: number;
+};
+type GetCouponsInput = {
+    page?: number;
+    limit?: number;
+};
+type CreateCouponInput = {
+    code: string;
+    discount: number;
+    useLimit?: number | null;
+    expiredAt?: string | null;
+    productIds?: string[];
+    categoryIds?: string[];
+};
+type UpdateCouponInput = {
+    code?: string;
+    discount?: number;
+    position?: number;
+    useLimit?: number | null;
+    expiredAt?: string | null;
+    productIds?: string[];
+    categoryIds?: string[];
+};
+type GetCouponsResponse = {
+    status: boolean;
+    code: string;
+    coupons: Coupon[];
+    pagination: Pagination$3;
+};
+type GetCouponByCodeResponse = {
+    status: boolean;
+    code: string;
+    coupon: Coupon;
+};
+type GetCouponByIdResponse = {
+    status: boolean;
+    code: string;
+    coupon: Coupon;
+};
+type CreateCouponResponse = {
+    status: boolean;
+    code: string;
+    coupon: Coupon;
+};
+type UpdateCouponResponse = {
+    status: boolean;
+    code: string;
+    coupon: Coupon;
+};
+type DeleteCouponResponse = {
+    status: boolean;
+    code: string;
+};
+type ReorderCouponsResponse = {
+    status: boolean;
+    code: string;
+};
+declare class Coupons {
+    private core;
+    constructor(core: CoreClient);
+    get(storeId: string, input?: GetCouponsInput): Promise<GetCouponsResponse>;
+    getByCode(storeId: string, code: string): Promise<GetCouponByCodeResponse>;
+    getById(storeId: string, couponId: string): Promise<GetCouponByIdResponse>;
+    post(storeId: string, input: CreateCouponInput): Promise<CreateCouponResponse>;
+    put(storeId: string, couponId: string, input: UpdateCouponInput): Promise<UpdateCouponResponse>;
+    delete(storeId: string, couponId: string): Promise<DeleteCouponResponse>;
+    reorder(storeId: string, couponIds: string[]): Promise<ReorderCouponsResponse>;
+}
+
 /**
- * Representa a página retornada pela API
+ * Modelo de página retornado pela API de páginas.
+ *
+ * Observações:
+ * - Campos `createdAt` e `updatedAt` são timestamps em ISO 8601.
+ * - `version` pode ser usada pelo servidor para controle de versão do conteúdo.
+ * - `store` é metadado opcional com informações da loja proprietária.
  */
 type Page = {
     html: string;
@@ -70,26 +264,542 @@ type Page = {
     updatedAt?: string;
     store?: {
         ownerId: string;
+        id: string;
     };
 };
 
+/**
+ * Client de alto nível para operações relacionadas a `Page`.
+ *
+ * Instancie com um `CoreClient` já autenticado/configurado. Os métodos desta
+ * classe são pequenos wrappers que delegam a execução para as funções HTTP
+ * específicas em `./http/*`, mantendo a assinatura orientada ao domínio.
+ */
 declare class Pages {
     private core;
+    /**
+     * Construtor.
+     * @param core - Instância de `CoreClient` usada para efetuar chamadas HTTP.
+     */
     constructor(core: CoreClient);
-    get(domain: string): Promise<Page>;
+    /**
+     * Recupera a página associada ao `domain` informado.
+     *
+     * @param domain - Identificador da página a recuperar (ex.: "exemplo.com").
+     * @returns Uma promise que resolve com o objeto `Page` caso exista.
+     * @throws Erros de rede/HTTP ou erro retornado pela API se a página não existir.
+     *
+     */
+    get(domain: string): Promise<{
+        status: boolean;
+        data: Page;
+    }>;
+    /**
+     * Cria ou atualiza uma página.
+     *
+     * Se a página para o `domain` já existir, o servidor realizará um update;
+     * caso contrário, criará uma nova entrada.
+     *
+     * @param input - Objeto com os dados da página:
+     *   - `domain`: chave única da página.
+     *   - `html`: conteúdo HTML completo.
+     *   - `template` (opcional): nome do template a aplicar.
+     * @returns Uma promise que resolve com o `Page` criado/atualizado ou com metadados retornados pela API.
+     * @throws Erros de validação, rede ou HTTP conforme a resposta da API.
+     *
+     */
     upsert(input: {
         domain: string;
         html: string;
         template?: string;
-    }): Promise<boolean>;
-    delete(domain: string): Promise<boolean>;
+    }): Promise<{
+        status: boolean;
+        code: string;
+    }>;
+    /**
+     * Remove a página associada ao `domain`.
+     *
+     * @param domain - Identificador da página a remover.
+     * @returns Uma promise que resolve quando a exclusão for confirmada pelo servidor.
+     * @throws Erro se a operação falhar (por exemplo, página não encontrada ou erro de permissão).
+     *
+     */
+    delete(domain: string): Promise<{
+        status: boolean;
+        code: string;
+    }>;
+}
+
+type PaymentStatus = "PENDING" | "APPROVED" | "REJECTED" | "CANCELLED" | "REFUNDED" | "CHARGED_BACK" | "EXPIRED";
+type PaymentGateway = "MERCADOPAGO" | "EFI_BANK";
+type PaymentCreateGateway = "MERCADOPAGO_SERVICE_PIX" | "MERCADOPAGO_SERVICE_CARD";
+type PaymentShipmentStatus = "PENDING" | "PREPARING" | "SHIPPED" | "DELIVERED" | "RETURNED" | "CANCELLED";
+type PaymentSortBy = "createdAt" | "updatedAt" | "price" | "name" | "email";
+type PaymentSortOrder = "asc" | "desc";
+type Payment = {
+    id: string;
+    uuid: string;
+    status: PaymentStatus;
+    name?: string;
+    email?: string;
+    cpf?: string | null;
+    price?: number;
+    gateway?: PaymentGateway;
+    shipment?: PaymentShipmentStatus;
+    storeId: string;
+    metadata?: Record<string, unknown> | null;
+};
+type Pagination$2 = {
+    page: number;
+    limit: number;
+    total: number;
+    totalPages: number;
+};
+type FilterPaymentsInput = {
+    id?: string;
+    uuid?: string;
+    status?: PaymentStatus;
+    name?: string;
+    email?: string;
+    cpf?: string;
+    price?: number;
+    minPrice?: number;
+    maxPrice?: number;
+    coupon?: boolean;
+    gateway?: PaymentGateway;
+    shipment?: PaymentShipmentStatus;
+    createdAtFrom?: string;
+    createdAtTo?: string;
+    updatedAtFrom?: string;
+    updatedAtTo?: string;
+    productId?: string;
+    metadataKey?: string;
+    metadataValue?: string;
+    sortBy?: PaymentSortBy;
+    sortOrder?: PaymentSortOrder;
+    page?: number;
+    limit?: number;
+};
+type FilterPaymentsResponse = {
+    status: boolean;
+    code: string;
+    payments: Payment[];
+    pagination: Pagination$2;
+};
+type GetPaymentsInput = {
+    page?: number;
+    limit?: number;
+};
+type GetPaymentsResponse = {
+    status: boolean;
+    code: string;
+    payments: Payment[];
+    pagination: Pagination$2;
+};
+type CreatePaymentItemInput = {
+    productId: string;
+    quantity: number;
+};
+type CreatePaymentInput = {
+    name: string;
+    email: string;
+    cpf?: string;
+    gateway: PaymentCreateGateway;
+    coupon?: string | null;
+    metadata?: Record<string, unknown>;
+    items: CreatePaymentItemInput[];
+};
+type CreatePaymentResponse = {
+    status: boolean;
+    data: {
+        service: {
+            type: string;
+            method: string;
+            payment: string;
+        };
+        payment: {
+            uuid: string;
+            url?: string;
+            qr_code?: {
+                image: string;
+                base_64: string;
+            };
+        };
+    };
+};
+type UpdatePaymentInput = {
+    shipment?: PaymentShipmentStatus;
+    metadata?: Record<string, unknown>;
+};
+type UpdatePaymentResponse = {
+    status: boolean;
+    code: string;
+    payment: {
+        id: string;
+        status: PaymentStatus;
+        shipment?: PaymentShipmentStatus;
+        metadata?: Record<string, unknown> | null;
+    };
+};
+type DeletePaymentResponse = {
+    status: boolean;
+    code: string;
+    message: string;
+};
+declare class Payments {
+    private core;
+    constructor(core: CoreClient);
+    get(storeId: string, input?: GetPaymentsInput): Promise<GetPaymentsResponse>;
+    filter(storeId: string, input?: FilterPaymentsInput): Promise<FilterPaymentsResponse>;
+    post(storeId: string, input: CreatePaymentInput): Promise<CreatePaymentResponse>;
+    put(storeId: string, paymentId: string, input: UpdatePaymentInput): Promise<UpdatePaymentResponse>;
+    delete(storeId: string, paymentId: string): Promise<DeletePaymentResponse>;
+}
+
+type ProductDelivery = "DIGITAL" | "PHYSICAL";
+type ProductCategoryRef = {
+    id: string;
+    name: string;
+};
+type Product = {
+    id: string;
+    name: string;
+    disabled: boolean;
+    position: number;
+    description: string | null;
+    price: number;
+    image: string | null;
+    delivery: ProductDelivery;
+    stock: number;
+    sold: number;
+    storeId: string;
+    metadata: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+    categories?: ProductCategoryRef[];
+};
+type Pagination$1 = {
+    page: number;
+    limit: number;
+    total: number;
+    totalPages: number;
+};
+type GetProductsInput = {
+    page?: number;
+    limit?: number;
+};
+type CreateProductInput = {
+    name: string;
+    image?: string | null;
+    description?: string | null;
+    categoryIds?: string[];
+    delivery: ProductDelivery;
+    price: number;
+    stock?: number;
+    disabled?: boolean;
+    metadata?: Record<string, unknown> | null;
+};
+type UpdateProductInput = {
+    name?: string;
+    image?: string | null;
+    description?: string | null;
+    categoryIds?: string[];
+    delivery?: ProductDelivery;
+    price?: number;
+    stock?: number;
+    disabled?: boolean;
+    position?: number;
+    metadata?: Record<string, unknown> | null;
+};
+type GetProductsResponse = {
+    status: boolean;
+    code: string;
+    products: Product[];
+    pagination: Pagination$1;
+};
+type GetProductByIdResponse = {
+    status: boolean;
+    code: string;
+    product: Product;
+};
+type CreateProductResponse = {
+    status: boolean;
+    code: string;
+    product: Product;
+};
+type UpdateProductResponse = {
+    status: boolean;
+    code: string;
+    product: Product;
+};
+type DeleteProductResponse = {
+    status: boolean;
+    code: string;
+};
+type ReorderProductsResponse = {
+    status: boolean;
+    code: string;
+};
+declare class Products {
+    private core;
+    constructor(core: CoreClient);
+    get(storeId: string, input?: GetProductsInput): Promise<GetProductsResponse>;
+    getById(storeId: string, productId: string): Promise<GetProductByIdResponse>;
+    post(storeId: string, input: CreateProductInput): Promise<CreateProductResponse>;
+    put(storeId: string, productId: string, input: UpdateProductInput): Promise<UpdateProductResponse>;
+    delete(storeId: string, productId: string): Promise<DeleteProductResponse>;
+    reorder(storeId: string, productIds: string[]): Promise<ReorderProductsResponse>;
+}
+
+/**
+ * Templates válidos para loja.
+ */
+type StoreTemplate = "PERSONALIZADO" | "N/A";
+/**
+ * Tipo do domínio informado no payload da loja.
+ */
+type StoreDomainType = "CUSTOM" | "DEFAULT";
+/**
+ * Estrutura de domínio para criação/atualização.
+ */
+type StoreDomainInput = {
+    type: StoreDomainType;
+    value: string;
+};
+/**
+ * Modelo base de loja retornado nos endpoints de listagem e upsert.
+ */
+type Store = {
+    id: string;
+    name: string;
+    position: number;
+    description: string | null;
+    image: string | null;
+    domain: string;
+    template: StoreTemplate;
+    metadata: Record<string, unknown> | null;
+    createdAt: string;
+    updatedAt: string;
+};
+/**
+ * Modelo detalhado retornado por `GET /stores/:storeId`.
+ */
+type StoreDetails = Store & {
+    ownerId?: string;
+    deletedAt?: string | null;
+    categories?: unknown[];
+    products?: unknown[];
+    coupons?: unknown[];
+    payment?: unknown[];
+};
+/**
+ * Metadados de paginação padrão da API.
+ */
+type Pagination = {
+    page: number;
+    limit: number;
+    total: number;
+    totalPages: number;
+};
+/**
+ * Query params de listagem de lojas.
+ */
+type GetStoresInput = {
+    page?: number;
+    limit?: number;
+};
+/**
+ * Payload para criação de loja (`POST /stores`).
+ */
+type CreateStoreInput = {
+    template: StoreTemplate;
+    name?: string;
+    description?: string | null;
+    image?: string | null;
+    metadata?: Record<string, unknown> | null;
+    domain?: StoreDomainInput | null;
+    position?: number;
+};
+/**
+ * Payload para atualização de loja (`PUT /stores/:storeId`).
+ *
+ * Observação: no endpoint de update, todos os campos são opcionais,
+ * mas a API exige ao menos 1 campo no body.
+ */
+type UpdateStoreInput = {
+    template?: StoreTemplate;
+    name?: string;
+    description?: string | null;
+    image?: string | null;
+    metadata?: Record<string, unknown> | null;
+    domain?: StoreDomainInput | null;
+    position?: number;
+};
+/**
+ * Resposta de listagem de lojas.
+ */
+type GetStoresResponse = {
+    status: boolean;
+    code: string;
+    stores: Store[];
+    pagination: Pagination;
+};
+/**
+ * Resposta de consulta por ID.
+ */
+type GetStoreByIdResponse = {
+    status: boolean;
+    code: string;
+    store: StoreDetails;
+};
+/**
+ * Resposta de criação.
+ */
+type CreateStoreResponse = {
+    status: boolean;
+    code: string;
+    store: Store;
+};
+/**
+ * Resposta de atualização.
+ */
+type UpdateStoreResponse = {
+    status: boolean;
+    code: string;
+    store: Store;
+};
+/**
+ * Resposta de exclusão.
+ */
+type DeleteStoreResponse = {
+    status: boolean;
+    code: string;
+};
+/**
+ * Resposta de reordenação.
+ */
+type ReorderStoresResponse = {
+    status: boolean;
+    code: string;
+};
+/**
+ * Cliente de alto nível para operações do módulo de lojas.
+ */
+declare class Stores {
+    private core;
+    /**
+     * @param core Cliente base da SDK.
+     */
+    constructor(core: CoreClient);
+    /**
+     * Lista lojas da conta com suporte a paginação.
+     */
+    get(input?: GetStoresInput): Promise<GetStoresResponse>;
+    /**
+     * Busca uma loja pelo ID.
+     */
+    getById(storeId: string): Promise<GetStoreByIdResponse>;
+    /**
+     * Cria uma nova loja.
+     */
+    post(input: CreateStoreInput): Promise<CreateStoreResponse>;
+    /**
+     * Atualiza uma loja existente.
+     */
+    put(storeId: string, input: UpdateStoreInput): Promise<UpdateStoreResponse>;
+    /**
+     * Exclui uma loja pelo ID.
+     */
+    delete(storeId: string): Promise<DeleteStoreResponse>;
+    /**
+     * Reordena lojas pelo array final de IDs.
+     */
+    reorder(storeIds: string[]): Promise<ReorderStoresResponse>;
+}
+
+/**
+ * Resposta de listagem de webhooks por loja.
+ */
+type GetWebhooksResponse = {
+    webhooks: string[];
+    max: number;
+};
+/**
+ * Payload para criar webhook em uma loja.
+ */
+type CreateWebhookInput = {
+    url: string;
+};
+/**
+ * Resposta de criação de webhook.
+ */
+type CreateWebhookResponse = {
+    status: boolean;
+    code: string;
+    webhook: string;
+};
+/**
+ * Payload para remover webhook de uma loja.
+ */
+type DeleteWebhookInput = {
+    url: string;
+};
+/**
+ * Resposta de remoção de webhook.
+ */
+type DeleteWebhookResponse = {
+    status: boolean;
+    code: string;
+};
+/**
+ * Cliente de alto nível para operações de webhooks da loja.
+ */
+declare class Webhooks {
+    private core;
+    /**
+     * @param core Cliente base da SDK.
+     */
+    constructor(core: CoreClient);
+    /**
+     * Lista os webhooks cadastrados para uma loja.
+     */
+    get(storeId: string): Promise<GetWebhooksResponse>;
+    /**
+     * Adiciona um webhook em uma loja.
+     */
+    post(storeId: string, input: CreateWebhookInput): Promise<CreateWebhookResponse>;
+    /**
+     * Remove um webhook de uma loja.
+     */
+    delete(storeId: string, input: DeleteWebhookInput): Promise<DeleteWebhookResponse>;
+    /**
+     * Descriptografa e valida o payload recebido no webhook de assinatura.
+     *
+     * Espera um payload no formato `iv:encrypted` (ambos em base64), criptografado
+     * com AES-256-CBC usando a chave informada.
+     */
+    decrypty(secret: string, payload: string): Promise<Record<string, unknown>>;
+    /**
+     * Alias com nome corrigido para descriptografar payload de webhook.
+     */
+    decrypt(secret: string, payload: string): Promise<Record<string, unknown>>;
+    /**
+     * Alias retrocompatível para quem já usa `parseSubscriptionPayload`.
+     */
+    parseSubscriptionPayload(payload: string, secret: string): Promise<Record<string, unknown>>;
 }
 
 /**
  * SDK principal da caBRAPI
  */
 declare class caBRAPI {
+    categories: Categories;
+    coupons: Coupons;
+    payments: Payments;
     pages: Pages;
+    products: Products;
+    stores: Stores;
+    webhooks: Webhooks;
     constructor(options: ClientOptions);
 }