@garuhq/node 2.0.0 → 4.0.0

package/dist/index.js

@@ -936,9 +936,13 @@ var ScheduledCharges = class {
   }
   http;
   /**
-   * Create a new scheduled charge. Auto-attaches `X-Idempotency-Key`
-   * (UUIDv4 if you don't pass `idempotencyKey`) so retries on transient
-   * network failures don't silently double-create.
+   * Create a new scheduled charge. The SDK attaches an `X-Idempotency-Key`
+   * header (UUIDv4 unless you pass `idempotencyKey`), but the gateway does
+   * not currently deduplicate `/scheduled-charges` creates against it — a
+   * retry after a network failure can create more than one series. Pair
+   * this with your own retry-suppression (e.g. check `list` for an existing
+   * series with the same `externalReference`) if that matters for your
+   * integration.
    *
    * @example
    * const charge = await garu.scheduledCharges.create({
@@ -968,7 +972,7 @@ var ScheduledCharges = class {
     const idempotencyKey = params.idempotencyKey ?? generateIdempotencyKey();
     const { idempotencyKey: _omit, ...body } = params;
     return this.http.call(
-      (signal) => this.http.client.POST("/api/scheduled-charges", {
+      (signal) => this.http.client.POST("/api/v1/scheduled-charges", {
         body,
         headers: { "X-Idempotency-Key": idempotencyKey },
         signal
@@ -1003,7 +1007,7 @@ var ScheduledCharges = class {
       for (const s of statuses) qs.append("status", s);
     }
     const query = qs.toString();
-    const url = `/api/scheduled-charges${query ? `?${query}` : ""}`;
+    const url = `/api/v1/scheduled-charges${query ? `?${query}` : ""}`;
     return this.http.call(
       (signal) => this.http.client.GET(url, { signal }).then(
         (r) => r
@@ -1020,7 +1024,7 @@ var ScheduledCharges = class {
    */
   async get(id) {
     return this.http.call(
-      (signal) => this.http.client.GET(`/api/scheduled-charges/${encodeURIComponent(id)}`, {
+      (signal) => this.http.client.GET(`/api/v1/scheduled-charges/${encodeURIComponent(id)}`, {
         signal
       }).then((r) => r)
     );
@@ -1039,7 +1043,7 @@ var ScheduledCharges = class {
   async postpone(id, params) {
     return this.http.call(
       (signal) => this.http.client.POST(
-        `/api/scheduled-charges/${encodeURIComponent(id)}/postpone`,
+        `/api/v1/scheduled-charges/${encodeURIComponent(id)}/postpone`,
         {
           body: params,
           signal
@@ -1058,7 +1062,7 @@ var ScheduledCharges = class {
   async pause(id, params = {}) {
     return this.http.call(
       (signal) => this.http.client.POST(
-        `/api/scheduled-charges/${encodeURIComponent(id)}/pause`,
+        `/api/v1/scheduled-charges/${encodeURIComponent(id)}/pause`,
         {
           body: params,
           signal
@@ -1075,7 +1079,7 @@ var ScheduledCharges = class {
   async resume(id) {
     return this.http.call(
       (signal) => this.http.client.POST(
-        `/api/scheduled-charges/${encodeURIComponent(id)}/resume`,
+        `/api/v1/scheduled-charges/${encodeURIComponent(id)}/resume`,
         {
           body: {},
           signal
@@ -1109,7 +1113,7 @@ var ScheduledCharges = class {
   async markPaid(id, params) {
     return this.http.call(
       (signal) => this.http.client.POST(
-        `/api/scheduled-charges/${encodeURIComponent(id)}/mark-paid`,
+        `/api/v1/scheduled-charges/${encodeURIComponent(id)}/mark-paid`,
         {
           body: params,
           signal
@@ -1131,24 +1135,22 @@ var ScheduledCharges = class {
    * const result = await garu.scheduledCharges.chargeNow('sch_abc123');
    * switch (result.outcome) {
    *   case 'dispatched':
-   *     console.log(`Cobrança enviada (ciclo ${result.cycleNumber}).`);
+   *     result.cycleNumber; // billed this cycle
    *     break;
    *   case 'already_sent':
-   *     console.log('Já havia sido enviada — nada a fazer.');
-   *     break;
+   *     break; // nothing to do
    *   case 'failed':
-   *     // result.reason is e.g. 'card_expired' or a gateway decline code
-   *     console.error(`Falha na cobrança: ${result.reason}. ${result.message}`);
+   *     result.reason; // e.g. 'card_expired' or a gateway decline code
    *     break;
    *   case 'not_sent':
-   *     console.warn(`Não enviada (${result.reason}): ${result.message}`);
+   *     result.reason;
    *     break;
    * }
    */
   async chargeNow(id) {
     return this.http.call(
       (signal) => this.http.client.POST(
-        `/api/scheduled-charges/${encodeURIComponent(id)}/charge-now`,
+        `/api/v1/scheduled-charges/${encodeURIComponent(id)}/charge-now`,
         {
           body: {},
           signal
@@ -1170,7 +1172,7 @@ var ScheduledCharges = class {
   async cancelRecurrence(id, params = {}) {
     return this.http.call(
       (signal) => this.http.client.POST(
-        `/api/scheduled-charges/${encodeURIComponent(id)}/cancel-recurrence`,
+        `/api/v1/scheduled-charges/${encodeURIComponent(id)}/cancel-recurrence`,
         {
           body: params,
           signal
@@ -1190,7 +1192,7 @@ var ScheduledCharges = class {
   async setCancelAtPeriodEnd(id, params) {
     return this.http.call(
       (signal) => this.http.client.POST(
-        `/api/scheduled-charges/${encodeURIComponent(id)}/cancel-at-period-end`,
+        `/api/v1/scheduled-charges/${encodeURIComponent(id)}/cancel-at-period-end`,
         {
           body: params,
           signal
@@ -1209,7 +1211,7 @@ var ScheduledCharges = class {
   async changePaymentMethod(id, params) {
     return this.http.call(
       (signal) => this.http.client.POST(
-        `/api/scheduled-charges/${encodeURIComponent(id)}/payment-method`,
+        `/api/v1/scheduled-charges/${encodeURIComponent(id)}/payment-method`,
         {
           body: params,
           signal
@@ -1228,7 +1230,7 @@ var ScheduledCharges = class {
   async clearPaymentMethod(id) {
     return this.http.call(
       (signal) => this.http.client.DELETE(
-        `/api/scheduled-charges/${encodeURIComponent(id)}/payment-method`,
+        `/api/v1/scheduled-charges/${encodeURIComponent(id)}/payment-method`,
         {
           body: {},
           signal
@@ -1255,7 +1257,7 @@ var ScheduledCharges = class {
     if (params.limit !== void 0) qs.set("limit", String(params.limit));
     if (params.cycleNumber !== void 0) qs.set("cycleNumber", String(params.cycleNumber));
     const query = qs.toString();
-    const url = `/api/scheduled-charges/${encodeURIComponent(id)}/attempts${query ? `?${query}` : ""}`;
+    const url = `/api/v1/scheduled-charges/${encodeURIComponent(id)}/attempts${query ? `?${query}` : ""}`;
     return this.http.call(
       (signal) => this.http.client.GET(url, { signal }).then(
         (r) => r
@@ -1287,42 +1289,31 @@ var WebhookEvents = class {
    * });
    */
   async list(params = {}) {
-    const qs = new URLSearchParams();
-    if (params.page !== void 0) qs.set("page", String(params.page));
-    if (params.limit !== void 0) qs.set("limit", String(params.limit));
-    if (params.status) qs.set("status", params.status);
-    if (params.eventType) qs.set("event_type", params.eventType);
-    if (params.endpointId !== void 0) qs.set("endpoint_id", String(params.endpointId));
-    const query = qs.toString();
-    const url = `/api/webhook-events${query ? `?${query}` : ""}`;
-    const raw = await this.http.call(
+    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.eventType) query.eventType = params.eventType;
+    if (params.endpointId !== void 0) query.endpointId = String(params.endpointId);
+    const qs = new URLSearchParams(query).toString();
+    const url = `/api/v1/webhook-events${qs ? `?${qs}` : ""}`;
+    return this.http.call(
       (signal) => this.http.client.GET(url, { signal }).then(
         (r) => r
       )
     );
-    return {
-      data: raw.events,
-      meta: {
-        page: raw.page,
-        limit: raw.limit,
-        total: raw.total,
-        totalPages: raw.pages
-      }
-    };
   }
   /**
-   * Fetch one webhook event by numeric ID — includes the full payload, the
+   * Fetch one webhook event by uuid — includes the full payload, the
    * embedded endpoint snapshot, and the most recent response status/body.
    *
    * @example
-   * const event = await garu.webhookEvents.get(42);
-   * if (event.status === 'failed') {
-   *   console.log(event.responseStatus, event.responseBody);
-   * }
+   * const event = await garu.webhookEvents.get('a1b2c3d4-e5f6-7890-abcd-ef1234567890');
+   * event.status === 'failed' && event.responseStatus;
    */
-  async get(id) {
+  async get(uuid) {
     return this.http.call(
-      (signal) => this.http.client.GET(`/api/webhook-events/${id}`, { signal }).then(
+      (signal) => this.http.client.GET(`/api/v1/webhook-events/${uuid}`, { signal }).then(
         (r) => r
       )
     );
@@ -1335,28 +1326,28 @@ var WebhookEvents = class {
    * explicitly want the legacy in-place semantics (and for backwards
    * compatibility with older CLI / MCP releases).
    *
-   * Re-deliver a webhook event by ID. Resets it to `pending`, clears the
+   * Re-deliver a webhook event by uuid. Resets it to `pending`, clears the
    * retry schedule, and triggers an immediate delivery attempt. Works on
    * any status (`success`, `failed`, `pending`).
    *
    * @example
    * const failed = await garu.webhookEvents.list({ status: 'failed', limit: 5 });
    * for (const event of failed.data) {
-   *   await garu.webhookEvents.retry(event.id);
+   *   await garu.webhookEvents.retry(event.uuid);
    * }
    */
-  async retry(id) {
+  async retry(uuid) {
     return this.http.call(
-      (signal) => this.http.client.POST(`/api/webhook-events/${id}/retry`, {
+      (signal) => this.http.client.POST(`/api/v1/webhook-events/${uuid}/retry`, {
         body: {},
         signal
       }).then((r) => r)
     );
   }
   /**
-   * Re-deliver a webhook event by ID, audit-trail preserving. Unlike
+   * Re-deliver a webhook event by uuid, audit-trail preserving. Unlike
    * {@link retry}, this does *not* mutate the original row — it inserts a
-   * fresh event (new numeric id) that points back at the source via
+   * fresh event (new uuid) that points back at the source via
    * `manualResendOf`, then dispatches that clone. The original row is
    * untouched, so the historical record of the prior failure (and its
    * response status / body) is preserved.
@@ -1367,30 +1358,30 @@ var WebhookEvents = class {
    * delivery's outcome to remain on the record.
    *
    * **Outbound delivery semantics**: the gateway POSTs the clone with
-   * `Idempotency-Key: resend_<originalId>` (where `<originalId>` is the id
-   * of the source event, not the clone). Recipient handlers that key off
+   * `Idempotency-Key: resend_<cloneUuid>`. Recipient handlers that key off
    * `Idempotency-Key` will see this as a distinct delivery from the
    * original — distinguishable both by the `resend_` prefix and by reading
    * the response payload's `manualResendOf` field.
    *
-   * **SDK→gateway dedup**: the SDK auto-attaches `X-Idempotency-Key`
-   * (UUIDv4 unless you pass `idempotencyKey`) so transient transport
-   * retries (5xx → SDK backoff) cannot create duplicate clones — the
-   * backend returns the original clone on the second call within 24h.
+   * The SDK also attaches an `X-Idempotency-Key` header (UUIDv4 unless you
+   * pass `idempotencyKey`); the gateway does not currently deduplicate
+   * `/resend` calls against it, so retrying this call from your own code
+   * after a network failure can create more than one clone — pair it with
+   * your own retry-suppression if that matters for your integration.
    *
-   * Returns the *clone* event (new id), not the original. The original is
+   * Returns the *clone* event (new uuid), not the original. The original is
    * unchanged on the server.
    *
    * @example
-   * const event = await garu.webhookEvents.get(42);
-   * const clone = await garu.webhookEvents.resend(42);
-   * clone.id !== event.id;            // true — clone has its own id
-   * clone.manualResendOf === event.id; // true — points back at the source
+   * const event = await garu.webhookEvents.get('a1b2c3d4-e5f6-7890-abcd-ef1234567890');
+   * const clone = await garu.webhookEvents.resend(event.uuid);
+   * clone.uuid !== event.uuid;            // true — clone has its own uuid
+   * clone.manualResendOf === event.uuid; // true — points back at the source
    */
-  async resend(id, params = {}) {
+  async resend(uuid, params = {}) {
     const idempotencyKey = params.idempotencyKey ?? generateIdempotencyKey();
     return this.http.call(
-      (signal) => this.http.client.POST(`/api/webhook-events/${id}/resend`, {
+      (signal) => this.http.client.POST(`/api/v1/webhook-events/${uuid}/resend`, {
         body: {},
         headers: { "X-Idempotency-Key": idempotencyKey },
         signal

package/package.json

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