@garuhq/node 0.15.0 → 1.0.0

package/dist/index.js

@@ -186,11 +186,6 @@ function generateIdempotencyKey() {
   return randomUUID();
 }
 
-// src/types.ts
-function toWirePaymentMethod(pm) {
-  return pm === "credit_card" ? "creditcard" : pm;
-}
-
 // src/resources/charges.ts
 var Charges = class {
   constructor(http) {
@@ -198,16 +193,16 @@ var Charges = class {
   }
   http;
   /**
-   * Create a charge (PIX, credit card, or boleto).
+   * Create a charge (PIX, boleto, or credit card).
    *
-   * Automatically attaches an `X-Idempotency-Key` header — if you don't pass
-   * `idempotencyKey`, the SDK generates a UUIDv4. Safe to retry: the backend
-   * caches the first response for 24h.
+   * Attaches an `X-Idempotency-Key` header automatically — if you don't pass
+   * `idempotencyKey`, the SDK generates a UUIDv4. Safe to retry: the same key
+   * returns the original charge for 24h.
    *
    * @example
-   * // PIX charge
+   * // PIX — render charge.pix.code as a QR in your own checkout
    * const charge = await garu.charges.create({
-   *   productId: 'b3f2c1e8-6e4a-4b9f-9d1c-2a1f6c3d4e5f',
+   *   productId: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
    *   paymentMethod: 'pix',
    *   customer: {
    *     name: 'Maria Silva',
@@ -216,111 +211,109 @@ var Charges = class {
    *     phone: '11987654321'
    *   }
    * });
-   * // charge.id, charge.status
+   * console.log(charge.uuid, charge.pix?.code);
    *
    * @example
-   * // Credit card charge, 3 installments
+   * // Credit card, 2 installments. Server-to-server only (PCI scope).
    * const charge = await garu.charges.create({
-   *   productId: 'b3f2c1e8-6e4a-4b9f-9d1c-2a1f6c3d4e5f',
-   *   paymentMethod: 'credit_card',
+   *   productId: 'a1b2c3d4-e5f6-7890-abcd-ef1234567890',
+   *   paymentMethod: 'creditCard',
    *   customer: { name: 'Maria Silva', email: 'maria@exemplo.com.br', document: '12345678909', phone: '11987654321' },
-   *   cardInfo: {
-   *     cardNumber: '4111111111111111',
-   *     cvv: '123',
-   *     expirationDate: '2030-12',
+   *   card: {
+   *     number: '4111111111111111',
    *     holderName: 'MARIA SILVA',
-   *     installments: 3
+   *     expirationDate: '2030-12',
+   *     cvv: '123',
+   *     installments: 2
    *   }
    * });
+   * // charge.amount is the base price; charge.chargedTotal is what was charged.
    */
   async create(params) {
     const idempotencyKey = params.idempotencyKey ?? generateIdempotencyKey();
-    const body = this.buildCreateBody(params);
-    return this.http.call(
-      (signal) => this.http.client.POST("/api/transactions", {
-        body,
-        headers: { "X-Idempotency-Key": idempotencyKey },
-        signal
-      })
-    );
+    const body = {
+      productId: params.productId,
+      paymentMethod: params.paymentMethod,
+      customer: params.customer
+    };
+    if (params.card) body.card = params.card;
+    if (params.checkoutSessionToken) body.checkoutSessionToken = params.checkoutSessionToken;
+    if (params.additionalInfo !== void 0) body.additionalInfo = params.additionalInfo;
+    return this.post("/api/v1/charges", body, { "X-Idempotency-Key": idempotencyKey });
   }
   /**
-   * List charges for the authenticated seller, with pagination and filters.
+   * Retrieve a charge by uuid.
    *
    * @example
-   * const { data, meta } = await garu.charges.list({ status: 'paid', limit: 10 });
-   * // meta.total paid charges
+   * const charge = await garu.charges.retrieve('6f1c9b2e-4a7d-4f0b-9a3e-1d2c3b4a5e6f');
+   * if (charge.status === 'paid') fulfil(charge);
+   */
+  async retrieve(uuid) {
+    return this.get(`/api/v1/charges/${encodeURIComponent(uuid)}`);
+  }
+  /**
+   * List charges for the authenticated account, newest first by default.
+   *
+   * @example
+   * const { data, totalCount } = await garu.charges.list({ status: 'paid', limit: 50 });
+   * console.log(`${data.length} of ${totalCount} paid charges`);
    */
   async list(params = {}) {
     const query = {};
     if (params.page !== void 0) query.page = String(params.page);
     if (params.limit !== void 0) query.limit = String(params.limit);
     if (params.status) query.status = params.status;
-    if (params.search) query.search = params.search;
     if (params.paymentMethod) query.paymentMethod = params.paymentMethod;
+    if (params.productId) query.productId = params.productId;
+    if (params.createdAfter) query.createdAfter = params.createdAfter;
+    if (params.createdBefore) query.createdBefore = params.createdBefore;
+    if (params.search) query.search = params.search;
+    if (params.sort) query.sort = params.sort;
     const qs = new URLSearchParams(query).toString();
-    const url = `/api/transactions${qs ? `?${qs}` : ""}`;
-    return this.http.call(
-      (signal) => this.http.client.GET(url, { signal }).then(
-        (r) => r
-      )
-    );
+    return this.get(`/api/v1/charges${qs ? `?${qs}` : ""}`);
   }
   /**
-   * Fetch a single charge by numeric ID.
+   * Refund a charge, fully or partially. `amount` is in reais.
+   *
+   * For a Pix Automático charge the refund is a devolução: it returns with the
+   * charge in `refund_pending`, reaching `refunded` only once the transfer
+   * settles.
    *
    * @example
-   * const charge = await garu.charges.get(4472);
-   * if (charge.status === 'paid') { ... }
+   * await garu.charges.refund('6f1c9b2e-...');                       // full
+   * await garu.charges.refund('6f1c9b2e-...', { amount: 10.0 });     // R$10,00
    */
-  async get(id) {
-    return this.http.call(
-      (signal) => this.http.client.GET("/api/transactions/{id}", {
-        params: { path: { id } },
-        signal
-      })
-    );
+  async refund(uuid, params = {}) {
+    const body = {};
+    if (params.amount !== void 0) body.amount = params.amount;
+    if (params.reason !== void 0) body.reason = params.reason;
+    return this.post(`/api/v1/charges/${encodeURIComponent(uuid)}/refund`, body);
   }
   /**
-   * Refund a charge — fully, or partially by passing `amount` in centavos.
+   * Cancel an unpaid charge.
    *
    * @example
-   * // Full refund
-   * await garu.charges.refund(4472);
-   *
-   * @example
-   * // Partial refund of R$ 10,00
-   * await garu.charges.refund(4472, { amount: 1000, reason: 'customer_request' });
+   * const { canceled } = await garu.charges.cancel('6f1c9b2e-...');
    */
-  async refund(id, params = {}) {
-    const idempotencyKey = params.idempotencyKey ?? generateIdempotencyKey();
-    const body = {};
-    if (params.amount !== void 0) body.amount = params.amount;
-    if (params.reason !== void 0) body.reason = params.reason;
+  async cancel(uuid) {
     return this.http.call(
-      (signal) => this.http.client.POST("/api/transactions/{id}/refund", {
-        params: { path: { id } },
-        body,
-        headers: { "X-Idempotency-Key": idempotencyKey },
-        signal
-      })
+      (signal) => this.http.client.DELETE(
+        `/api/v1/charges/${encodeURIComponent(uuid)}`,
+        { signal }
+      )
     );
   }
-  buildCreateBody(params) {
-    const body = {
-      customer: params.customer,
-      productId: params.productId,
-      paymentMethodId: toWirePaymentMethod(params.paymentMethod),
-      link: params.link ?? null,
-      affiliateId: params.affiliateId ?? null
-    };
-    if (params.additionalInfo !== void 0) body.additionalInfo = params.additionalInfo;
-    if (params.priceId !== void 0) body.priceId = params.priceId;
-    if (params.checkoutSessionToken !== void 0) {
-      body.checkoutSessionToken = params.checkoutSessionToken;
-    }
-    if (params.cardInfo) body.CardInfo = params.cardInfo;
-    return body;
+  // v1 charge routes are not in the generated OpenAPI schema (it is regenerated
+  // from a live deploy), so these use the client's untyped path.
+  get(url) {
+    return this.http.call(
+      (signal) => this.http.client.GET(url, { signal })
+    );
+  }
+  post(url, body, headers) {
+    return this.http.call(
+      (signal) => this.http.client.POST(url, { body, headers, signal })
+    );
   }
 };
 
@@ -475,7 +468,7 @@ var ProductPortalConfigResource = class {
   async get(productId) {
     return this.http.call(
       (signal) => this.http.client.GET(
-        `/api/products/${encodeURIComponent(String(productId))}/portal-config`,
+        `/api/v1/products/${encodeURIComponent(String(productId))}/portal-config`,
         {
           signal
         }
@@ -498,7 +491,7 @@ var ProductPortalConfigResource = class {
   async set(productId, params) {
     return this.http.call(
       (signal) => this.http.client.POST(
-        `/api/products/${encodeURIComponent(String(productId))}/portal-config`,
+        `/api/v1/products/${encodeURIComponent(String(productId))}/portal-config`,
         {
           body: params,
           signal
@@ -510,7 +503,7 @@ var ProductPortalConfigResource = class {
   async patch(productId, params) {
     return this.http.call(
       (signal) => this.http.client.PATCH(
-        `/api/products/${encodeURIComponent(String(productId))}/portal-config`,
+        `/api/v1/products/${encodeURIComponent(String(productId))}/portal-config`,
         {
           body: params,
           signal
@@ -529,7 +522,7 @@ var ProductPortalConfigResource = class {
   async clear(productId) {
     return this.http.call(
       (signal) => this.http.client.DELETE(
-        `/api/products/${encodeURIComponent(String(productId))}/portal-config`,
+        `/api/v1/products/${encodeURIComponent(String(productId))}/portal-config`,
         {
           body: {},
           signal
@@ -550,16 +543,15 @@ var Products = class {
    * List products for the authenticated seller, with pagination and search.
    *
    * @example
-   * const { data, meta } = await garu.products.list({ search: 'curso', limit: 10 });
+   * const { data, totalCount } = await garu.products.list({ search: 'curso', limit: 10 });
    */
   async list(params = {}) {
     const query = {};
     if (params.page !== void 0) query.page = String(params.page);
     if (params.limit !== void 0) query.limit = String(params.limit);
     if (params.search) query.search = params.search;
-    if (params.tab) query.tab = params.tab;
     const qs = new URLSearchParams(query).toString();
-    const url = `/api/products/seller${qs ? `?${qs}` : ""}`;
+    const url = `/api/v1/products${qs ? `?${qs}` : ""}`;
     return this.http.call(
       (signal) => this.http.client.GET(url, { signal }).then(
         (r) => r
@@ -575,7 +567,7 @@ var Products = class {
    */
   async get(uuid) {
     return this.http.call(
-      (signal) => this.http.client.GET(`/api/products/uuid/${uuid}`, { signal }).then(
+      (signal) => this.http.client.GET(`/api/v1/products/${uuid}`, { signal }).then(
         (r) => r
       )
     );
@@ -593,7 +585,7 @@ var Products = class {
    * @example
    * const product = await garu.products.create({
    *   name: 'Plano Mensal',
-   *   value: 4990, // R$ 49,90 in centavos
+   *   value: 49.90, // R$ 49,90 in reais (decimal BRL), NOT centavos
    *   description: 'Acesso completo à plataforma',
    *   pix: true,
    *   creditCard: true,
@@ -606,7 +598,7 @@ var Products = class {
     const { idempotencyKey, ...body } = params;
     const key = idempotencyKey ?? generateIdempotencyKey();
     return this.http.call(
-      (signal) => this.http.client.POST("/api/products", {
+      (signal) => this.http.client.POST("/api/v1/products", {
         body,
         headers: { "X-Idempotency-Key": key },
         signal
@@ -617,19 +609,19 @@ var Products = class {
    * Update a product (partial PATCH — only the fields you pass are changed).
    * Returns the updated product.
    *
-   * `id` accepts the numeric id or the product UUID — the same identifiers
-   * accepted elsewhere on the `/api/products/:id` path (see
+   * `id` accepts the product UUID (recommended) or the legacy numeric id —
+   * both resolve on the `/api/v1/products/:id` path (see
    * {@link ProductPortalConfigResource}).
    *
    * @example
    * const updated = await garu.products.update('b3f2c1e8-6e4a-4b9f-9d1c-2a1f6c3d4e5f', {
-   *   value: 5990,
+   *   value: 59.90, // reais (decimal BRL), NOT centavos
    *   pixAutomatic: true // turn on Pix Automático for this product
    * });
    */
   async update(id, params) {
     return this.http.call(
-      (signal) => this.http.client.PATCH(`/api/products/${encodeURIComponent(String(id))}`, {
+      (signal) => this.http.client.PATCH(`/api/v1/products/${encodeURIComponent(String(id))}`, {
         body: params,
         signal
       }).then((r) => r)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@garuhq/node",
-  "version": "0.15.0",
+  "version": "1.0.0",
   "description": "Official Node.js / TypeScript SDK for the Garu payment gateway.",
   "license": "MIT",
   "homepage": "https://garu.com.br",