@garuhq/node 0.8.0 → 0.10.0

package/README.md

@@ -167,7 +167,9 @@ const { data, meta } = await garu.customers.list({ search: 'maria', limit: 10 })
 
 ## Products
 
-Discover products and customize the per-product portal experience (B2B2C, v0.8.0).
+Discover products and customize the per-product portal experience (B2B2C).
+
+`portalConfig.*` methods accept `productId` as either the product UUID (preferred — same identifier returned by `list()` and webhook payloads) or the legacy numeric id (Garu v0.10.0+).
 
 | Method                              | Description                                                       |
 | ----------------------------------- | ----------------------------------------------------------------- |
@@ -180,14 +182,16 @@ Discover products and customize the per-product portal experience (B2B2C, v0.8.0
 
 ```ts
 // SaaS de coaching: per-coach branding under one Seller account
-await garu.products.portalConfig.set(57, {
+await garu.products.portalConfig.set('b3f2c1e8-6e4a-4b9f-9d1c-2a1f6c3d4e5f', {
   businessName: 'Coach Maria — Corrida & Trilha',
   primaryColor: '#257264',
   logoUrl: 'https://cdn.exemplo.com/coaches/maria.png',
 });
 
 // Pass `null` on a field to inherit from the seller-level config
-await garu.products.portalConfig.patch(57, { primaryColor: null });
+await garu.products.portalConfig.patch('b3f2c1e8-6e4a-4b9f-9d1c-2a1f6c3d4e5f', {
+  primaryColor: null,
+});
 ```
 
 ## Scheduled charges

package/dist/index.cjs

@@ -475,11 +475,11 @@ var ProductPortalConfigResource = class {
    * portal config).
    *
    * @example
-   * const cfg = await garu.products.portalConfig.get(57);
+   * const cfg = await garu.products.portalConfig.get('b3f2c1e8-6e4a-4b9f-9d1c-2a1f6c3d4e5f');
    */
   async get(productId) {
     return this.http.call(
-      (signal) => this.http.client.GET(`/api/products/${productId}/portal-config`, {
+      (signal) => this.http.client.GET(`/api/products/${encodeURIComponent(String(productId))}/portal-config`, {
         signal
       }).then((r) => r)
     );
@@ -491,7 +491,7 @@ var ProductPortalConfigResource = class {
    * value. Use `clear` to reset everything.
    *
    * @example
-   * await garu.products.portalConfig.set(57, {
+   * await garu.products.portalConfig.set('b3f2c1e8-6e4a-4b9f-9d1c-2a1f6c3d4e5f', {
    *   businessName: 'Coach Maria — Corrida & Trilha',
    *   primaryColor: '#257264',
    *   logoUrl: 'https://cdn.atletia.com.br/coaches/maria.png'
@@ -499,7 +499,7 @@ var ProductPortalConfigResource = class {
    */
   async set(productId, params) {
     return this.http.call(
-      (signal) => this.http.client.POST(`/api/products/${productId}/portal-config`, {
+      (signal) => this.http.client.POST(`/api/products/${encodeURIComponent(String(productId))}/portal-config`, {
         body: params,
         signal
       }).then((r) => r)
@@ -508,7 +508,7 @@ var ProductPortalConfigResource = class {
   /** Same merge semantics as `set` — alias for HTTP-PATCH-prefering callers. */
   async patch(productId, params) {
     return this.http.call(
-      (signal) => this.http.client.PATCH(`/api/products/${productId}/portal-config`, {
+      (signal) => this.http.client.PATCH(`/api/products/${encodeURIComponent(String(productId))}/portal-config`, {
         body: params,
         signal
       }).then((r) => r)
@@ -520,11 +520,11 @@ var ProductPortalConfigResource = class {
    * deleted, `{ removed: false }` when there was nothing to remove.
    *
    * @example
-   * await garu.products.portalConfig.clear(57);
+   * await garu.products.portalConfig.clear('b3f2c1e8-6e4a-4b9f-9d1c-2a1f6c3d4e5f');
    */
   async clear(productId) {
     return this.http.call(
-      (signal) => this.http.client.DELETE(`/api/products/${productId}/portal-config`, {
+      (signal) => this.http.client.DELETE(`/api/products/${encodeURIComponent(String(productId))}/portal-config`, {
         signal
       }).then((r) => r)
     );

package/dist/index.d.cts

@@ -776,9 +776,13 @@ declare class Meta {
 }
 
 /**
- * Per-product portal customization (Garu v0.8.0). Used by B2B2C platforms
- * that model their professionals/coaches as Products under a single seller
- * and want per-product branding on the customer payment + portal pages.
+ * Per-product portal customization. Used by B2B2C platforms that model
+ * their professionals/coaches as Products under a single seller and want
+ * per-product branding on the customer payment + portal pages.
+ *
+ * `productId` accepts either the product UUID (preferred — same identifier
+ * returned by `garu.products.list()` and webhook payloads) or the legacy
+ * numeric id. UUID support added in Garu v0.10.0.
  */
 declare class ProductPortalConfigResource {
     private readonly http;
@@ -789,9 +793,9 @@ declare class ProductPortalConfigResource {
      * portal config).
      *
      * @example
-     * const cfg = await garu.products.portalConfig.get(57);
+     * const cfg = await garu.products.portalConfig.get('b3f2c1e8-6e4a-4b9f-9d1c-2a1f6c3d4e5f');
      */
-    get(productId: number): Promise<ProductPortalConfig | null>;
+    get(productId: string | number): Promise<ProductPortalConfig | null>;
     /**
      * Create or merge the portal customization (idempotent upsert). Both
      * `set` and `patch` have the same merge semantics — only fields present
@@ -799,24 +803,24 @@ declare class ProductPortalConfigResource {
      * value. Use `clear` to reset everything.
      *
      * @example
-     * await garu.products.portalConfig.set(57, {
+     * await garu.products.portalConfig.set('b3f2c1e8-6e4a-4b9f-9d1c-2a1f6c3d4e5f', {
      *   businessName: 'Coach Maria — Corrida & Trilha',
      *   primaryColor: '#257264',
      *   logoUrl: 'https://cdn.atletia.com.br/coaches/maria.png'
      * });
      */
-    set(productId: number, params: SetProductPortalConfigParams): Promise<ProductPortalConfig>;
+    set(productId: string | number, params: SetProductPortalConfigParams): Promise<ProductPortalConfig>;
     /** Same merge semantics as `set` — alias for HTTP-PATCH-prefering callers. */
-    patch(productId: number, params: SetProductPortalConfigParams): Promise<ProductPortalConfig>;
+    patch(productId: string | number, params: SetProductPortalConfigParams): Promise<ProductPortalConfig>;
     /**
      * Remove the per-product config. The product falls back to the
      * seller-level portal config. Returns `{ removed: true }` when a row was
      * deleted, `{ removed: false }` when there was nothing to remove.
      *
      * @example
-     * await garu.products.portalConfig.clear(57);
+     * await garu.products.portalConfig.clear('b3f2c1e8-6e4a-4b9f-9d1c-2a1f6c3d4e5f');
      */
-    clear(productId: number): Promise<{
+    clear(productId: string | number): Promise<{
         removed: boolean;
     }>;
 }

package/dist/index.d.ts

@@ -776,9 +776,13 @@ declare class Meta {
 }
 
 /**
- * Per-product portal customization (Garu v0.8.0). Used by B2B2C platforms
- * that model their professionals/coaches as Products under a single seller
- * and want per-product branding on the customer payment + portal pages.
+ * Per-product portal customization. Used by B2B2C platforms that model
+ * their professionals/coaches as Products under a single seller and want
+ * per-product branding on the customer payment + portal pages.
+ *
+ * `productId` accepts either the product UUID (preferred — same identifier
+ * returned by `garu.products.list()` and webhook payloads) or the legacy
+ * numeric id. UUID support added in Garu v0.10.0.
  */
 declare class ProductPortalConfigResource {
     private readonly http;
@@ -789,9 +793,9 @@ declare class ProductPortalConfigResource {
      * portal config).
      *
      * @example
-     * const cfg = await garu.products.portalConfig.get(57);
+     * const cfg = await garu.products.portalConfig.get('b3f2c1e8-6e4a-4b9f-9d1c-2a1f6c3d4e5f');
      */
-    get(productId: number): Promise<ProductPortalConfig | null>;
+    get(productId: string | number): Promise<ProductPortalConfig | null>;
     /**
      * Create or merge the portal customization (idempotent upsert). Both
      * `set` and `patch` have the same merge semantics — only fields present
@@ -799,24 +803,24 @@ declare class ProductPortalConfigResource {
      * value. Use `clear` to reset everything.
      *
      * @example
-     * await garu.products.portalConfig.set(57, {
+     * await garu.products.portalConfig.set('b3f2c1e8-6e4a-4b9f-9d1c-2a1f6c3d4e5f', {
      *   businessName: 'Coach Maria — Corrida & Trilha',
      *   primaryColor: '#257264',
      *   logoUrl: 'https://cdn.atletia.com.br/coaches/maria.png'
      * });
      */
-    set(productId: number, params: SetProductPortalConfigParams): Promise<ProductPortalConfig>;
+    set(productId: string | number, params: SetProductPortalConfigParams): Promise<ProductPortalConfig>;
     /** Same merge semantics as `set` — alias for HTTP-PATCH-prefering callers. */
-    patch(productId: number, params: SetProductPortalConfigParams): Promise<ProductPortalConfig>;
+    patch(productId: string | number, params: SetProductPortalConfigParams): Promise<ProductPortalConfig>;
     /**
      * Remove the per-product config. The product falls back to the
      * seller-level portal config. Returns `{ removed: true }` when a row was
      * deleted, `{ removed: false }` when there was nothing to remove.
      *
      * @example
-     * await garu.products.portalConfig.clear(57);
+     * await garu.products.portalConfig.clear('b3f2c1e8-6e4a-4b9f-9d1c-2a1f6c3d4e5f');
      */
-    clear(productId: number): Promise<{
+    clear(productId: string | number): Promise<{
         removed: boolean;
     }>;
 }

package/dist/index.js

@@ -469,11 +469,11 @@ var ProductPortalConfigResource = class {
    * portal config).
    *
    * @example
-   * const cfg = await garu.products.portalConfig.get(57);
+   * const cfg = await garu.products.portalConfig.get('b3f2c1e8-6e4a-4b9f-9d1c-2a1f6c3d4e5f');
    */
   async get(productId) {
     return this.http.call(
-      (signal) => this.http.client.GET(`/api/products/${productId}/portal-config`, {
+      (signal) => this.http.client.GET(`/api/products/${encodeURIComponent(String(productId))}/portal-config`, {
         signal
       }).then((r) => r)
     );
@@ -485,7 +485,7 @@ var ProductPortalConfigResource = class {
    * value. Use `clear` to reset everything.
    *
    * @example
-   * await garu.products.portalConfig.set(57, {
+   * await garu.products.portalConfig.set('b3f2c1e8-6e4a-4b9f-9d1c-2a1f6c3d4e5f', {
    *   businessName: 'Coach Maria — Corrida & Trilha',
    *   primaryColor: '#257264',
    *   logoUrl: 'https://cdn.atletia.com.br/coaches/maria.png'
@@ -493,7 +493,7 @@ var ProductPortalConfigResource = class {
    */
   async set(productId, params) {
     return this.http.call(
-      (signal) => this.http.client.POST(`/api/products/${productId}/portal-config`, {
+      (signal) => this.http.client.POST(`/api/products/${encodeURIComponent(String(productId))}/portal-config`, {
         body: params,
         signal
       }).then((r) => r)
@@ -502,7 +502,7 @@ var ProductPortalConfigResource = class {
   /** Same merge semantics as `set` — alias for HTTP-PATCH-prefering callers. */
   async patch(productId, params) {
     return this.http.call(
-      (signal) => this.http.client.PATCH(`/api/products/${productId}/portal-config`, {
+      (signal) => this.http.client.PATCH(`/api/products/${encodeURIComponent(String(productId))}/portal-config`, {
         body: params,
         signal
       }).then((r) => r)
@@ -514,11 +514,11 @@ var ProductPortalConfigResource = class {
    * deleted, `{ removed: false }` when there was nothing to remove.
    *
    * @example
-   * await garu.products.portalConfig.clear(57);
+   * await garu.products.portalConfig.clear('b3f2c1e8-6e4a-4b9f-9d1c-2a1f6c3d4e5f');
    */
   async clear(productId) {
     return this.http.call(
-      (signal) => this.http.client.DELETE(`/api/products/${productId}/portal-config`, {
+      (signal) => this.http.client.DELETE(`/api/products/${encodeURIComponent(String(productId))}/portal-config`, {
         signal
       }).then((r) => r)
     );

package/package.json

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